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.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
Separator fill.
Params:
| Name | Type | Description |
|---|---|---|
| fillOrColorOrKeys | anychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | null | Fill settings or Color or Gradient keys. |
| opacityOrAngleOrCx | number | Opacity or Angle or x-coord of center. |
| modeOrCy | number | boolean | anychart.graphics.math.Rect | Object | Mode settings or y-coord of center. |
| opacityOrMode | number | anychart.graphics.math.Rect | Object | null | Opacity settings or Mode settings. |
| opacity | number | Opacity settings. |
| fx | number | Focal x-coord settings. |
| fy | number | Focal 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:
| 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.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
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:
margin
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. |
orientation
Orientation of the separator.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.Orientation | string | Orientation settings. |
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 | anychart.graphics.vector.StrokeLineJoin | Line join settings. |
| lineCap | 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 current Z-index of the element.
Returns:
number - The current zIndex.Try it:
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.ui.Separator - Self instance for method chaining.Try it: