class anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings Improve this Doc
Extends: anychart.core.VisualBaseWithBounds
Timeline element.
Methods Overview
Coloring | |
fill() | Fill settings. |
Content Text Settings | |
adjustFontSize() | Adjusting settings. |
disablePointerEvents() | Pointer events settings. |
fontColor() | Font color settings. |
fontDecoration() | Font decoration settings. |
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() | Line height settings. |
maxFontSize() | Maximum font size setting. |
minFontSize() | Minimum font size settings. |
textDirection() | Text direction settings. |
textIndent() | Text indent settings. |
textOverflow() | Text overflow settings. |
useHtml() | Text useHtml settings. |
vAlign() | Text vertical align settings. |
wordBreak() | Word break mode. |
wordWrap() | Word-wrap mode. |
Interactivity | |
selectable() | Text selectable option. |
Size and Position | |
padding() | Padding settings |
Methods Description
adjustFontSize
- [false, false] - don't adjust (adjust is off )
- [true, false] - adjust width
- [false, true] - adjust height
- [true, true] - adjust the first suitable value.
Returns:
Object - AdjustFontSize settings.Note: anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings#fontSize does not work when adjusting is enabled.
Params:
Name | Type | Default | Description |
---|---|---|---|
bothOrByWidth | Object | Array.<boolean> | boolean | {width: false, height: false} | If only one param is set, its value goes for another too (see source code). |
byHeight | boolean | Is font needs to be adjusted by height. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.timeLineHolidays.adjustFontSize(false); // the same timeLineHolidays.adjustFontSize(false, false); // the same timeLineHolidays.adjustFontSize([false, false]);
disablePointerEvents
Returns:
boolean - The pointer events settings.var disablePointerEvents = timeLineHolidays.disablePointerEvents();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.fill
Returns:
anychart.graphics.vector.Fill - The fill color.var fill = holidays.fill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.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:
fontColor
Returns:
string - Font color settings.var fontColor = timeLineHolidays.fontColor();
Params:
Name | Type | Description |
---|---|---|
color | string | Color to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.fontDecoration
Returns:
anychart.graphics.vector.Text.Decoration | string - Font decoration.var fontDecoration = timeLineHolidays.fontDecoration();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.Text.Decoration | string | anychart.graphics.vector.Text.Decoration#NONE | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
fontFamily
Returns:
string - Font family.var fontFamily = timeLineHolidays.fontFamily();
Params:
Name | Type | Description |
---|---|---|
fontFamily | string | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
fontOpacity
Returns:
number - Font opacity.var fontOpacity = timeLineHolidays.fontOpacity();
Double value from 0 to 1.
Params:
Name | Type | Description |
---|---|---|
opacity | number | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
fontSize
Returns:
number - Font size settings.var fontSize = timeLineHolidays.fontSize();
Params:
Name | Type | Description |
---|---|---|
size | number | string | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
fontStyle
Returns:
anychart.graphics.vector.Text.FontStyle - Font style settings.var fontStyle = timeLineHolidays.fontStyle();
Params:
Name | Type | Description |
---|---|---|
type | string | anychart.graphics.vector.Text.FontStyle | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
fontVariant
Returns:
anychart.graphics.vector.Text.FontVariant - Font variant settings.var fontVariant = timeLineHolidays.fontVariant();
Params:
Name | Type | Description |
---|---|---|
type | string | anychart.graphics.vector.Text.FontVariant | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.fontWeight
Returns:
string | number - Font weight settings.var fontWeight = timeLineHolidays.fontWeight();
Params:
Name | Type | Description |
---|---|---|
weight | string | number | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.hAlign
Returns:
anychart.graphics.vector.Text.HAlign - Horizontal align settings.var hAlign = timeLineHolidays.hAlign();
Params:
Name | Type | Description |
---|---|---|
type | string | anychart.graphics.vector.Text.HAlign | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.letterSpacing
Returns:
number | string - Letter spacing settings.var letterSpacing = timeLineHolidays.letterSpacing();
Params:
Name | Type | Description |
---|---|---|
spacing | number | string | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
lineHeight
Returns:
string | number - Text line height.var lineHeight = timeLineHolidays.lineHeight();
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp
Params:
Name | Type | Description |
---|---|---|
height | string | number | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.maxFontSize
Returns:
number - Maximum font size.Params:
Name | Type | Description |
---|---|---|
size | number | string | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.minFontSize
Returns:
number - Minimum font size.Params:
Name | Type | Description |
---|---|---|
size | number | string | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.padding
Params:
Name | Type | Description |
---|---|---|
padding | null | Array.<(number|string)> | Object | Padding 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:
selectable
Returns:
boolean - Text selectable option.var selectable = timeLineHolidays.selectable();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
textDirection
Returns:
anychart.graphics.vector.Text.Direction | string - Text direction.var textDirection = timeLineHolidays.textDirection();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.Text.Direction | string | 'ltr' | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.textIndent
Returns:
number - Text indent.var textIndent = timeLineHolidays.textIndent();
Params:
Name | Type | Description |
---|---|---|
indent | number | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.Try it:
textOverflow
Returns:
anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.var textOverflow = timeLineHolidaystextOverflow();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.TextOverflow | string | "" | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.useHtml
Returns:
boolean - Value of useHTML flag.var useHtml = timeLineHolidays.useHtml();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.vAlign
Returns:
anychart.graphics.vector.Text.VAlign | string - Text vertical align.var vAlign = timeLineHolidays.vAlign();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.Text.VAlign | string | 'top' | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.wordBreak
Returns:
anychart.enums.WordBreak | string - Word-break mode.var wordBreak = timeLineHolidays.wordBreak();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.enums.WordBreak | string | 'normal' | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.wordWrap
Returns:
anychart.enums.WordWrap | string - Word-wrap mode.var wordWrap = annotation.wordWrap();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.enums.WordWrap | string | 'normal' | Value to set. |
Returns:
anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Self instance for method chaining.