DataProvider.Pagination (DataProvider v1.2.1) View Source

Pagination module provides struct with actual pagination data for current DataProvider

Fields

page - Current page of this data provider, by default equal 1. This value is dynamic, and can be changed in runtime.
params - Pagination params. This field contain DataProvider.Pagination.Params struct and uses for configuring inner logic of DataProvider.Pagination and/or DataProvider
pages - List of values for fast move between pages. Every single page it is DataProvider.Pagination.Page struct and this list sensitive for specific params, which used in his creation. This field most useful when you need to render list of pages under data table. More details you can find in DataProvider.Pagination.Params and DataProvider.Pagination.Params.

Link to this section Summary

Types

t()

Schema of DataProvider.Pagination.

Functions

create(params \\ %{})

Creates new DataProvider.Pagination struct with received params.

create_page_list(pagination, total_count \\ 0)

Creates list of DataProvider.Pagination.Page by received total count and current page.

end_position(pagination)

Calculates end position for received pagination.

page(pagination)

Returns current page value of DataProvider by DataProvider.Pagination

put_page(pagination, page)

Changes the value of field page

put_params(schema, params)

Changes the value of field page_size

selection_limit(pagination)

Returns count of items, which gonna be put load into DataProvider.Data

start_position(pagination)

Calculates starting position for received pagination.

Link to this section Types

t()

Specs

t() :: %DataProvider.Pagination{
  page: integer(),
  pages: [DataProvider.Pagination.Page.t()],
  params: DataProvider.Pagination.Params.t()
}

Schema of DataProvider.Pagination.

Contains:

page - Current page of dataprovider.
pages - Pages which loaded for current pagination
page_size - count of items in one page of data provider.

Link to this section Functions

create(params \\ %{})

Specs

create(map()) :: t()

Creates new DataProvider.Pagination struct with received params.

create_page_list(pagination, total_count \\ 0)

Specs

create_page_list(t(), integer()) :: t()

Creates list of DataProvider.Pagination.Page by received total count and current page.

Arguments

DataProvider.Pagination struct
Total count of items

Returns

Function returns DataProvider.Pagination which :pages field is fill

%DataProvider.Pagination{
  ...
  pages: [
    ...
    %DataProvider.Pagination.Page{},
    %DataProvider.Pagination.Page{},
    %DataProvider.Pagination.Page{},
    ...
  ]
  ...
}

Options

Options, that can affect result of this function

:pages_ahead - The maximum count of pages, which will be loaded ahead of current position.

:pages_behind - The maximum count of pages, which will be loaded behind of current position.

:load_first_page? - Boolean value which indicates requirement of loading the first page in list.

:load_last_page? - Boolean value which indicates requirement of loading the last page in list.

:load_opening_separator? - Boolean value which indicates requirement of loading the separator page in list.

:load_closing_separator? - Boolean value which indicates requirement of loading the separator page in list.

end_position(pagination)

Specs

end_position(t()) :: integer()

Calculates end position for received pagination.

Requires for calculating selection limit in list of data.

page(pagination)

Specs

page(t()) :: integer()

Returns current page value of DataProvider by DataProvider.Pagination

put_page(pagination, page)

Specs

put_page(t(), integer()) :: t()

Changes the value of field page

put_params(schema, params)

Specs

put_params(t(), map()) :: t()

Changes the value of field page_size

selection_limit(pagination)

Specs

selection_limit(t()) :: integer()

Returns count of items, which gonna be put load into DataProvider.Data

start_position(pagination)

Specs

start_position(t()) :: integer()

Calculates starting position for received pagination.

Requires for calculating start position in list of data or offset in query condition