Class: CustomSeries

CustomSeries

Base abstract class for line, area, scatter plots

new CustomSeries

Properties:
Name Type 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=false] Boolean Draws lines between points in stairs mode instead of diagonals.
[invertedStairs=false] Boolean Draws lines between points in inverted stairs mode instead of diagonals.
Source:
  • ../../src/teechart.js, line 6620

Extends

Classes

Pointer

Members

legendText

Source:
  • ../../src/teechart.js, line 4865

Methods

associatedToAxis

Source:
  • ../../src/teechart.js, line 4516
Returns:
Returns if series is associated to axis, either horizontal or vertical.
Type
Boolean

clicked

Source:
  • ../../src/teechart.js, line 6893
Returns:
Returns the index of the series point that contains p Tee.Point parameter.
Type
Number

count

Source:
  • ../../src/teechart.js, line 4870
Returns:
Returns the number of series data values.
Type
Number

dataText

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"
Source:
  • ../../src/teechart.js, line 4821
Returns:
Returns the text string to show for a given series point index.
Type
String

doSort

Source:
  • ../../src/teechart.js, line 4913
Returns:
Returns an array of series data indices sorted according to sortBy parameter.
Type
Array

getFill

Source:
  • ../../src/teechart.js, line 4428
Returns:
Returns the color of index point in series, using series palette or chart palette.
Type
String

getFillStyle

Source:
  • ../../src/teechart.js, line 4444
Returns:
Returns a canvas gradient using color, or color if gradient is not visible.
Type
CanvasGradient

isNull

Source:
  • ../../src/teechart.js, line 4439
Returns:
Returns true when the index'th series value is null and should not be painted.
Type
boolean

legendColor

Source:
  • ../../src/teechart.js, line 4880
Returns:
Returns the color of index'th legend symbol.
Type
Color

legendCount

Source:
  • ../../src/teechart.js, line 4875
Returns:
Returns the number of items to show at legend.
Type
Number

markText

Source:
  • ../../src/teechart.js, line 4508
Returns:
Returns the text string to show at series marks, for a given series point index.
Type
String

maxXValue

Source:
  • ../../src/teechart.js, line 4745
Returns:
Returns the maximum value of series x values, or data length minus one, if no x values exist.
Type
Number

maxYValue

Source:
  • ../../src/teechart.js, line 4757
Returns:
Returns the maximum value of series values, or zero if no values exist.
Type
Number

minXValue

Source:
  • ../../src/teechart.js, line 4730
Returns:
Returns the minimum value of series x values, or zero if no x values exist.
Type
Number

minYValue

Source:
  • ../../src/teechart.js, line 4737
Returns:
Returns the minimum value of series data values, or zero if no values exist.
Type
Number

pointOrigin

Source:
  • ../../src/teechart.js, line 4555
Returns:
Returns the sum of all previous visible series index'th value, for stacking.
Type
Number

stackMaxValue

Source:
  • ../../src/teechart.js, line 4791
Returns:
Returns the maximum of all series values, or sum of all stacked values.
Type
Number

toPercent

Source:
  • ../../src/teechart.js, line 4500
Returns:
Returns a percentual representation of the series index'th value, on total of series values.
Type
String

valueOrLabel

Source:
  • ../../src/teechart.js, line 4488
Returns:
Returns the series index'th data label, or the value if no label exists at that index.
Type
String

valueText

Source:
  • ../../src/teechart.js, line 4650
Returns:
Returns the text string for a given series point index value.
Type
String