class anychart.core.cartesian.series.WidthBased Improve this Doc
Extends: anychart.core.cartesian.series.BaseWithMarkers
A base for all width-based series like bars, columns, OHLC and candlesticks.
Methods Overview
| Specific settings | |
| a11y() | Accessibility settings. |
| clip() | Series clip settings. |
| getPixelPointWidth() | Gets point width in case of width-based series. |
| id() | Series id. |
| legendItem() | Legend item settings. |
| maxPointWidth() | Maximum point width settings. |
| minPointLength() | Minimum point length settings. |
| pointWidth() | Point width settings. |
| selectionMode() | Selection mode. |
| transformX() | Transforms X value to pixel coordinates. |
| transformY() | Transforms Y value to pixel coordinates. |
| xPointPosition() | Position of the point. |
| Coloring | |
| color() | Color settings. |
| Data | |
| data() | Data settings. |
| excludePoint() | Excludes points at the specified index. |
| getExcludedPoints() | Returns an array of excluded points. |
| includeAllPoints() | Includes all excluded points. |
| includePoint() | Includes excluded points with the specified indexes. |
| keepOnlyPoints() | Keep only the specified points. |
| meta() | Series meta data settings. |
| name() | Series name settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| hover() | Hover settings. |
| hovered() | Hovered state settings. |
| normal() | Normal state settings. |
| select() | Select settings. |
| selected() | Selected state settings. |
| tooltip() | Tooltip settings. |
| unhover() | Removes hover from the series. |
| unselect() | Deselects all selected points. |
| Point Elements | |
| error() | Error settings. |
| getPoint() | Gets wrapped point by index. |
| labels() | Labels settings. |
| markers() | Markers settings. |
| maxLabels() | Maximum labels settings. |
| minLabels() | Minimum labels settings. |
| Scales | |
| xScale() | X-scale settings. |
| yScale() | Y-scale settings. |
| Size and Position | |
| bottom() | Bottom bound settings. |
| bounds() | Bounds settings. |
| getPixelBounds() | Returns pixel bounds. |
| height() | Height settings. |
| left() | Left bound settings. |
| maxHeight() | Maximum height. |
| maxWidth() | Maximum width. |
| minHeight() | Minimum height. |
| minWidth() | Minimum width. |
| right() | Right bound settings. |
| top() | Top bound settings. |
| width() | Width settings. |
| zIndex() | Z-index of the element. |
Methods Description
a11y
Getter for the accessibility setting.
Returns:
anychart.core.utils.SeriesA11y - Accessibility settings object. See listing.
var series = chart.line([3, 5, 2, 14, 3]); var a11y = series.a11y();
Setter for the accessibility setting.
Detailed description
If you want to work with accessibility then you only need to turn accessibility on using anychart.core.SeriesBase#a11y method.
Sets accessibility setting depending on parameter type:
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Whether to enable accessibility. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.bottom
Getter for element bottom bound settings.
Returns:
number | string | undefined - Element's bottom bound setting.Setter for element bottom bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
bounds
Getter for element bounds settings.
Returns:
anychart.core.utils.Bounds - Bounds of the element.Setter for bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Setter for element bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
clip
Setter for series clip settings.
Detailed description
Clips visible part of a series by a rectangle (or chart).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | anychart.math.Rect | False, if series is created manually. | Enable/disable series clip. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
color
Setter for the series color.
Detailed description
Note: color methods sets fill and stroke settings, which means it is not wise to pass
image fill here - stroke doesn't accept image fill.
Learn more about coloring.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
data
Setter for series mapping.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data to set. |
| csvSettings | anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings | If CSV string is passed by first param, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
error
Setter for the series error.
Detailed description
Sets series error settings depending on parameter type:
- null - disable series error.
- boolean - enable mode both or none for series error.
- string - sets value for series error.
- object - sets series error settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | null | boolean | string | number | false | Error settings. An error value can be set as absolute numbers or as a percentage. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.excludePoint
Excludes points at the specified index.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns true if the points were excluded.Try it:
getExcludedPoints
Returns an array of excluded points.
Returns:
Array.<anychart.core.Point> - Array of the points.Try it:
getPixelBounds
Returns pixel bounds of the element due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the element.getPixelPointWidth
Gets point width in case of width-based series.
Note: Works only after anychart.charts.Cartesian#draw is called.
Returns:
number - Point width.Try it:
getPoint
Gets wrapped point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.SeriesPoint - Wrapped point.Try it:
height
Getter for element height settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
hover
Hovers points.
Detailed description
If index is passed, hovers a point of the series by its index, else hovers all points of the series.
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Hovers point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Hovers points by indexes.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | Array.<number> | Array of indexes. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
id
Setter for the series id.
Detailed description
If you will set series id that is equal to an existing index, all changes will be set
for the first series with this index.
Params:
| Name | Type | Description |
|---|---|---|
| id | string | number | Id of the series. Default id is equal to internal index. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
includeAllPoints
Includes all excluded points.
Returns:
boolean - Returns true if all points were included.Try it:
includePoint
Includes excluded points with the specified indexes.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns true if the points were included.Try it:
keepOnlyPoints
Keep only the specified points.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Point index or indexes. |
Try it:
labels
Setter for series data labels.
Detailed description
Sets series labels settings depending on parameter type:
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.left
Getter for element left bound settings.
Returns:
number | string | undefined - Element's left bound setting.Setter for element left bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
legendItem
Getter for legend item settings for series.
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Setter for legend item settings for series.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Legend item settings object. |
Returns:
anychart.core.cartesian.series.WidthBased - Legend item settings or self for chaining.Try it:
markers
Setter for series data markers.
Detailed description
Sets series markers settings depending on parameter type:
- null/boolean - disable or enable series markers.
- object - sets series markers settings.
- string - sets series markers type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | string | false | Series data markers settings. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.maxHeight
Getter for the maximum height.
Returns:
number | string | null - Element's maximum height.Setter for the maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
maxLabels
Setter for maximum labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable maximum labels.
- object - sets maximum labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Maximum labels settings. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.maxPointWidth
Getter for the maximum point width.
Returns:
string | number - The maximum point width pixel value. See listing
var maxPointWidth = series.maxPointWidth();
Setter for the maximum point width.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | string | Point width pixel value. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
meta
Getter for series meta data.
Params:
| Name | Type | Description |
|---|---|---|
| key | * | Metadata key. |
Returns:
* - Metadata object, key value or itself for method chaining.Try it:
Setter for series meta data using object.
Params:
| Name | Type | Description |
|---|---|---|
| object | * | Object to replace metadata. |
| value | * | Meta data value. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Setter for series meta data using key.
Params:
| Name | Type | Description |
|---|---|---|
| key | * | Metadata key. |
| value | * | Meta data value. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum height.Setter for the minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Minimum height to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
minLabels
Setter for minimum labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable minimum labels.
- object - sets minimum labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Minimum labels settings. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.minPointLength
Getter for the minimum point length.
Returns:
string | number - The minimum point length pixel value. See listing
var minPointLength = series.minPointLength();
Setter for the minimum point length.
Params:
| Name | Type | Description |
|---|---|---|
| length | number | string | Minimum point length pixel value. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum width.Setter for the minimum width.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Minimum width to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
name
Getter for the series name.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string | undefined - Series name value.Try it:
Setter for the series name.
Detailed description
Basically, name of series is used in Legend displaying, but it can be used in tooltips.
Params:
| Name | Type | Description |
|---|---|---|
| name | string | Series name to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
pointWidth
Getter for the point width settings.
Returns:
string | number - The point width pixel value.Try it:
Setter for the point width settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | '90%' | Point width pixel value. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.Setter for element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
select
Selects point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the point to select. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Selects point by indexes.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Array of indexes of the point to select. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
selectionMode
Gets the state of the series for selection mode.
Returns:
anychart.enums.SelectionMode | string | null - Selection mode.Try it:
Allows to select points of the series.
To select multiple points, press 'ctrl' and click on them.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.SelectionMode | string | null | 'multiSelect' | Selection mode. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
tooltip
Setter for the series data tooltip.
Detailed description
Sets series tooltip settings depending on parameter type:
- null/boolean - disable or enable chart tooltip.
- object - sets chart tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Tooltip settings. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.top
Getter for element top bound settings.
Returns:
number | string | undefined - Element's top bound setting.Setter for element top bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
transformX
Transforms X value to pixel coordinates.
Note: Works only after anychart.charts.Cartesian#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| value | * | X value. |
| subRangeRatio | number | Range ratio value. |
Returns:
number - Pixel value.Try it:
transformY
Transforms Y value to pixel coordinates.
Note: Works only after anychart.charts.Cartesian#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| value | * | Y value. |
| subRangeRatio | number | Range ratio value. |
Returns:
number - Pixel value.Try it:
unhover
Removes hover from the series.
Params:
| Name | Type | Description |
|---|---|---|
| indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
unselect
Deselects all selected points.
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Deselects selected point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the point to select. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
Deselects selected points by indexes.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | Array.<number> | An array of indexes of the point to select. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
width
Getter for element width settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.cartesian.series.WidthBased - Returns self for method chaining.Try it:
xPointPosition
Getter for the position of the point on an ordinal scale.
Returns:
number - X-point position.Try it:
Setter for the position of the point on an ordinal scale.
Detailed description
For bars, columns and OHLC series it's autocalculated if chart contains more than one series.
On an ordinal scale, the position where point is can be set manually. If there are more than one series, positions is calculated to fit all.
On an ordinal scale, the position where point is can be set manually. If there are more than one series, positions is calculated to fit all.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| position | number | 0.5 | Point position (in 0 to 1 range). |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
xScale
Setter for the series X scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Ordinal | Scale settings to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
yScale
Setter for the series Y scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.cartesian.series.WidthBased - Self instance for method chaining.Try it: