Constructor
new CustomBar()
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
sideMargins |
Number |
<optional> |
100 | Defines the percent of bar size to use as spacing between axes. |
useOrigin |
Boolean |
<optional> |
true | Determines if {Tee.CustomBar#origin} value is used as bar minimum. |
origin |
Number |
<optional> |
0 | Defines the value to use as bar minimum. |
barSize |
Number |
<optional> |
70 | Defines the percent size of bars on available space. |
offset |
Number |
<optional> |
0 | Defines the percent bar size to offset each bar. |
barStyle |
String |
<optional> |
"bar" | Which shape to draw ("bar", "ellipse", "line"). |
stacked |
Boolean |
<optional> |
"no" | Use "no", "yes", "100", "sideAll", "self", "side" to define stack behaviour with other BarSeries. |
- Source:
Extends
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 series bar that contains Tee.Point p parameter.
- Type
- Number
count() → {Number}
- Inherited From:
- Source:
Returns:
Returns the number of series data values.
- Type
- Number
countAll() → {Number}
- Source:
Returns:
Returns the number of visible Tee.CustomBar series that are displayed before this series.
- 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}
- Inherited From:
- 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