dojox/charting/Series (version 1.10)

dojox/charting/Element

Summary

An object representing a series of data for plotting on a chart.

Usage

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

The chart that this series belongs to.
data Array | Object

The array of data points (either numbers or objects) that represents the data to be drawn. Or it can be an object. In the latter case, it should have a property "data" (an array), destroy(), and setSeriesObject().
kwArgs Object
Optional

An optional keyword arguments object to set details for this series.

See the dojox/charting/Series 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

  • _plotFill(fill,dim,offsets)
  • _pseudoRadialFill(fill,center,radius,start,end)
  • _shapeFill(fill,bbox)
  • cleanGroup(creator) Clean any elements (HTML or GFX-based) out of our group, and create a new one.
  • clear() Clear the calculated additional parameters set on this series.
  • 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()
  • 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)
  • purgeGroup() Clear any elements out of our group, and destroy the group.
  • update(data) Set data and make this object dirty, so it can be redrawn.

Properties

chart
Defined by: dojox/charting/Element

The parent chart for this element.

dirty
Defined by: dojox/charting/Element

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

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
renderingOptions
Defined by: dojox/charting/Element

Methods

_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
cleanGroup(creator)
Defined by dojox/charting/Element

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()
Defined by dojox/charting/Series

Clear the calculated additional parameters set on this series.

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

update(data)
Defined by dojox/charting/Series

Set data and make this object dirty, so it can be redrawn.

Parameter Type Description
data Array | Object

The array of data points (either numbers or objects) that represents the data to be drawn. Or it can be an object. In the latter case, it should have a property "data" (an array), destroy(), and setSeriesObject().
Error in the documentation? Can’t find what you are looking for? Let us know!