Top

class anychart.core.series.RenderingSettings Improve this Doc

Extends: anychart.core.Base

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

Getter for the finish.

Returns:

function - The finish function.
See listing
var currentRendering = series.rendering();
var finishFunction = currentRendering.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). return finishValue; }

Returns:

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

listen

Adds an event listener to an implementing object.

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:

listenOnce

Adds an event listener to an implementing object.

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:

needsWidth

Getter for points width.

Returns:

boolean - Points width.
See listing
var currentRendering = series.rendering();
var widthFlag = currentRendering.needsWidth();
Setter for points width.

Params:

Name Type Description
value 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 currentRendering = series.rendering();
var zeroFlag = currentRendering.needsZero();
Setter for zero value.

Params:

Name Type Description
value 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 currentRendering = series.rendering();
var pointFunction = currentRendering.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). // 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:

removeAllListeners

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:

shapes

Getter for shapes settings.

Returns:

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

Try it:

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:

start

Getter for the start.

Returns:

function - The start function.
See listing
var currentRendering = series.rendering();
var startFunction = currentRendering.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). return startValue; }

Returns:

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

unlisten

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:

unlistenByKey

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:

updatePoint

Getter for the update of a point.

Returns:

function - Self instance for method chaining.
See listing
var currentRendering = series.rendering();
var updatePointFunction = currentRendering.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). // 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 currentRendering = series.rendering();
var currentYValues = currentRendering.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: