AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.Paginator Improve this Doc

Extends: anychart.core.Text

Class for a paginator element.
The Paginator class contains methods for configuring the Legend paginator.

Methods Overview

Specific settings
currentPage()Active page.
getPagesCount()Returns current paginator pages count.
Advanced Text Settings
fontVariant()Font variant settings.
letterSpacing()Text letter spacing settings.
textDirection()Text direction settings.
textIndent()Text indent settings.
textOverflow()Text overflow settings.
useHtml()Text useHtml settings.
wordBreak()Word break mode.
wordWrap()Word-wrap mode.
Base Text 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.
fontWeight()Font weight settings.
hAlign()Text horizontal align settings.
lineHeight()Text line height settings.
vAlign()Text vertical align settings.
Coloring
background()Background settings
Events
disablePointerEvents()Pointer events settings.
Interactivity
enabled()Element state (enabled or disabled).
selectable()Text selectable option.
Size and Position
layout()Layout settings.
margin()Margin settings
orientation()Paginator orientation
padding()Padding settings
zIndex()Z-index of the element.
Text Settings
textSettings()Text settings.

Methods Description

background

Getter for the paginator background.

Returns:

anychart.core.ui.Background - Returns the paginator background.
See listing
var paginator = chart.legend().paginator();
var background = paginator.background();
Setter for the paginator background.

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

currentPage

Getter for the active page.

Returns:

number - Active page number.
See listing
var paginator = chart.legend().paginator();
var currentPage = paginator.currentPage();
Setter for the active page.

Params:

NameTypeDescription
pageNumbernumber | stringActive page number to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

disablePointerEvents

Getter for the pointer events.

Returns:

boolean - Flag of the state.
Setter for the pointer events.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fontColor

Getter for the text font color.

Returns:

string - Font color.
Setter for the text font color.
https://www.w3schools.com/html/html_colors.asp

Params:

NameTypeDefaultDescription
colorstring
'#7c868e'
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.
Setter for the text font decoration.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Decoration | string
'none'
Font decoration to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontFamily

Getter for the font family.

Returns:

string - Font family.
Setter for the font family.

Params:

NameTypeDefaultDescription
familystring
'Verdana', Helvetica, Arial, sans-serif
Font family to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontOpacity

Getter for the text font opacity.

Returns:

number - Font opacity.
Setter for the text font opacity. Double value from 0 to 1.

Params:

NameTypeDefaultDescription
opacitynumber
1
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontSize

Getter for the text font size.

Returns:

string | number - Font size.
Setter for the text font size.

Params:

NameTypeDefaultDescription
sizestring | number
16
Font size to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.
Setter for the text font style.

Params:

NameTypeDefaultDescription
styleanychart.graphics.vector.Text.FontStyle | string
'normal'
Font style to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.
Setter for the text font variant.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontVariant | string
'normal'
Font variant to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

fontWeight

Getter for the text font weight.

Returns:

string | number - Font weight.

Params:

NameTypeDefaultDescription
weightstring | number
'normal'
Font weight to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

getPagesCount

Returns current paginator pages count.
The getPagesCount() method should be used after drawing a chart.

Returns:

number - Paginator pages count.

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.
Setter for the text horizontal align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.HAlign | string
'start'
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

layout

Getter for paginator layout.

Returns:

anychart.enums.Layout | string - Returns paginator layout.
See listing
var paginator = chart.legend().paginator();
var layout = paginator.layout();
Setter for paginator layout.

Params:

NameTypeDescription
valueanychart.enums.Layout | stringValue to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

letterSpacing

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.

Params:

NameTypeDefaultDescription
spacingstring | number
'normal'
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

lineHeight

Getter for the text line height.

Returns:

string | number - Text line height.

Params:

NameTypeDefaultDescription
heightstring | number
'normal'
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

margin

Getter for the paginator margin.

Returns:

anychart.core.utils.Margin - Padding settings.
Setter for the paginator margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Margin to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.
Example.
// all margins 15px
paginator.margin(15);
// all margins 15px
paginator.margin('15px');
// top and bottom 5px, right and left 15px
paginator.margin(anychart.utils.margin(5, 15));
Setter for the paginator margin in pixels using several simple values.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.
Example.
// 1) all 10px
paginator.margin(10);
// 2) top and bottom 10px, left and right 15px
paginator.margin(10, '15px');
// 3) top 10px, left and right 15px, bottom 5px
paginator.margin(10, '15px', 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, '15px', '5px', 12);

orientation

Getter for the paginator orientation.

Returns:

anychart.enums.Orientation | string - Returns the paginator orientation.
See listing
var paginator = chart.legend().paginator();
var orientation = paginator.orientation();
Setter for the paginator orientation.

Params:

NameTypeDescription
orientationanychart.enums.Orientation | stringOrientation to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

padding

Getter for the paginator padding.

Returns:

anychart.core.utils.Padding - Padding instance.
Setter for the paginator padding in pixels using a single value.

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object | number | string
{top: 7, right: 7, bottom: 7, left: 7}
Space value, object or array.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.
Setter for the paginator padding setting in pixels using a several values.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

selectable

Getter for the text selectable option.

Returns:

boolean - The text selectable option.
Setter for the text selectable.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

textDirection

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.
Setter for the text direction.

Params:

NameTypeDefaultDescription
directionanychart.graphics.vector.Text.Direction | string
'ltr'
Text direction to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

textIndent

Getter for the text indent.

Returns:

number - Text indent.
Setter for the text indent.

Params:

NameTypeDefaultDescription
indentnumber
0
Text indent to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.
See listing
var title = chart.title();
var textOverflow = title.textOverflow();
Setter for the text overflow settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextOverflow | string
""
Text overflow settings to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

textSettings

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.
Getter for all text appearance settings.

Params:

NameTypeDescription
namestringSetting name.

Returns:

string | number | boolean | undefined - Value of settings.
Setter for text appearance settings.

Params:

NameTypeDescription
objectWithSettingsObjectSettings object. Complete object looks like this:
   {
     'fontSize': smth,
     'fontFamily': smth,
     'fontColor': smth,
     'fontOpacity': smth,
     'fontDecoration': smth,
     'fontStyle': smth,
     'fontVariant': smth,
     'fontWeight': smth,
     'letterSpacing': smth,
     'textDirection': smth,
     'lineHeight': smth,
     'textIndent': smth,
     'vAlign': smth,
     'hAlign': smth,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.
Setter for the text appearance settings.

Params:

NameTypeDescription
namestringSetting name.
settingsstring | number | boolean | functionText settings.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

useHtml

Getter for the useHTML flag.

Returns:

boolean - Value of useHTML flag.
Setter for flag useHTML.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.
Setter for the text vertical align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.VAlign | string
'top'
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

wordBreak

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.
Setter for the word-break mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordBreak | string
"normal"
Word-break mode to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

wordWrap

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.
Setter for the word-wrap mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordWrap | string
'normal'
Word-wrap mode to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.core.ui.Paginator - Self instance for method chaining.