dojox/charting/plot2d/Base (version 1.10)

dojox/charting/Element

Summary

Base class for all plot types.

Usage

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

The chart this plot belongs to.
kwArgs Object
Optional

An optional arguments object to help define the plot.

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

  • _getLabel(number)
  • _plotFill(fill,dim,offsets)
  • _pseudoRadialFill(fill,center,radius,start,end)
  • _shapeFill(fill,bbox)
  • addSeries(run) Add a data series to this plot.
  • assignAxes(axes) From an array of axes pick the ones that correspond to this plot and assign them to the plot using setAxis method.
  • calculateAxes(dim) Stub function for running the axis calculations (deprecated).
  • cleanGroup(creator) Clean any elements (HTML or GFX-based) out of our group, and create a new one.
  • clear() Clear out all of the information tied to this plot.
  • 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()
  • getRequiredColors() Get how many data series we have, so we know how many colors to use.
  • getSeriesStats() Calculate the min/max on all attached series in both directions.
  • 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)
  • initializeScalers() Does nothing.
  • isDataDirty() Returns whether or not any of this plot's data series need to be rendered.
  • purgeGroup() Clear any elements out of our group, and destroy the group.
  • render(dim,offsets) Render the plot on the chart.
  • renderLabel(group,x,y,label,theme,block,align)
  • setAxis(axis) Set an axis for this plot.

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

_getLabel(number)
Defined by dojox/charting/plot2d/Base
Parameter Type Description
number undefined
Returns:undefined
_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
addSeries(run)
Defined by dojox/charting/plot2d/Base

Add a data series to this plot.

Parameter Type Description
run dojox/charting/Series

The series to be added.
Returns:dojox/charting/plot2d/Base | function

A reference to this plot for functional chaining.

assignAxes(axes)
Defined by dojox/charting/plot2d/Base

From an array of axes pick the ones that correspond to this plot and assign them to the plot using setAxis method.

Parameter Type Description
axes Array

An array of dojox/charting/axis2d/Base
calculateAxes(dim)
Defined by dojox/charting/plot2d/Base

Stub function for running the axis calculations (deprecated).

Parameter Type Description
dim Object

An object of the form { width, height }
Returns:dojox/charting/plot2d/Base | function

A reference to this plot for functional chaining.

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/plot2d/Base

Clear out all of the information tied to this plot.

Returns:dojox.charting.plot2d.Base | function

A reference to this plot for functional chaining.

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
getRequiredColors()
Defined by dojox/charting/plot2d/Base

Get how many data series we have, so we know how many colors to use.

Returns:Number | undefined

The number of colors needed.

getSeriesStats()
Defined by dojox/charting/plot2d/Base

Calculate the min/max on all attached series in both directions.

Returns:Object | undefined

{hmin, hmax, vmin, vmax} min/max in both directions.

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
}
initializeScalers()
Defined by dojox/charting/plot2d/Base

Does nothing.

Returns:function

Does nothing.

isDataDirty()
Defined by dojox/charting/plot2d/Base

Returns whether or not any of this plot's data series need to be rendered.

Returns:Boolean | undefined

Flag indicating if any of this plot's series are invalid and need rendering.

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/plot2d/Base

Render the plot on the chart.

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/plot2d/Base | function

A reference to this plot for functional chaining.

renderLabel(group,x,y,label,theme,block,align)
Defined by dojox/charting/plot2d/Base
Parameter Type Description
group undefined
x undefined
y undefined
label undefined
theme undefined
block undefined
align undefined
Returns:undefined
setAxis(axis)
Defined by dojox/charting/plot2d/Base

Set an axis for this plot.

Parameter Type Description
axis dojox/charting/axis2d/Base

The axis to set.
Returns:dojox/charting/plot2d/Base | function

A reference to this plot for functional chaining.

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