AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.gantt.Overlay Improve this Doc

Extends: anychart.core.Base

Overlay element class.

Methods Overview

Specific settings
className()Name of DIV class.
enabled()Enabled state.
id()DIV identifier.
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.
Miscellaneous
getElement()Gets the overlay DOM element.

Methods Description

className

Getter for the name of DIV class.

Returns:

string - The name of DIV class.
See listing
var id = overlay.className();
Setter for the name of DIV class.

Params:

NameTypeDescription
namestringClass name to set.

Returns:

anychart.core.gantt.Overlay - Self instance for method chaining.

enabled

Getter for the enabled state.

Returns:

boolean | null - Enabled state.
See listing
var state = overlay.enabled();
Setter for the enabled state.

Params:

NameTypeDescription
enabledbooleanEnabled state.

Returns:

anychart.core.gantt.Overlay - Self instance for method chaining.

getElement

Gets the overlay DOM element.

Returns:

Element - Overlay DOM element.

id

Getter for the DIV identifier.

Returns:

string - DIV Element id.
See listing
var id = overlay.id();
Setter for the DIV identifier.

Params:

NameTypeDescription
idstringDIV identifier to set.

Returns:

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

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.