Top
You are looking at an outdated 7.1.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.ui.Paginator Improve this Doc

Extends: anychart.elements.Text

Paginator base class.

Methods Overview

Miscellaneous
background()Paginator background.
currentPage()Getter for active page.
draw()Draws paginator.
layout()Getter for paginator layout.
margin()Paginator margin.
orientation()Orientation of the paginator.
padding()Paginator padding.
pageCount()Getter for page count.
parentBounds()Bounds of paginator parent element. Need to calculate percent-values of width, height.

Methods Description

background

Paginator background.

Params:

Name Type Description
value anychart.elements.Background | Object | string | null .

currentPage

Getter for active page.

Returns:

number - Current page.
Setter for active page.

Params:

Name Type Description
value number | string Value to set.

Returns:

anychart.ui.Paginator - An instance of the anychart.ui.Paginator class for method chaining.

draw

Draws paginator.

Returns:

anychart.ui.Paginator - Self or chaining.

layout

Getter for paginator layout.

Returns:

anychart.enums.Layout - Current layout or self for chaining.
Setter for paginator layout.

Params:

Name Type Description
value string | anychart.enums.Layout Value to set.

Returns:

anychart.ui.Paginator - An instance of the anychart.ui.Paginator class for method chaining.

margin

Paginator margin.

Params:

Name Type Description
spaceOrTopOrTopAndBottom string | number | anychart.utils.Space Space object or top or top and bottom space.
rightOrRightAndLeft string | number Right or right and left space.
bottom string | number Bottom space.
left string | number Left space.

Returns:

anychart.ui.Paginator anychart.utils.Margin - Padding or self for chaining.

orientation

Orientation of the paginator.

Params:

Name Type Description
value anychart.enums.Orientation | string .

padding

Paginator padding.

Params:

Name Type Description
spaceOrTopOrTopAndBottom string | number | anychart.utils.Space Space object or top or top and bottom space.
rightOrRightAndLeft string | number Right or right and left space.
bottom string | number Bottom space.
left string | number Left space.

Returns:

anychart.ui.Paginator anychart.utils.Padding - Padding or self for chaining.

pageCount

Getter for page count.

Returns:

number - Current page count.
Setter for page count.

Params:

Name Type Description
value number | string Value to set.

Returns:

anychart.ui.Paginator - An instance of the anychart.ui.Paginator class for method chaining.

parentBounds

Bounds of paginator parent element. Need to calculate percent-values of width, height.

Params:

Name Type Description
value anychart.math.Rect Parent bounds.

Returns:

anychart.math.Rect anychart.ui.Paginator - Bounds of parent element or self for chaining.