Parameter	Type	Description
chart	dojox/charting/Chart	The chart the axis belongs to.
kwArgs	Object	Optional Any optional keyword arguments to be used to define this axis.

Property Summary

chartThe parent chart for this element.
defaultParams
dirty
groupThe visual GFX group representing this element.
htmlElementAny DOMNodes used as a part of this element (such as HTML-based labels).
htmlElements
offset
optThe actual options used to define this axis, created at initialization.
optionalParams
renderingOptions
scale
scaler
ticks

Method Summary

_getMaxLabelSize(min,max,span,rotation,font,size)
_groupLabelWidth(labels,font,wcLimit)
_isRtl()
_plotFill(fill,dim,offsets)
_pseudoRadialFill(fill,center,radius,start,end)
_shapeFill(fill,bbox)
calculate(min,max,span)
cleanGroup(creator)
clear() Clear out all calculated properties on this axis;
createLine(creator,params)
createText(labelType,creator,x,y,align,textContent,font,fontColor,labelWidth)
dependOnData() Find out whether or not the axis options depend on the data in the axis.
destroy() API addition to conform to the rest of the Dojo Toolkit's standard.
destroyHtmlElements() Destroy any DOMNodes that may have been created as a part of this element.
getGroup()
getOffsets() Get the physical offset values for this axis (used in drawing data series).
getScaler() Get the pre-calculated scaler object.
getTextWidth(s,font)
getTextWithLimitCharCount(s,font,wcLimit,truncated) Get the truncated string based on the limited character count(dichotomy algorithm)
getTextWithLimitLength(s,font,limitWidth,truncated) Get the truncated string based on the limited width in px(dichotomy algorithm)
getTicks() Get the pre-calculated ticks object.
getWindowOffset() Get the current windowing offset for the axis.
getWindowScale() Get the current windowing scale of the axis.
initialized() Finds out if this axis has been initialized or not.
labelTooltip(elem,chart,label,truncatedLabel,font,elemType)
purgeGroup() Clear any elements out of our group, and destroy the group.
render(dim,offsets) Render/draw the axis.
setWindow(scale,offset) Set the drawing "window" for the axis.

Properties

chart

Defined by: dojox/charting/Element

The parent chart for this element.

defaultParams

Defined by: dojox/charting/axis2d/Default

dirty

Defined by: dojox/charting/axis2d/Default

group

Defined by: dojox/charting/Element

The visual GFX group representing this element.

htmlElement

Defined by: dojox/charting/Element

Any DOMNodes used as a part of this element (such as HTML-based labels).

htmlElements

Defined by: dojox/charting/Element

offset

Defined by: dojox/charting/axis2d/Default

opt

Defined by: dojox/charting/axis2d/Default

The actual options used to define this axis, created at initialization.

optionalParams

Defined by: dojox/charting/axis2d/Default

renderingOptions

Defined by: dojox/charting/Element

scale

Defined by: dojox/charting/axis2d/Default

scaler

Defined by: dojox/charting/axis2d/Default

ticks

Defined by: dojox/charting/axis2d/Default

Methods

_getMaxLabelSize(min,max,span,rotation,font,size)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
min	undefined
max	undefined
span	undefined
rotation	undefined
font	undefined
size	undefined

Returns:null

_groupLabelWidth(labels,font,wcLimit)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
labels	undefined
font	undefined
wcLimit	undefined

Returns:number

_isRtl()

Defined by dojox/charting/axis2d/Default

Returns:boolean

_plotFill(fill,dim,offsets)

Defined by dojox/charting/Element

Parameter	Type	Description
fill	undefined
dim	undefined
offsets	undefined

Returns:undefined

_pseudoRadialFill(fill,center,radius,start,end)

Defined by dojox/charting/Element

Parameter	Type	Description
fill	undefined
center	undefined
radius	undefined
start	undefined
end	undefined

Returns:undefined | object

_shapeFill(fill,bbox)

Defined by dojox/charting/Element

Parameter	Type	Description
fill	undefined
bbox	undefined

Returns:undefined

calculate(min,max,span)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
min	undefined
max	undefined
span	undefined

Returns:function

cleanGroup(creator)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
creator	undefined

clear()

Defined by dojox/charting/axis2d/Invisible

Clear out all calculated properties on this axis;

Returns:dojox/charting/axis2d/Invisible | function

The reference to the axis for functional chaining.

createLine(creator,params)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
creator	undefined
params	undefined

Returns:undefined

createText(labelType,creator,x,y,align,textContent,font,fontColor,labelWidth)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
labelType	undefined
creator	undefined
x	undefined
y	undefined
align	undefined
textContent	undefined
font	undefined
fontColor	undefined
labelWidth	undefined

Returns:undefined

dependOnData()

Defined by dojox/charting/axis2d/Invisible

Find out whether or not the axis options depend on the data in the axis.

Returns:boolean

destroy()

Defined by dojox/charting/Element

API addition to conform to the rest of the Dojo Toolkit's standard.

destroyHtmlElements()

Defined by dojox/charting/Element

Destroy any DOMNodes that may have been created as a part of this element.

getGroup()

Defined by dojox/charting/Element

Returns:undefined

getOffsets()

Defined by dojox/charting/axis2d/Default

Get the physical offset values for this axis (used in drawing data series). This method is not supposed to be called by the users but internally.

Returns:Object | object

The calculated offsets in the form of { l, r, t, b } (left, right, top, bottom).

getScaler()

Defined by dojox/charting/axis2d/Invisible

Get the pre-calculated scaler object.

Returns:undefined

getTextWidth(s,font)

Defined by dojox/charting/Element

Parameter	Type	Description
s	undefined
font	undefined

Returns:number

getTextWithLimitCharCount(s,font,wcLimit,truncated)

Defined by dojox/charting/Element

Get the truncated string based on the limited character count(dichotomy algorithm)

Parameter	Type	Description
s	String	Optional candidate text.
font	String	Optional text's font style.
wcLimit	Number	Optional text limited character count.
truncated	Boolean	Optional whether the input text(s) has already been truncated.

Returns:Object | object

{
    text: processed text, maybe truncated or not,
    truncated: whether text has been truncated
}

getTextWithLimitLength(s,font,limitWidth,truncated)

Defined by dojox/charting/Element

Get the truncated string based on the limited width in px(dichotomy algorithm)

Parameter	Type	Description
s	String	Optional candidate text.
font	String	Optional text's font style.
limitWidth	Number	Optional text limited width in px.
truncated	Boolean	Optional whether the input text(s) has already been truncated.

Returns:Object | object

{
    text: processed text, maybe truncated or not,
    truncated: whether text has been truncated
}

getTicks()

Defined by dojox/charting/axis2d/Invisible

Get the pre-calculated ticks object.

Returns:undefined

getWindowOffset()

Defined by dojox/charting/axis2d/Invisible

Get the current windowing offset for the axis.

Returns:number

getWindowScale()

Defined by dojox/charting/axis2d/Invisible

Get the current windowing scale of the axis.

Returns:number

initialized()

Defined by dojox/charting/axis2d/Invisible

Finds out if this axis has been initialized or not.

Returns:Boolean | boolean

Whether a scaler has been calculated and if the axis is not dirty.

labelTooltip(elem,chart,label,truncatedLabel,font,elemType)

Defined by dojox/charting/axis2d/Default

Parameter	Type	Description
elem	undefined
chart	undefined
label	undefined
truncatedLabel	undefined
font	undefined
elemType	undefined

purgeGroup()

Defined by dojox/charting/Element

Clear any elements out of our group, and destroy the group.

Returns:dojox/charting/Element | function

A reference to this object for functional chaining.

render(dim,offsets)

Defined by dojox/charting/axis2d/Default

Render/draw the axis.

Parameter	Type	Description
dim	Object	An object of the form { width, height}.
offsets	Object	An object of the form { l, r, t, b }.

Returns:dojox/charting/axis2d/Default | function

The reference to the axis for functional chaining.

setWindow(scale,offset)

Defined by dojox/charting/axis2d/Default

Set the drawing "window" for the axis.

Parameter	Type	Description
scale	Number	The new scale for the axis.
offset	Number	The new offset for the axis.

Returns:dojox/charting/axis2d/Default | undefined

The reference to the axis for functional chaining.

dojox/charting/axis2d/Default (version 1.10)

Summary

Usage

Property Summary

Method Summary

Properties

Methods