class anychart.core.series.RenderingSettings Improve this Doc

Series renderer settings class.

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.
Events
listen()	Adds an event listener.
listenOnce()	Adds a single time event listener.
removeAllListeners()	Removes all listeners.
unlisten()	Removes the listener.
unlistenByKey()	Removes the listener by the key.

Methods Description

finish

finish()Since version 7.13.0

Getter for the finish.

Returns:

function - The finish function.

See listing

var currentRendering = series.rendering();
var finishFunction = currentRendering.finish();

finish(finishFunction)Since version 7.13.0

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). return finishValue; }`

Returns:

anychart.core.series.RenderingSettings - Self instance for method chaining.

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method. Function that looks like `function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

needsWidth

needsWidth()Since version 7.13.0

Getter for points width.

Returns:

boolean - Points width.

See listing

var currentRendering = series.rendering();
var widthFlag = currentRendering.needsWidth();

needsWidth(value)Since version 7.13.0

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

Set needsWidth(true) to start working with it.

Params:

Name	Type	Description
value	boolean	Whether the series has points width.

Returns:

anychart.core.series.RenderingSettings - Self instance for method chaining.

Try it:

Usage sample

needsZero

needsZero()Since version 7.13.0

Getter for zero value.

Returns:

boolean - Zero value.

See listing

var currentRendering = series.rendering();
var zeroFlag = currentRendering.needsZero();

needsZero(value)Since version 7.13.0

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

Set needsZero(true) to start working with it.

Params:

Name	Type	Description
value	boolean	Whether the series has zero value.

Returns:

anychart.core.series.RenderingSettings - Self instance for method chaining.

Try it:

Usage sample

point

point()Since version 7.13.0

Getter for the point.

Returns:

function - The point function.

See listing

var currentRendering = series.rendering();
var pointFunction = currentRendering.point();

point(pointFunction)Since version 7.13.0

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). // 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:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

shapes

shapes()Since version 7.13.0

Getter for shapes settings.

Returns:

Array.<anychart.core.series.RenderingSettings.ShapeConfig> - Shapes settings.

Try it:

Usage sample

shapes(value)Since version 7.13.0

Setter for the shapes settings.

Params:

Name	Type	Description
value	Array.<anychart.core.series.RenderingSettings.ShapeConfig>	Value to set.

Returns:

anychart.core.series.RenderingSettings - Self instance for method chaining.

Try it:

Usage sample

start

start()Since version 7.13.0

Getter for the start.

Returns:

function - The start function.

See listing

var currentRendering = series.rendering();
var startFunction = currentRendering.start();

start(startFunction)Since version 7.13.0

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). return startValue; }`

Returns:

anychart.core.series.RenderingSettings - Self instance for method chaining.

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

updatePoint

updatePoint()Since version 7.13.0

Getter for the update of a point.

Returns:

function - Self instance for method chaining.

See listing

var currentRendering = series.rendering();
var updatePointFunction = currentRendering.updatePoint();

updatePoint(pointFunction)Since version 7.13.0

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). // 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:

Usage sample

yValues

yValues()Since version 7.13.0

Getter for YScale values.

Returns:

Array.<string> - An array of columns names for the YScale.

See listing

var currentRendering = series.rendering();
var currentYValues = currentRendering.yValues();

yValues(value)Since version 7.13.0

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:

Usage sample