AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.utils.Margin Improve this Doc

Extends: anychart.core.Base

Stores margins values. Can accept numbers and strings. Use anychart.core.utils.Margin#set method to set values.

Methods Overview

Specific settings
set()Sets all offsets.
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
Size and Position
bottom()Getter for the bottom space.
left()Getter for the left space.
right()Getter for the right space.
top()Getter for the top space.

Methods Description

bottom

Getter for the bottom space.
Returns previously set margin, not the derived pixel value.

Returns:

number | string - The bottom space.
Setter for the bottom space.

Params:

NameTypeDescription
bottomnumber | string | nullBottom space to set.

Returns:

anychart.core.utils.Margin - Self instance for method chaining.

left

Getter for the left space.
Returns previously set margin, not the derived pixel value.

Returns:

number | string - The left space.
Setter for the left space.

Params:

NameTypeDescription
leftnumber | string | nullLeft space to set.

Returns:

anychart.core.utils.Margin - 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.
Getter for the right space.
Returns previously set margin, not the derived pixel value.

Returns:

number | string - The right space.
Setter for the right space.

Params:

NameTypeDescription
rightnumber | string | nullRight space to set.

Returns:

anychart.core.utils.Margin - Self instance for method chaining.

set

Sets all offsets.

Params:

NameTypeDescription
value1string | number | Array.<(number|string)> | ObjectMargin object or top or top and bottom space.
value2string | numberRight or right and left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.core.utils.Margin - Self instance for method chaining.

top

Getter for the top space.
Returns previously set margin, not the derived pixel value.

Returns:

number | string - The top space.
Setter for the top space.

Params:

NameTypeDescription
topnumber | string | nullTop space to set.

Returns:

anychart.core.utils.Margin - 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.