dojox/charting/Element (version 1.10)

Summary

A base class that is used to build other elements of a chart, such as a series.

Usage

var foo = new Element(chart,kwArgs);
dojox/charting/Element
Parameter Type Description
chart dojox/charting/Chart

The chart that this element belongs to.

kwArgs undefined

See the dojox/charting/Element reference documentation for more information.

Property Summary

  • chartThe parent chart for this element.
  • 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
  • renderingOptions

Method Summary

Properties

chart

The parent chart for this element.

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
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
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.

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
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
}
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.

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