class anychart.core.radar.series.Area Improve this Doc
Extends: anychart.core.radar.series.ContinuousBase
Define Area series type.
Note: Better for use anychart.charts.Radar#area method.
Methods Overview
| Specific settings | |
| a11y() | Accessibility settings. |
| connectMissingPoints() | Connect missing points setting. |
| id() | Series id. |
| legendItem() | Legend item settings. |
| selectionMode() | Selection mode. |
| transformXY() | Transforms values to pixel coordinates. |
| Coloring | |
| color() | Color settings. |
| colorScale() | Color scale settings. |
| fill() | Fill settings. |
| hatchFill() | Hatch fill settings. |
| stroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| excludePoint() | Excludes points at the specified index. |
| getExcludedPoints() | Returns an array of excluded points. |
| getStat() | Gets the statistics value by key. |
| includeAllPoints() | Includes all excluded points. |
| includePoint() | Includes excluded points with the specified indexes. |
| keepOnlyPoints() | Keep only the specified points. |
| meta() | Meta data settings. |
| name() | Series name settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| hover() | Hovers points or series. |
| hovered() | Hovered state settings. |
| normal() | Normal state settings. |
| select() | Select settings. |
| selected() | Selected state settings. |
| tooltip() | Tooltip settings. |
| unhover() | Removes hover from the series point or series. |
| unselect() | Deselects all selected points. |
| Point Elements | |
| 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.Try it:
color
Setter for the series color.
Learn more about coloring.
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.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
colorScale
Getter for the color scale.
See listing
var series = chart.line(); var colorScale = series.colorScale();
Setter for the color scale.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.scales.LinearColor | anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | string | Scale to set. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
connectMissingPoints
Getter for connectMissingPoints mode.
Returns:
boolean - ConnectMissingPoints mode.Try it:
Setter for connectMissingPoints mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | If set to true, the series will not be interrupted on missing points. Markers will not be drawn for missing points in both cases. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
data
Setter for the 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
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.fill
Getter for the series fill color.
Returns:
anychart.graphics.vector.Fill - Fill color.Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Setter for fill settings using function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function():anychart.graphics.vector.Fill | function() {
return anychart.color.darken(this.sourceColor);
} | Function that looks like: function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
} |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
getExcludedPoints
Returns an array of excluded points.
Returns:
Array.<anychart.core.Point> - Array of the points.getPixelBounds
Returns pixel bounds of the element due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the element.getPoint
Gets wrapped point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.SeriesPoint - Wrapped point.Try it:
getStat
Gets the statistics value by key.
Params:
| Name | Type | Description |
|---|---|---|
| key | anychart.enums.Statistics | string | Key. |
Returns:
* - Statistics value.Try it:
hatchFill
Getter for hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.Setter for hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | null | Type of the hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for hatch fill settings using pattern fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for hatch fill settings using an instance.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for hatch fill using boolean.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.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.radar.series.Area - Returns self for method chaining.Try it:
hover
Hovers points or series.
Detailed description
If index is passed, hovers a point of the series by its index, else hovers all points of the series.
Note: Works only after anychart.charts.Radar#draw is called.
Note: Works only after anychart.charts.Radar#draw is called.
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Hovers a point or a series by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Hovers points or series by indexes.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | Array.<number> | Array of indexes. |
Returns:
anychart.core.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.Try it:
includeAllPoints
Includes all excluded points.
Returns:
boolean - Returns 'true' if all points were included.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.keepOnlyPoints
Keep only the specified points.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Point index or indexes. |
labels
Setter for series data labels.
Detailed description
Sets labels settings depending on parameter type:
- null/boolean - disable or enable labels.
- object - sets labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.core.radar.series.Area - 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.radar.series.Area - Returns self for method chaining.Try it:
legendItem
Getter for legend item settings of series.
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Setter for legend item settings of series.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Legend item settings to set. |
Returns:
anychart.core.radar.series.Area - Self instance for method 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.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.radar.series.Area - Self instance for method chaining.Try it:
meta
Getter for the series meta data.
Params:
| Name | Type | Description |
|---|---|---|
| key | * | Metadata key. |
Returns:
* - Metadata object by key.Try it:
Setter for the series meta data.
Params:
| Name | Type | Description |
|---|---|---|
| object | * | Object to replace metadata. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining. Sample for series meta data.
chart.line([1,2,3]).meta({
'location': 'QA',
'source': 'https://some-url.dmn',
'imageSRC': 'https://some-url.dmn/getImage.php?bySomeParam=Value'
});Add/Replace meta data for series by key.
Params:
| Name | Type | Description |
|---|---|---|
| key | string | Metadata key. |
| value | * | Metadata value. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining. Sample: meta data for series by key.
var series = chart.line([1,2,3]);
series.meta('location', 'QA');
series.meta('source', 'https://some-url.dmn');
series.meta('imageSRC', 'https://some-url.dmn/getImage.php?bySomeParam=Value');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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.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.radar.series.Area - Self instance for method chaining.Try it:
name
Setter for the series name.
Basically, name of series is used in Legend displaying, but it can be used in tooltips as well.
Basically, name of series is used in Legend displaying, but it can be used in tooltips as well.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | undefined | Value to set. |
Returns:
anychart.core.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.Try it:
stroke
Getter for stroke settings.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Setter for series stroke by function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| strokeFunction | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill | function() {
return anychart.color.darken(this.sourceColor);
} | Function that looks like: function(){
// this.index - series index.
// this.sourceColor - color returned by stroke() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
} |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. |
| thickness | number | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
Setter for stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
tooltip
Setter for the series data tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.radar.series.Area - 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.radar.series.Area - Returns self for method chaining.Try it:
transformXY
Transforms values to pixel coordinates.
Params:
| Name | Type | Description |
|---|---|---|
| xVal | * | Value by x. |
| yVal | * | Value by y. |
| xSubRangeRatio | number | Ratio value. |
Returns:
Object.<string, number> - Pixel values.Try it:
unhover
Removes hover from the series point or series.
Detailed description
Note: Works only after anychart.charts.Radar#draw is called.
Returns:
anychart.core.radar.series.Area - Self instance for method chaining.Try it:
unselect
Deselects all selected points.
Returns:
anychart.core.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Returns self 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.radar.series.Area - 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.radar.series.Area - 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.radar.series.Area - Self instance for method chaining.Try it: