class anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings Improve this Doc
Extends: anychart.core.VisualBaseWithBounds
Timeline element.
Methods Overview
Coloring | |
fill() | Fill 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 | |
padding() | Padding settings |
zIndex() | Z-index of the element. |
Methods Description
enabled
Returns:
boolean - Element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true |
Value to set. |
Returns:
anychart.core.VisualBase - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
fill
Returns:
anychart.graphics.vector.Fill - The fill color.var currentFill = holidays.fill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
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.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
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.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
listen
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(Object e) | 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
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(Object e) | 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:
padding
Params:
Name | Type | Description |
---|---|---|
value | null | Array.<(number|string)> | Object | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.// all paddings 15px holidays.padding(15); // all paddings 15px holidays.padding('15px'); // top and bottom 5px ,right and left 15px holidays.padding(anychart.utils.padding(5,15));
Try it:
Params:
Name | Type | Description |
---|---|---|
value1 | string | number | Top or top-bottom space. |
value2 | string | number | Right or right-left space. |
value3 | string | number | Bottom space. |
value4 | string | number | Left space. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.// 1) top and bottom 10px, left and right 15px holidays.padding(10, '15px'); // 2) top 10px, left and right 15px, bottom 5px holidays.padding(10, '15px', 5); // 3) top 10px, right 15px, bottom 5px, left 12px holidays.padding(10, '15px', '5px', 12);
Try it:
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
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:
unlisten
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
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 |
Value to set. |
Returns:
anychart.core.VisualBase - Self instance for method chaining.Try it: