Class: CustomSeries

CustomSeries

Base abstract class for line, area, scatter plots

Constructor

new CustomSeries()

Properties:
Name Type Attributes Default Description
pointer Tee.CustomSeries-Pointer Paints a visual representation at each point position.
stacked String Defines if multiple series are displayed one on top of each other.
smooth Number Draws lines between points as diagonals (value 0) or smooth curves (value > 0 < 1).
stairs Boolean <optional>
false Draws lines between points in stairs mode instead of diagonals.
invertedStairs Boolean <optional>
false Draws lines between points in inverted stairs mode instead of diagonals.
Source:

Extends

Classes

Pointer

Members

legendText

Inherited From:
Source:

Methods

associatedToAxis() → {Boolean}

Inherited From:
Source:
Returns:
Returns if series is associated to axis, either horizontal or vertical.
Type
Boolean

clicked() → {Number}

Source:
Returns:
Returns the index of the series point that contains p Tee.Point parameter.
Type
Number

count() → {Number}

Inherited From:
Source:
Returns:
Returns the number of series data values.
Type
Number

dataText(index, style) → {String}

Parameters:
Name Type Description
index Number The point position in series data array.
style String Defines how text is returned: "auto", "value", "percent", "percentlabel", "valuelabel", "label", "index", "labelvalue", "labelpercent"
Inherited From:
Source:
Returns:
Returns the text string to show for a given series point index.
Type
String

doSort() → {Array}

Inherited From:
Source:
Returns:
Returns an array of series data indices sorted according to sortBy parameter.
Type
Array

getFill() → {String}

Inherited From:
Source:
Returns:
Returns the color of index point in series, using series palette or chart palette.
Type
String

getFillStyle() → {CanvasGradient}

Inherited From:
Source:
Returns:
Returns a canvas gradient using color, or color if gradient is not visible.
Type
CanvasGradient

isNull() → {boolean}

Inherited From:
Source:
Returns:
Returns true when the index'th series value is null and should not be painted.
Type
boolean

legendColor() → {Color}

Inherited From:
Source:
Returns:
Returns the color of index'th legend symbol.
Type
Color

legendCount() → {Number}

Inherited From:
Source:
Returns:
Returns the number of items to show at legend.
Type
Number

markText() → {String}

Inherited From:
Source:
Returns:
Returns the text string to show at series marks, for a given series point index.
Type
String

maxXValue() → {Number}

Inherited From:
Source:
Returns:
Returns the maximum value of series x values, or data length minus one, if no x values exist.
Type
Number

maxYValue() → {Number}

Overrides:
Source:
Returns:
Returns the maximum value of series values, or zero if no values exist.
Type
Number

minXValue() → {Number}

Inherited From:
Source:
Returns:
Returns the minimum value of series x values, or zero if no x values exist.
Type
Number

minYValue() → {Number}

Inherited From:
Source:
Returns:
Returns the minimum value of series data values, or zero if no values exist.
Type
Number

pointOrigin() → {Number}

Inherited From:
Source:
Returns:
Returns the sum of all previous visible series index'th value, for stacking.
Type
Number

stackMaxValue() → {Number}

Inherited From:
Source:
Returns:
Returns the maximum of all series values, or sum of all stacked values.
Type
Number

toPercent() → {String}

Inherited From:
Source:
Returns:
Returns a percentual representation of the series index'th value, on total of series values.
Type
String

valueOrLabel() → {String}

Inherited From:
Source:
Returns:
Returns the series index'th data label, or the value if no label exists at that index.
Type
String

valueText() → {String}

Inherited From:
Source:
Returns:
Returns the text string for a given series point index value.
Type
String