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.
The Separator class contains methods for configuring the Legend and Tooltip separator.

Methods Overview

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

Methods Description

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

fill

Getter for the separator fill.

Returns:

anychart.graphics.vector.Fill - Fill settings.
See listing
var separator = legend.titleSeparator();
var fill =  separator.fill();
Setter for separator fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | stringColor as an array, an object or string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

getRemainingBounds

Returns the remaining (after separator placement) part of the container.

Returns:

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

height

Getter for the separator height.

Returns:

number | string | null - Returns separator height.
See listing
var separator = legend.titleSeparator();
var height =  separator.height();
Setter for the separator height.

Params:

NameTypeDescription
heightnumber | string | nullHeight to set.

Returns:

anychart.core.ui.Separator - 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.

margin

Getter for the separator margin.

Returns:

anychart.core.utils.Margin - Margin instance.
Setter for the margin using a single value.

Params:

NameTypeDescription
marginArray.<(number|string)> | ObjectMargin to set.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Setter for the callout margin using several values.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

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

orientation

Getter for the separator orientation.

Returns:

anychart.enums.Orientation | string - Return the separator orientation.
See listing
var separator = legend.titleSeparator();
var orientation =  separator.orientation();
Setter for the separator orientation.

Params:

NameTypeDescription
orientationanychart.enums.Orientation | stringOrientation settings.

Returns:

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

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

Getter for the separator stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var separator = legend.titleSeparator();
var stroke =  separator.stroke();
Setter for the separator stroke.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberThickness settings.
dashpatternstringDash pattern settings.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join settings.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap settings.

Returns:

anychart.core.ui.Separator - Self instance for method chaining.
Setter for the separator stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.grids.Radar - 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.

width

Getter for the separator width.

Returns:

number | string | null - Returns separator width.
See listing
var separator = legend.titleSeparator();
var width =  separator.width();
Setter for the separator width.

Params:

NameTypeDescription
widthnumber | string | nullWidth 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.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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