Yahoo! UI Library

charts  3.3.0

Yahoo! UI Library > charts > Gridlines
Search:
 
Filters

Class Gridlines - extends Base - uses Renderer

Gridlines draws gridlines on a Graph.

Constructor

Gridlines ( )

Properties inherited from Plugin.Host:

Properties inherited from Attribute:

Properties inherited from Base:

Properties inherited from Renderer:

Methods

_drawGridlines

private void _drawGridlines ( )

_getDefaultStyles

protected _getDefaultStyles ( )
Gets the default value for the styles attribute. Overrides base implementation.
Returns:
Object

_horizontalLine

private void _horizontalLine ( )

_setCanvas

private void _setCanvas ( )
Creates a Graphic instance.

_verticalLine

private void _verticalLine ( )

draw

protected void draw ( )
Draws the gridlines

remove

private void remove ( )

render

private void render ( )

Events

axisChange

axisChange ( event )
Fires when the value for the configuration attribute 'axis' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

directionChange

directionChange ( event )
Fires when the value for the configuration attribute 'direction' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

graphChange

graphChange ( event )
Fires when the value for the configuration attribute 'graph' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

Events inherited from Base:

Events inherited from Renderer:

Configuration Attributes

axis - Axis

Indicate the Axis in which to bind the gridlines.

direction - String

Indicates the direction of the gridline.

graph - Graph

Indicates the Graph in which the gridlines are drawn.

Configuration attributes inherited from Base:

Configuration attributes inherited from Renderer:


Copyright © 2011 Yahoo! Inc. All rights reserved.