dojox/charting/action2d/_IndicatorElement (version 1.10)

dojox/charting/plot2d/Indicator

Summary

Internal element used by indicator actions.

Usage

var foo = new _IndicatorElement(chart,kwArgs);
dojox/charting/action2d/_IndicatorElement
Parameter Type Description
chart undefined
kwArgs undefined

Property Summary

Method Summary

Properties

baseParams
Defined by: dojox/charting/plot2d/CartesianBase
chart
Defined by: dojox/charting/Element

The parent chart for this element.

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

Methods

_animateIndicator(shape,vertical,offset,size,animate)
Defined by dojox/charting/plot2d/Indicator
Parameter Type Description
shape undefined
vertical undefined
offset undefined
size undefined
animate undefined
_connectEvents(o)
Defined by dojox/charting/plot2d/_PlotEvents
Parameter Type Description
o undefined
_connectSingleEvent(o,eventName)
Defined by dojox/charting/plot2d/_PlotEvents
Parameter Type Description
o undefined
eventName undefined
_getLabel(number)
Defined by dojox/charting/plot2d/Base
Parameter Type Description
number undefined
Returns:undefined
_initTrack()
Defined by dojox/charting/action2d/_IndicatorElement
_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
_reconnectEvents(seriesName)
Defined by dojox/charting/plot2d/_PlotEvents
Parameter Type Description
seriesName undefined
_renderIndicator(coord,index,hn,vn,min,max,events,animate)
Defined by dojox/charting/plot2d/Indicator
Parameter Type Description
coord undefined
index undefined
hn undefined
vn undefined
min undefined
max undefined
events undefined
animate undefined
Returns:object
_renderText(g,text,t,x,y,index,values,data)
Defined by dojox/charting/action2d/_IndicatorElement
Parameter Type Description
g undefined
text undefined
t undefined
x undefined
y undefined
index undefined
values undefined
data undefined
_shapeFill(fill,bbox)
Defined by dojox/charting/Element
Parameter Type Description
fill undefined
bbox undefined
Returns:undefined
_snapData(cd,attr,v)
Defined by dojox/charting/action2d/_IndicatorElement
Parameter Type Description
cd undefined
attr undefined
v undefined
Returns:object
_trackMove()
Defined by dojox/charting/action2d/_IndicatorElement
_updateCoordinates(cp1,cp2)
Defined by dojox/charting/action2d/_IndicatorElement
Parameter Type Description
cp1 undefined
cp2 undefined
Returns:Array
_updateIndicator()
Defined by dojox/charting/action2d/_IndicatorElement
_updateVisibility(cp,limit,attr)
Defined by dojox/charting/action2d/_IndicatorElement
Parameter Type Description
cp undefined
limit undefined
attr undefined
addSeries(run)
Defined by dojox/charting/plot2d/Indicator
Parameter Type Description
run undefined
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/action2d/_IndicatorElement

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

Parameter Type Description
creator dojox/gfx/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/Indicator
connect(object,method)
Defined by dojox/charting/plot2d/_PlotEvents

Helper function to connect any object's method to our plotEvent.

Parameter Type Description
object Object

The object to connect to.
method String | Function

The method to fire when our plotEvent is fired.
Returns:Array | undefined

The handle as returned from dojo.connect (see dojo.connect).

createLabel(group,value,bbox,theme)
Defined by dojox/charting/plot2d/CartesianBase
Parameter Type Description
group undefined
value undefined
bbox undefined
theme undefined
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.

events()
Defined by dojox/charting/plot2d/_PlotEvents

Find out if any event handlers have been connected to our plotEvent.

Returns:Boolean | boolean

A flag indicating that there are handlers attached.

fireEvent(seriesName,eventName,index,eventObject)
Defined by dojox/charting/plot2d/_PlotEvents

Emulates firing an event for a given data value (specified by an index) of a given series.

Parameter Type Description
seriesName String

Series name.
eventName String

Event name to emulate.
index Number

Valid data value index used to raise an event.
eventObject Object
Optional

Optional event object. Especially useful for synthetic events. Default: null.
getGroup()
Defined by dojox/charting/plot2d/CartesianBase
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/Indicator

Returns default stats (irrelevant for this type of plot).

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(dim,stats)
Defined by dojox/charting/plot2d/CartesianBase

Initializes scalers using attached axes.

Parameter Type Description
dim Object

Size of a plot area in pixels as {width, height}.
stats Object

Min/max of data in both directions as {hmin, hmax, vmin, vmax}.
Returns:dojox/charting/plot2d/CartesianBase | function

A reference to this plot for functional chaining.

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.

isDirty()
Defined by dojox/charting/action2d/_IndicatorElement

Return whether or not this plot needs to be redrawn.

Returns:Boolean | undefined

If this plot needs to be rendered, this will return true.

performZoom(dim,offsets)
Defined by dojox/charting/plot2d/CartesianBase

Create/alter any zooming windows on this plot.

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/CartesianBase | function

A reference to this plot for functional chaining.

plotEvent(o)
Defined by dojox/charting/plot2d/_PlotEvents

Stub function for use by specific plots.

Parameter Type Description
o Object

An object intended to represent event parameters.
purgeGroup()
Defined by dojox/charting/plot2d/CartesianBase
raiseEvent(o)
Defined by dojox/charting/plot2d/_PlotEvents

Raises events in predefined order

Parameter Type Description
o Object

An object intended to represent event parameters.
render()
Defined by dojox/charting/action2d/_IndicatorElement
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
resetEvents()
Defined by dojox/charting/plot2d/_PlotEvents

Reset all events attached to our plotEvent (i.e. disconnect).

setAxis(axis)
Defined by dojox/charting/plot2d/CartesianBase

Set an axis for this plot.

Parameter Type Description
axis dojox/charting/axis2d/Base

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

A reference to this plot for functional chaining.

stopTrack()
Defined by dojox/charting/action2d/_IndicatorElement
toData(coord)
Defined by dojox/charting/plot2d/CartesianBase

Compute plot axis data coordinates from page coordinates.

Parameter Type Description
coord Object

The pixel coordinate in page coordinate space. That is of the following form: { x: 50, y: 200 } If not provided return the tranform method instead of the result of the transformation.
Returns:Object | function

The resulting plot axis data coordinates. For cartesian charts that is of the following form: { hAxisName: 50, vAxisName: 200 }

toPage(coord)
Defined by dojox/charting/plot2d/CartesianBase

Compute page coordinates from plot axis data coordinates.

Parameter Type Description
coord Object
Optional

The coordinates in plot axis data coordinate space. For cartesian charts that is of the following form: { hAxisName: 50, vAxisName: 200 } If not provided return the transform method instead of the result of the transformation.
Returns:Object | function

The resulting page pixel coordinates. That is of the following form: { x: 50, y: 200 }

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