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

Try it:

Setter for the bottom space.

Params:

Name Type Description
value number | string | null Value to set.

Returns:

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

Try it:

left

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

Returns:

number string - The left space.

Try it:

Setter for the left space.

Params:

Name Type Description
value number | string | null Value to set.

Returns:

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

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

Returns:

number string - The right space.

Try it:

Setter for the right space.

Params:

Name Type Description
value number | string | null Value to set.

Returns:

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

Try it:

set

Sets all offsets.

Params:

Name Type Description
value1 string | number | Array.<(number|string)> | Object Margin object or top or top and bottom space.
value2 string | number Right or right and left space.
value3 string | number Bottom space.
value4 string | number Left space.

Returns:

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

Try it:

top

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

Returns:

number string - The top space.

Try it:

Setter for the top space.

Params:

Name Type Description
value number | string | null Value to set.

Returns:

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

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: