jsx3.chart.PointSeriesAPI


Object
Object TypeThe JSX foundation class that this object is an instance of.
IDThe unique, system-assigned ID for this object.
NameSets the name assigned by the developer to identify this object.
Series
Series NameSets the jsxname of the data series displayed in the legend.
X FieldSets the attribute of the data provider containing the x value.
Y FieldSets the attribute of the data provider containing the y value.
Point
RendererSets the renderer to use for rendering points in this series.
FillSets the vector fill for this series.
StrokeSets the vector stroke for this series.
Fill GradientSets the optional gradient settings for this series.
Component
DisplayUsed to hide this chart component without removing it from the DOM hierarchy.
Interaction
Tooltip FunctionA static function determines what is displayed in the tooltip when the user moves the mouse over a data point, with signature function(series, datum) : String.
Bound MenuSets the jsxname property for the context menu instance to display on a right-click.

Object Type

Read-Only. The JSX foundation class that this object is an instance of.

ID

Read-Only. The unique, system-assigned ID for this object.
Getter: getId()

Name

Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname

Series Name

Sets the jsxname of the data series displayed in the legend.
Getter: getSeriesName()
Setter: setSeriesName()
Property: seriesName

X Field

Sets the attribute of the data provider containing the x value.
Getter: getXField()
Setter: setXField()
Property: xField

Y Field

Sets the attribute of the data provider containing the y value.
Getter: getYField()
Setter: setYField()
Property: yField

Renderer

Sets the renderer to use for rendering points in this series. Built-in renderers are fields in jsx3.chart.PointRenderer. If empty, points aren't rendered.
Getter: getRenderer()
Setter: setRenderer()
Property: renderer

Fill

Sets the vector fill for this series. Specified as color alpha. For example, black 1.
Default Value: Default color scheme
Getter: getFill()
Setter: setFill()
Property: fill

Stroke

Sets the vector stroke for this series. Specified as color width alpha. For example, black 1 1.
Default Value: Empty
Getter: getStroke()
Setter: setStroke()
Property: stroke

Fill Gradient

Sets the optional gradient settings for this series. Specified as color2 [angle [alpha2 [percent stop_color,]*]]. The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. The angle is measured in degrees counter-clockwise from 12 o'clock. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black.
Default Value: Empty
Getter: getFillGradient()
Setter: setFillGradient()
Property: fillGradient

Display

Used to hide this chart component without removing it from the DOM hierarchy.
Default Value: Block (jsx3.gui.Block.DISPLAYBLOCK)
Getter: getDisplay()
Setter: setDisplay()
Property: jsxdisplay
Allowed Values:

Tooltip Function

A static function determines what is displayed in the tooltip when the user moves the mouse over a data point, with signature function(series, datum) : String. If null, toolitp isn't rendered.
Getter: getTooltipFunction()
Setter: setTooltipFunction()
Property: tooltipFunction

Bound Menu

Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu