class anychart.core.series.RenderingSettings Improve this Doc
Extends: anychart.core.Base
Custom drawing series settings.
RenderingSettings class is a set of methods for overriding series drawing method.
The class allows overriding standard drawing functions.
To get a rendering object, use the rendering() method of the series which drawing you want to override.
Methods Overview
| Specific settings | |
| finish() | Finish settings. |
| needsWidth() | Points width settings |
| needsZero() | Zero settings |
| point() | Point settings. |
| shapes() | Shapes settings. |
| start() | Start settings. |
| updatePoint() | Point update settings |
| yValues() | YScale values settings. |
Methods Description
finish
Getter for the finish.
Returns:
function - The finish function. See listing
var rendering = series.rendering(); var finishFunction = rendering.finish();
Setter for the finish.
Params:
| Name | Type | Description |
|---|---|---|
| finishFunction | function | Function that looks like
function(anychart.core.series.RenderingSettings.Context){
this.anychart.core.series.RenderingSettings.Context
// The context contains fields:
// series - Chart series (anychart.core.stock.series.Base|anychart.core.cartesian.series.Base|anychart.core.stock.scrollerSeries.Base).
// seriesState - State of entire series (anychart.enums.PointState|string).
return finishValue;
} |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.needsWidth
Getter for points width.
Returns:
boolean - Points width. See listing
var rendering = series.rendering(); var needsWidth = rendering.needsWidth();
Setter for points width.
Detailed description
Note: By default, points width is disabled for the next series:
- Area
- Area3d
- Bubble
- Line
- Marker
- RangeArea
- RangeSplineArea
- RangeStepArea
- Spline
- SplineArea
- StepArea
- StepLine
Params:
| Name | Type | Description |
|---|---|---|
| enabled | boolean | Whether the series has points width. |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it:
needsZero
Getter for zero value.
Returns:
boolean - Zero value. See listing
var rendering = series.rendering(); var needsZero = rendering.needsZero();
Setter for zero value.
Detailed description
Note: By default, zero value is disabled for the next series:
- Box
- Bubble
- Candlestick
- Line
- Marker
- OHLC
- RangeArea
- RangeBar
- RangeColumn
- RangeSplineArea
- RangeStepArea
- Spline
- StepLine
Params:
| Name | Type | Description |
|---|---|---|
| enabled | boolean | Whether the series has zero value. |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it:
point
Getter for the point.
Returns:
function - The point function. See listing
var rendering = series.rendering(); var pointFunction = rendering.point();
Setter for the point.
Params:
| Name | Type | Description |
|---|---|---|
| pointFunction | function | Function that looks like
function(anychart.core.series.RenderingSettings.PointContext){
this.anychart.core.series.RenderingSettings.PointContext
// The context contains fields:
// size - The size value if series is Bubble.
// x - The pixel X coordinate of the point center.
// pointState - Point state (anychart.enums.PointState|string).
// missing - Whether the point is missing.
// categoryWidth - The category width if XScale is ordinal. Otherwise 1.
// pointWidth - The point width, if needsWidth() value is true. Otherwise undefined.
// zero - Zero value by YScale, if needsZero() value is true.
return pointValue;
} |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it:
shapes
Getter for shapes settings.
Returns:
Array.<anychart.core.series.RenderingSettings.ShapeConfig> - Array of shapes configs.Try it:
Setter for the shapes settings.
Params:
| Name | Type | Description |
|---|---|---|
| config | Array.<anychart.core.series.RenderingSettings.ShapeConfig> | Array of shapes configs. |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it:
start
Getter for the start.
Returns:
function - The start function. See listing
var rendering = series.rendering(); var start = rendering.start();
Setter for the start.
Params:
| Name | Type | Description |
|---|---|---|
| startFunction | function | Function that looks like
function(anychart.core.series.RenderingSettings.Context){
this.anychart.core.series.RenderingSettings.Context
// The context contains fields:
// series - Chart series (anychart.core.stock.series.Base|anychart.core.cartesian.series.Base|anychart.core.stock.scrollerSeries.Base).
// seriesState - State of entire series (anychart.enums.PointState|string).
return startValue;
} |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.updatePoint
Getter for the update of a point.
Returns:
function - Self instance for method chaining. See listing
var rendering = series.rendering(); var updatePointFunction = rendering.updatePoint();
Setter for the update of a point.
Change the point shape when the state changes.
Params:
| Name | Type | Description |
|---|---|---|
| pointFunction | function | Function that looks like
function(anychart.core.series.RenderingSettings.PointContext){
this.anychart.core.series.RenderingSettings.PointContext
// The context contains fields:
// size - The size value if series is Bubble.
// x - The pixel X coordinate of the point center.
// pointState - Point state (anychart.enums.PointState|string).
// missing - Whether the point is missing.
// categoryWidth - The category width if XScale is ordinal. Otherwise 1.
// pointWidth - The point width, if needsWidth() value is true. Otherwise undefined.
// zero - Zero value by YScale, if needsZero() value is true.
// shapes - Shapes group of the point.
return updatePointValue;
} |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it:
yValues
Getter for YScale values.
Returns:
Array.<string> - An array of columns names for the YScale. See listing
var rendering = series.rendering(); var yValues = rendering.yValues();
Setter for YScale values.
Params:
| Name | Type | Description |
|---|---|---|
| value | Array.<string> | An array of columns names. |
Returns:
anychart.core.series.RenderingSettings - Self instance for method chaining.Try it: