class anychart.core.resource.TimeLine Improve this Doc
Extends: anychart.core.VisualBaseWithBounds
Resource Chart Timeline element.
Methods Overview
| Specific settings | |
| drawBottomLine() | Drawing of the bottom line. |
| drawLeftLine() | Drawing of the left line. |
| drawRightLine() | Drawing of the right line. |
| drawTopLine() | Drawing of the top line. |
| format() | Function to format content text. |
| holidays() | Padding settings |
| overlay() | Overlay element. |
| Advanced Text Settings | |
| maxFontSize() | Maximum font size settings. |
| minFontSize() | Minimum font size settings. |
| Coloring | |
| background() | Background settings. |
| fill() | Fill settings. |
| stroke() | Stroke settings. |
| Content Text Settings | |
| useHtml() | Use HTML option. |
| vAlign() | Text vertical align 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 | |
| bottom() | Bottom bound setting. |
| bounds() | Bounds settings. |
| getPixelBounds() | Returns pixel bounds. |
| height() | Height setting. |
| left() | Left bound setting. |
| maxHeight() | Maximum height. |
| maxWidth() | Maximum width. |
| minHeight() | Minimum height. |
| minWidth() | Minimum width. |
| padding() | Padding settings |
| right() | Right bound setting. |
| top() | Top bound setting. |
| width() | Width setting. |
| zIndex() | Z-index of the element. |
| Text Settings | |
| adjustFontSize() | Adjusting settings. |
| disablePointerEvents() | Pointer events settings. |
| fontColor() | Font color settings. |
| fontDecoration() | Font decoration setting. |
| fontFamily() | Font family settings. |
| fontOpacity() | Font opacity settings. |
| fontSize() | Font size settings. |
| fontStyle() | Font style settings. |
| fontVariant() | Font variant settings. |
| fontWeight() | Font weight settings. |
| hAlign() | Text horizontal align settings. |
| letterSpacing() | Text letter spacing settings. |
| lineHeight() | Text line height setting. |
| selectable() | Text selectable option. |
| textDirection() | Text direction settings. |
| textIndent() | Text indent settings. |
| textOverflow() | Text overflow settings. |
| textWrap() | Text wrap setting. |
| Miscellaneous | |
| levelHeight() | Getter for the level height. |
Methods Description
adjustFontSize
Getter for the adjusting font size.
Detailed description
Returns an array of two elements [isAdjustByWidth, isAdjustByHeight].
- [false, false] - do not adjust (adjust is off )
- [true, false] - adjust width
- [false, true] - adjust height
- [true, true] - adjust the first suitable value.
Returns:
number - An adjusted font size. See listing
var timeLine = chart.timeLine(); var adjustFontSize = timeLine.adjustFontSize();
Setter for the adjusting font size.
Detailed description
Minimal and maximal font sizes can be configured using:
anychart.core.resource.TimeLine#minFontSize and anychart.core.resource.TimeLine#maxFontSize methods.
Note: anychart.core.resource.TimeLine#fontSize does not work when adjusting is enabled.
Note: anychart.core.resource.TimeLine#fontSize does not work when adjusting is enabled.
Params:
| Name | Type | Description |
|---|---|---|
| adjustOrAdjustByWidth | boolean | Array.<boolean> | Object | Is font needs to be adjusted in case of 1 argument and adjusted by width in case of 2 arguments. |
| adjustByHeight | boolean | Is font needs to be adjusted by height. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
background
Setter for the background.
Detailed description
Sets background settings depending on parameter type:
- null/boolean - disable or enable background.
- object - sets background settings.
- string - sets background color.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Object | null | boolean | Value to set |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.bottom
Getter for element bottom bound setting.
Returns:
number | string | undefined - Current element's bottom bound setting.Sets element bottom bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
bounds
Getter for the element bounds settings.
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Sets bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
Setter for the element bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
disablePointerEvents
Getter for the pointer events settings.
Returns:
boolean - The pointer events settings. See listing
var timeLine = chart.timeLine(); var disablePointerEvents = timeLine.disablePointerEvents();
Setter for the pointer events setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.drawBottomLine
Getter for the bottom line drawing flag.
Returns:
boolean - Drawing flag. See listing
var currentGrid = chart.grid(); var flag = currentGrid.drawBottomLine();
Setter for the bottom line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawLeftLine
Getter for the left line drawing flag.
Returns:
boolean - Drawing flag. See listing
var currentGrid = chart.grid(); var flag = currentGrid.drawLeftLine();
Setter for the left line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawRightLine
Getter for the right line drawing flag.
Returns:
boolean - Drawing flag. See listing
var currentGrid = chart.grid(); var flag = currentGrid.drawRightLine();
Setter for the right line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawTopLine
Getter for the top line drawing flag.
Returns:
boolean - Drawing flag. See listing
var currentGrid = chart.grid(); var flag = currentGrid.drawTopLine();
Setter for the top line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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.resource.TimeLine - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fill
Getter for the fill color.
Returns:
anychart.graphics.vector.Fill - The fill color. See listing
var currentTimeLine = chart.timeLine(); var currentFill = currentTimeLine.fill();
Setter for fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
Fill color with opacity.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
Linear gradient fill.
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.resource.TimeLine - Self instance for method chaining.Try it:
Radial gradient fill.
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.resource.TimeLine - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontColor
Getter for font color settings.
Returns:
string - Font color settings. Example
var timeLine = chart.timeLine(); var fontColor = timeLine.fontColor();
Setter for font color settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontDecoration
Getter for font decoration settings.
Returns:
anychart.graphics.vector.Text.Decoration - Font decoration settings. Example
var timeLine = chart.timeLine(); var fontDecoration = timeLine.fontDecoration();
Setter for font decoration settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Text.Decoration | string | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontFamily
Getter for font family settings.
Returns:
string - Font family settings. See listing
var timeLine = chart.timeLine(); var fontFamily = timeLine.fontFamily();
Setter for font family settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | "Helvetica Neue", Helvetica, sans-serif | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontOpacity
Getter for font opacity settings.
Returns:
number - Font opacity settings. Example
var timeLine = chart.timeLine(); var fontOpacity = timeLine.fontOpacity();
Setter for font opacity settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontSize
Getter for font size settings.
Returns:
number - Font size settings. Example
var currentTooltipSettings = chart.tooltip(); var currentValue = currentTooltipSettings.fontSize();
Setter for font size settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 11 | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontStyle
Getter for font style settings.
Returns:
anychart.graphics.vector.Text.FontStyle - Font style settings. Example
var timeLine = chart.timeLine(); var fontStyle = timeLine.fontStyle();
Setter for font style settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.FontStyle | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontVariant
Getter for font variant settings.
Returns:
anychart.graphics.vector.Text.FontVariant - Font variant settings. Example
var timeLine = chart.timeLine(); var fontVariant = timeLine.fontVariant();
Setter for font variant settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.FontVariant | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
fontWeight
Getter for font weight settings.
Returns:
string | number - Font weight settings. Example
var timeLine = chart.timeLine(); var fontWeight = timeLine.fontWeight();
Setter for font weight settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | number | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
format
Getter for the function content text.
Returns:
function | string - Token or function to format text. Example
var format = timeLine.format();
Setter for the function content text.
Learn more about using format() method.
Learn more about using format() method.
Params:
| Name | Type | Description |
|---|---|---|
| value | function | string | Function or string token to format content text. |
Returns:
anychart.core.resource.TimeLineLevelHolidaysSettings - Self instance for method chaining.getPixelBounds
Returns pixel bounds of the element due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the element.hAlign
Getter for text horizontal align settings.
Returns:
anychart.graphics.vector.Text.HAlign - Horizontal align settings. Example
var timeLine = chart.timeLine(); var hAlign = timeLine.hAlign();
Setter for the text horizontal align settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.HAlign | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
height
Getter for element height setting.
Returns:
number | string | undefined - Current element's height setting.Sets element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
holidays
Getter for holidays.
Returns:
anychart.core.resource.TimeLineLevelHolidaysSettings - Holidays settings.Setter for holidays settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
left
Getter for element left bound setting.
Returns:
number | string | undefined - Current element's left bound setting.Sets element left bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
letterSpacing
Getter for text letter spacing settings.
Returns:
number - Letter spacing settings. Example
var timeLine = chart.timeLine(); var letterSpacing = timeLine.letterSpacing();
Setter for text letter spacing settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | string | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
levelHeight
Getter for the level height.
Returns:
number - The level height. See listing
var currentTimeLine = chart.timeLine(); var currentHeight = currentTimeLine.levelHeight();
Setter for the level height.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Level height. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
lineHeight
Getter for text line height settings.
Returns:
number | string - Line height settings. Example
var timeLine = chart.timeLine(); var lineHeight = timeLine.lineHeight();
Setter for text line height settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | "normal" | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
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:
maxFontSize
Getter for the maximum font size.
Returns:
number - Maximum font size. See listing
var maxFontSize = timeLine.maxFontSize();
Setter for the maximum font size.
Detailed description
Note: works only when adjusting is enabled. Look anychart.core.resource.TimeLine#adjustFontSize.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | string | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
maxHeight
Getter for maximum height.
Returns:
number | string | null - Current element's maximum height.Setter for maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
maxWidth
Getter for maximum width.
Returns:
number | string | null - Current element's maximum width.Setter for maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
minFontSize
Getter for the minimum font size.
Returns:
number - Minimum font size. See listing
var minFontSize = timeLine.minFontSize();
Setter for the minimum font size.
Detailed description
Note: works only when adjusting is enabled. Look anychart.core.resource.TimeLine#adjustFontSize.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | string | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
minHeight
Getter for minimum height.
Returns:
number | string | null - Current element's minimum height.Setter for minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
minWidth
Getter for minimum width.
Returns:
number | string | null - Current element's minimum width.Setter for minimum width.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
overlay
Getter for the overlay element.
Returns:
anychart.core.ui.Overlay - Overlay element. See listing
var element = timeLine.overlay();
Setter for the overlay element.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
padding
Setter for paddings in pixels using a single value.
Params:
| Name | Type | Description |
|---|---|---|
| value | null | Array.<(number|string)> | Object | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining. Examples for paddings
// all paddings 15px
timeLine.padding(15);
// all paddings 15px
timeLine.padding('15px');
// top and bottom 5px ,right and left 15px
timeLine.padding(anychart.utils.padding(5,15));Try it:
Setter for paddings in pixels using several numbers.
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.resource.TimeLine - Self instance for method chaining. Examples for paddings
// 1) top and bottom 10px, left and right 15px timeLine.padding(10, '15px'); // 2) top 10px, left and right 15px, bottom 5px timeLine.padding(10, '15px', 5); // 3) top 10px, right 15px, bottom 5px, left 12px timeLine.padding(10, '15px', '5px', 12);
Try it:
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:
right
Getter for element right bound setting.
Returns:
number | string | undefined - Current element's right bound setting.Sets element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
selectable
Getter for the text selectable option.
Returns:
boolean - Text selectable value. Example
var timeLine = chart.timeLine(); var selectable = timeLine.selectable();
Setter for the text selectable option.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
stroke
Getter for the stroke.
Returns:
anychart.graphics.vector.Stroke - The stroke. See listing
var currentTimeLine = chart.timeLine(); var currentStroke = currentTimeLine.stroke();
Setter for the stroke.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
textDirection
Getter for the text direction settings.
Returns:
anychart.graphics.vector.Text.Direction - Text direction settings. Example
var timeLine = chart.timeLine(); var textDirection = timeLine.textDirection();
Setter for text direction settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.Direction | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
textIndent
Getter for text-indent settings.
Returns:
number - Text indent settings. Example
var timeLine = chart.timeLine(); var textIndent = timeLine.textIndent();
Setter for text-indent settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
textOverflow
Getter for text overflow settings.
Returns:
anychart.graphics.vector.Text.TextOverflow - Text overflow settings Example
var timeLine = chart.timeLine(); var textOverflow = timeLine.textOverflow();
Setter for text overflow settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Text.TextOverflow | string | Value to set |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
textWrap
Getter for text wrap settings.
Returns:
anychart.graphics.vector.Text.TextWrap - Text wrap settings. Example
var timeLine = chart.timeLine(); var textWrap = timeLine.textWrap();
Setter for text wrap settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.TextWrap | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
top
Getter for element top bound setting.
Returns:
number | string | undefined - Current element's top bound setting.Sets element top bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
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:
useHtml
Getter for the useHTML flag.
Returns:
boolean - UseHTML flag. Example
var timeLine = chart.timeLine(); var useHtml = timeLine.useHtml();
Setter for the useHTML flag.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
vAlign
Getter for text vertical align settings.
Returns:
anychart.graphics.vector.Text.VAlign - Vertical align. Example
var timeLine = chart.timeLine(); var vAlign = timeLine.vAlign();
Setter for text vertical align settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | anychart.graphics.vector.Text.VAlign | Value to set. |
Returns:
anychart.core.resource.TimeLine - Self instance for method chaining.Try it:
width
Getter for element width setting.
Returns:
number | string | undefined - Current element's width setting.Sets element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.resource.TimeLine - Returns self for method chaining.Try it:
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.resource.TimeLine - Self instance for method chaining.Try it: