Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.core.ui.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 = currentOverlay.className();
Setter for the name of DIV class.

Params:

Name Type Description
value string Value to set.

Returns:

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

Try it:

enabled

Getter for the enabled state.

Returns:

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

Params:

Name Type Description
value boolean Value to set.

Returns:

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

Try it:

getElement

Gets the overlay DOM element.

Returns:

Element - Overlay DOM element.

Try it:

id

Getter for the DIV identifier.

Returns:

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

Params:

Name Type Description
value string Value to set.

Returns:

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

Try it:

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:

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:

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: