AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.Separator Improve this Doc

Extends: anychart.core.VisualBase

Class for a separator element.

Methods Overview

Coloring
fill()Fill settings.
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()Getter for the margin of the separator.
orientation()Getter fo the orientation of the separator.
width()Width settings.
zIndex()Z-index of the element.

Methods Description

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

fill

Getter for the separator fill.

Returns:

anychart.graphics.vector.Fill - Fill settings.
Setter for separator fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an array or string.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Linear gradient fill for the separator. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Radial gradient fill for the separator. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Image fill for the separator. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.ui.Separator - Self instance for method 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:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(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
}
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(e:Object)
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:

margin

Getter for the margin of the separator.

Returns:

anychart.core.utils.Margin - Margin instance.
Setter for the margin of the separator.

Params:

Name Type Description
spaceOrTopOrTopAndBottom string | number | Array.<(number|string)> | Object All settings or Pair top and bottom or only top settings.
rightOrRightAndLeft string | number Right or Pair right and left settings.
bottom string | number Bottom margin.
left string | number Left margin.

Returns:

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

orientation

Getter fo the orientation of the separator.

Returns:

anychart.enums.Orientation string - Orientation of the separator.
Getter fo the orientation of the separator.

Params:

Name Type Description
value anychart.enums.Orientation | string Orientation settings.

Returns:

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

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

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:

stroke

Separator stroke.

Params:

Name Type Description
strokeOrFill anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null Stroke settings.
thickness number Thickness settings.
dashpattern string Dash pattern settings.
lineJoin string | anychart.graphics.vector.StrokeLineJoin Line join settings.
lineCap string | anychart.graphics.vector.StrokeLineCap Line 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:

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:

width

Getter for separator width.

Returns:

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

Params:

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

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: