AnyChart
API Reference
Still have questions?
Contact support
Top

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.
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 rendering = series.rendering();
var finishFunction = rendering.finish();
Setter for the finish.

Params:

NameTypeDescription
finishFunctionfunctionFunction 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.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

needsWidth

Getter for points width.

Returns:

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

Params:

NameTypeDescription
enabledbooleanWhether the series has points width.

Returns:

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

needsZero

Getter for zero value.

Returns:

boolean - Zero value.
See listing
var rendering = series.rendering();
var needsZero = rendering.needsZero();
Setter for zero value.

Params:

NameTypeDescription
enabledbooleanWhether the series has zero value.

Returns:

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

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:

NameTypeDescription
pointFunctionfunctionFunction 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.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

shapes

Getter for shapes settings.

Returns:

Array.<anychart.core.series.RenderingSettings.ShapeConfig> - Array of shapes configs.
Setter for the shapes settings.

Params:

NameTypeDescription
configArray.<anychart.core.series.RenderingSettings.ShapeConfig>Array of shapes configs.

Returns:

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

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:

NameTypeDescription
startFunctionfunctionFunction 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.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

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:

NameTypeDescription
pointFunctionfunctionFunction 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.

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:

NameTypeDescription
valueArray.<string>An array of columns names.

Returns:

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