AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.ui.Separator Improve this Doc

Extends: anychart.core.VisualBase

Class for a separator element.

Methods Overview

Coloring
fill()Separator fill.
stroke()Separator stroke.
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.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
getRemainingBounds()Remaining bounds.
height()Height settings.
margin()Margin of the separator
orientation()Orientation of the separator.
width()Width settings.
zIndex()Z-index of the element.

Methods Description

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fill

Separator fill.

Params:

NameTypeDescription
fillOrColorOrKeysanychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | nullFill settings or Color or Gradient keys.
opacityOrAngleOrCxnumberOpacity or Angle or x-coord of center.
modeOrCynumber | boolean | anychart.graphics.math.Rect | ObjectMode settings or y-coord of center.
opacityOrModenumber | anychart.graphics.math.Rect | Object | nullOpacity settings or Mode settings.
opacitynumberOpacity settings.
fxnumberFocal x-coord settings.
fynumberFocal y-coord settings.

Returns:

anychart.graphics.vector.Fill | anychart.core.ui.Separator - Current fill setting or itself for chaining..

getRemainingBounds

Returns:

anychart.math.Rect - Parent bounds without the space used by the title.

height

Getter for separator height.

Returns:

number | string | null - Current height.
Setter for separator height.

Params:

NameTypeDescription
valuenumber | string | nullValue to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

margin

Margin of the separator

Params:

NameTypeDescription
spaceOrTopOrTopAndBottomstring | number | Array.<(number|string)> | ObjectAll settings or Pair top and bottom or only top settings.
rightOrRightAndLeftstring | numberRight or Pair right and left settings.
bottomstring | numberBottom margin.
leftstring | numberLeft margin.

orientation

Orientation of the separator.

Params:

NameTypeDescription
valueanychart.enums.Orientation | stringOrientation settings.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

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.

stroke

Separator stroke.

Params:

NameTypeDescription
strokeOrFillanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberThickness settings.
dashpatternstringDash pattern settings.
lineJoinanychart.graphics.vector.StrokeLineJoinLine join settings.
lineCapanychart.graphics.vector.StrokeLineCapLine cap settings.

Returns:

anychart.core.ui.Separator | anychart.graphics.vector.Stroke - Current stroke setting or itself for chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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.

width

Getter for separator width.

Returns:

number | string | null - Current width.
Setter for separator width.

Params:

NameTypeDescription
valuenumber | string | nullValue to set.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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