dojox/charting/axis2d/Invisible (version 1.10)

dojox/charting/axis2d/Base

Summary

A axis object used in dojox.charting. You can use that axis if you want the axis to be invisible. See dojox.charting.Chart.addAxis for details.

Usage

var foo = new Invisible(chart,kwArgs);
dojox/charting/axis2d/Invisible
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.
  • defaultParamsThe default parameters used to define any axis.
  • dirtyA flag indicating whether or not this element needs to be rendered.
  • groupThe visual GFX group representing this element.
  • htmlElementAny DOMNodes used as a part of this element (such as HTML-based labels).
  • htmlElements
  • optionalParamsAny optional parameters needed to define an axis.
  • renderingOptions

Method Summary

  • _plotFill(fill,dim,offsets)
  • _pseudoRadialFill(fill,center,radius,start,end)
  • _shapeFill(fill,bbox)
  • calculate(min,max,span) Perform all calculations needed to render this axis.
  • cleanGroup(creator) Clean any elements (HTML or GFX-based) out of our group, and create a new one.
  • clear() Clear out all calculated properties on this axis;
  • 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() A stub function to return any offsets needed for axis and series rendering.
  • 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.
  • purgeGroup() Clear any elements out of our group, and destroy the group.
  • render(dim,offsets) Stub function to render this axis.
  • setWindow(scale,offset) Set the drawing "window" for the axis.

Properties

chart

The parent chart for this element.

defaultParams

The default parameters used to define any axis.

dirty

A flag indicating whether or not this element needs to be rendered.

group

The visual GFX group representing this element.

htmlElement

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

htmlElements
optionalParams

Any optional parameters needed to define an axis.

renderingOptions

Methods

_plotFill(fill,dim,offsets)
Parameter Type Description
fill undefined
dim undefined
offsets undefined
Returns:undefined
_pseudoRadialFill(fill,center,radius,start,end)
Parameter Type Description
fill undefined
center undefined
radius undefined
start undefined
end undefined
Returns:undefined | object
_shapeFill(fill,bbox)
Parameter Type Description
fill undefined
bbox undefined
Returns:undefined
calculate(min,max,span)

Perform all calculations needed to render this axis.

Parameter Type Description
min Number

The smallest value represented on this axis.

max Number

The largest value represented on this axis.

span Number

The span in pixels over which axis calculations are made.

The reference to the axis for functional chaining.

cleanGroup(creator)

Clean any elements (HTML or GFX-based) out of our group, and create a new one.

Parameter Type Description
creator dojox/gfx/shape.Surface
Optional

An optional surface to work with.

Returns:dojox/charting/Element | function

A reference to this object for functional chaining.

clear()

Clear out all calculated properties on this axis;

The reference to the axis for functional chaining.

dependOnData()

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

Returns:boolean
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()
Returns:undefined
getOffsets()

A stub function to return any offsets needed for axis and series rendering.

Returns:Object | object

An object of the form { l, r, t, b }.

getScaler()

Get the pre-calculated scaler object.

Returns:undefined
getTextWidth(s,font)
Parameter Type Description
s undefined
font undefined
Returns:number
getTextWithLimitCharCount(s,font,wcLimit,truncated)

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)

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()

Get the pre-calculated ticks object.

Returns:undefined
getWindowOffset()

Get the current windowing offset for the axis.

Returns:number
getWindowScale()

Get the current windowing scale of the axis.

Returns:number
initialized()

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.

purgeGroup()

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)

Stub function to render this axis.

Parameter Type Description
dim undefined
offsets undefined
Returns:dojox/charting/axis2d/Base | function

A reference to the axis for functional chaining.

setWindow(scale,offset)

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.

The reference to the axis for functional chaining.

Error in the documentation? Can’t find what you are looking for? Let us know!