AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.gantt.rendering.Settings Improve this Doc

Extends: anychart.core.Base

Custom drawing settings.
Two main methods in rendering settings are drawer and shapes. The drawer method sets the drawing function.
The shapes method returns the map of shapes used for drawing. Also, shapes are used in the context of the drawing function (drawer()).
ShapeConfig is the configurations of shapes that are set in the array using the shapes() method.

Methods Overview

Specific settings
drawer()Custom drawing settings.
shapes()Shapes 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

drawer

Getter for custom drawing settings.

Returns:

function - Custom drawing function.
See listing
var rendering = elements.rendering();
var drawer = rendering.drawer();
Setter for custom drawing settings.

Params:

NameTypeDescription
drawerFunctionfunctionFunction for custom drawing. Function that looks like
function(){
   // this.predictedBounds - Recommended bounds for custom drawing. Bounds are calculated on the base of height,
   position, offset, anchor and scale data (start/end). Type is anychart.math.Rect.
   // this.item - The data item that corresponds to the row. Type is anychart.data.Tree.DataItem
   or anychart.data.TreeView.DataItem
   // this.shapes - The shapes map for drawing called from anychart.core.gantt.rendering.Settings#shapes method.
   Map is {Object.}.
   // this.period - Period object as is. For anychart#ganttResource
   // this.periodIndex - The index of the period that is drawn. Type is number. For anychart#ganttResource
}

Returns:

anychart.core.gantt.rendering.Settings - 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.

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 of the custom drawing.

Returns:

Array.<anychart.core.gantt.rendering.Settings.ShapeConfig> - Array of shapes configs.
Setter for shapes of the custom drawing.

Params:

NameTypeDescription
configArray.<anychart.core.gantt.rendering.Settings.ShapeConfig>Array of shapes configs.

Returns:

anychart.core.gantt.rendering.Settings - 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.