class anychart.core.gantt.DataGridButton Improve this Doc

Collapse-expand button.

Methods Overview

Specific settings
content()	Buttons content.
cursor()	Cursor type
Advanced Text Settings
letterSpacing()	Button text letter spacing.
lineHeight()	Button text line height.
textIndent()	Button text indent.
textOverflow()	Button text overflow.
useHtml()	Disable/Enable text useHtml.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
Coloring
background()	Background settings.
Events
disablePointerEvents()	Disable/Enable pointer events.
Interactivity
enabled()	Element state (enabled or disabled).
hovered()	Hovered state settings.
normal()	Normal state settings.
selectable()	Text selectable option.
selected()	Selected state settings.
Size and Position
height()	Buttons height.
padding()	Padding settings.
width()	Buttons width.
zIndex()	Z-index of the element.
Text Settings
fontColor()	Button font color.
fontDecoration()	Button font decoration.
fontFamily()	Button font family.
fontOpacity()	Button font opacity.
fontSize()	Button font size.
fontStyle()	Button font style.
fontVariant()	Button font variant.
fontWeight()	Button text font weight.
hAlign()	Button text horizontal align.
textDirection()	Button text direction.
textShadow()	Button text shadow.
vAlign()	Button text vertical align.

Methods Description

background

background()

Getter for the labels background settings.

Returns:

anychart.core.ui.Background - Labels background.

Try it:

Usage sample

background(settings)

Setter for the labels background settings.

Detailed description

Sets labels background settings depending on parameter type:

null/boolean - disable or enable labels background.
string - sets labels background color value.
object - sets labels background settings.

Params:

Name	Type	Default	Description
settings	string \| Object \| null \| boolean	true	Background settings to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

content

content()Since version 8.3.0

Getter for buttons content.

Returns:

string | number - Buttons content.

See listing

var content = buttons.content();

content(content)Since version 8.3.0

Setter for buttons content.

Params:

Name	Type	Description
content	string \| number	Buttons content.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

content(function)Since version 8.3.0

Setter for buttons content using function.

Params:

Name	Type	Description
function	function(path:anychart.graphics.vector.Path)	Buttons content. Function that looks like: function(anychart.graphics.vector.Path){ // this.path - button element, instance of anychart.graphics.vector.Path // this.width - button width (number). // this.height - button height (number). // this.state - button state: normal, hovered or selected (string). }

Name

Type

Description

function

function(path:anychart.graphics.vector.Path)

Buttons content. Function that looks like:

function(anychart.graphics.vector.Path){
   // this.path - button element, instance of anychart.graphics.vector.Path
   // this.width - button width (number).
   // this.height - button height (number).
   // this.state - button state: normal, hovered or selected (string).
}

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

cursor

cursor()Since version 8.2.0

Getter for the cursor type.

Returns:

anychart.enums.Cursor | string - Cursor type.

See listing

var buttons = dataGrid.buttons();
var cursor = buttons.cursor();

cursor(cursorType)Since version 8.2.0

Setter for the cursor type.

Params:

Name	Type	Default	Description
cursorType	string \| anychart.enums.Cursor	'pointer'	Cursor type to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()Since version 8.3.0

Getter for the state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.

See listing

var disablePointerEvents = buttons.disablePointerEvents();

disablePointerEvents(enabled)Since version 8.3.0

Setter for the text disablePointerEvents option.

Detailed description

This options defines whether the text should pass mouse events through.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fontColor

fontColor()Since version 8.3.0

Getter for button font color.

Returns:

string - Font color settings.

See listing

var fontColor = buttons.fontColor();

fontColor(color)Since version 8.3.0

Setter for button font color settings.

Params:

Name	Type	Description
color	string	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

fontDecoration

fontDecoration()Since version 8.3.0

Getter for the button text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.

See listing

var fontDecoration = buttons.fontDecoration();

fontDecoration(fontDecoration)Since version 8.3.0

Setter for the button text font decoration.

Params:

Name	Type	Default	Description
fontDecoration	anychart.graphics.vector.Text.Decoration \| string	anychart.graphics.vector.Text.Decoration#NONE	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()Since version 8.3.0

Getter for the button font family of text.

Returns:

string - Font family.

See listing

var fontFamily = buttons.fontFamily();

fontFamily(fontFamily)Since version 8.3.0

Setter for the button font family of text.

Params:

Name	Type	Default	Description
fontFamily	string	'Verdana, Helvetica, Arial, sans-serif'	Font family.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()Since version 8.3.0

Getter for the button text font opacity.

Returns:

number - Font opacity.

See listing

var fontOpacity = buttons.fontOpacity();

fontOpacity(opacity)Since version 8.3.0

Setter for the button text font opacity.
Double value from 0 to 1.

Params:

Name	Type	Description
opacity	number	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Description
size	number \| string	Font size to set.

fontStyle

fontStyle()Since version 8.3.0

Getter for the button text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.

See listing

var fontStyle = buttons.fontStyle();

fontStyle(style)Since version 8.3.0

Setter for the button text font style.

Params:

Name	Type	Description
style	anychart.graphics.vector.Text.FontStyle \| string	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

fontVariant

fontVariant()Since version 8.3.0

Getter for the button text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.

See listing

var fontVariant = buttons.fontVariant();

fontVariant(type)Since version 8.3.0

Setter for the button text font variant.

Params:

Name	Type	Description
type	anychart.graphics.vector.Text.FontVariant \| string	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()Since version 8.3.0

Getter for the button text font weight.

Returns:

string | number - Font weight.

See listing

var fontWeight = buttons.fontWeight();

fontWeight(weight)Since version 8.3.0

Setter for the button text font weight. https://www.w3schools.com/cssref/pr_font_weight.asp

Params:

Name	Type	Description
weight	string \| number	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

hAlign

hAlign()Since version 8.3.0

Getter for the button text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.

See listing

var hAlign = buttons.hAlign();

hAlign(align)Since version 8.3.0

Setter for the button text horizontal align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.HAlign \| string	anychart.graphics.vector.Text.HAlign#START	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

height

height()Since version 8.3.0

Getter for the buttons height.

Returns:

number | string - Buttons height.

See listing

var buttons = dataGrid.buttons();
var height = buttons.height();

height(height)Since version 8.3.0

Setter for the buttons height.

Params:

Name	Type	Description
height	number \| string	Buttons height to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

hovered

hovered()Since version 8.3.0

Getter for hovered state settings.
The hovered state is a hover on the button in the normal state.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.3.0

Setter for hovered state settings.
The hovered state is a hover on the button in the normal state.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()Since version 8.3.0

Getter for the button text letter spacing.

Returns:

string | number - Letter spacing.

See listing

var letterSpacing = buttons.letterSpacing();

letterSpacing(spacing)Since version 8.3.0

Setter for the button text letter spacing. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Description
spacing	string \| number	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()Since version 8.3.0

Getter for the button text line height.

Returns:

string | number - Text line height.

See listing

var lineHeight = buttons.lineHeight();

lineHeight(height)Since version 8.3.0

Setter for the button text line height. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Description
height	string \| number	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

normal

normal()Since version 8.3.0

Getter for normal state settings.
The normal state is the button in the collapsed state.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.3.0

Setter for normal state settings.
The normal state is the button in the collapsed state.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

padding

padding()Since version 8.3.0

Getter for the buttons padding.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - The buttons padding.

Try it:

Usage sample

padding(padding)Since version 8.3.0

Setter for the buttons padding in pixels by one value.

Params:

Name	Type	Description
padding	Array.<(number\|string)> \| Object	An array of field values to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)Since version 8.3.0

Setter for the buttons padding in pixels using several numbers.

Params:

Name	Type	Default	Description
value1	string \| number	5	Top or top-bottom space.
value2	string \| number	10	Right or right-left space.
value3	string \| number	5	Bottom space.
value4	string \| number	10	Left space.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Example

// 1) top and bottom 10px, left and right 15px
buttons.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
buttons.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
buttons.padding(10, '15px', '5px', 12);

Try it:

Usage sample

selectable

selectable()Since version 8.3.0

Getter for the text selectable option.

Returns:

boolean - Text selectable option.

See listing

var textOverflow = buttons.selectable();

selectable(enabled)Since version 8.3.0

Setter for the text selectable.

Detailed description

This options defines whether the text can be selected. If set to false one can't select the text.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

selected

selected()Since version 8.3.0

Getter for selected state settings.
The selected state is the button in the expanded state.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.3.0

Setter for selected state settings.
The selected state is the button in the expanded state.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()Since version 8.3.0

Getter for the button text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.

See listing

var textDirection = buttons.textDirection();

textDirection(type)Since version 8.3.0

Setter for the button text direction.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.Text.Direction \| string	anychart.graphics.vector.Text.Direction#LTR	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

textIndent

textIndent()Since version 8.3.0

Getter for the button text indent.

Returns:

number - Text indent.

See listing

var textIndent = buttons.textIndent();

textIndent(indent)Since version 8.3.0

Setter for the button text indent.

Params:

Name	Type	Description
indent	number	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

textOverflow

textOverflow()Since version 8.3.0

Getter for the text overflow.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.

See listing

var textOverflow = buttons.textOverflow();

textOverflow(value)Since version 8.3.0

Setter for the text overflow settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	anychart.graphics.vector.Text.TextOverflow#CLIP	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

textShadow

textShadow()Since version 8.3.0

Getter for button text shadow.

Returns:

string - String representation of text shadow.

See listing

var fontColor = buttons.textShadow();

textShadow(textShadow)Since version 8.3.0

Setter for button text shadow settings.

Params:

Name	Type	Default	Description
textShadow	anychart.graphics.vector.TextShadow \| string	'none'	Text shadow to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

useHtml

useHtml()Since version 8.3.0

Getter for the useHtml flag.

Returns:

boolean - Boolean flag.

See listing

var useHtml = buttons.useHtml();

useHtml(enabled)Since version 8.3.0

Setter for button text as useHtml.

Detailed description

This property defines whether HTML text should be parsed.

Params:

Name	Type	Description
enabled	boolean	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

vAlign

vAlign()Since version 8.3.0

Getter for the button text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.

See listing

var vAlign = buttons.vAlign();

vAlign(align)Since version 8.3.0

Setter for the button text vertical align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.VAlign \| string	anychart.graphics.vector.Text.VAlign#TOP	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

width

width()Since version 8.3.0

Getter for the buttons width.

Returns:

number | string - Buttons width.

See listing

var buttons = dataGrid.buttons();
var width = buttons.width();

width(width)Since version 8.3.0

Setter for the buttons width.

Params:

Name	Type	Description
width	number \| string	Buttons width to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.3.0

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.

See listing

var wordBreak = buttons.wordBreak();

wordBreak(type)Since version 8.3.0

Setter for the word-break mode.

Params:

Name	Type	Description
type	anychart.enums.WordBreak \| string	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

wordWrap

wordWrap()Since version 8.3.0

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.

See listing

var wordWrap = buttons.wordWrap();

wordWrap(type)Since version 8.3.0

Setter for the word-wrap mode.

Params:

Name	Type	Description
type	anychart.enums.WordWrap \| string	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

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
zIndex	number	0	Value to set.

Returns:

anychart.core.gantt.DataGridButton - Self instance for method chaining.

Try it:

Usage sample

class anychart.core.gantt.DataGridButton Improve this Doc

Methods Overview

Methods Description

background

content

cursor

disablePointerEvents

enabled

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

hAlign

height

hovered

letterSpacing

lineHeight

normal

padding

selectable

selected

textDirection

textIndent

textOverflow

textShadow

useHtml

vAlign

width

wordBreak

wordWrap

zIndex