Skip to main content

IkasCategoryList

Refer to the IkasCategory reference.

Refer to the IkasCategoryListSortType reference.

limitnumber

Page size limit for pagination.

pagenumber

Currently displayed page number.

countnumber

Total data count.

pageCountnumber

Total page count.

isInitializedboolean

true if the list is initalized and first page of data is fetched, false otherwise.

isStaticboolean
hasPrevboolean

true if there is a previous page available for pagination, false otherwise.

hasNextboolean

true if there is a next page available for pagination, false otherwise.

isLoadingboolean
getPrevfunction
Function to get the previous page data with pagination. Generally being used for infinite scrolls. This function updates the data array.
function getPrev(): Promise<void>
getNextfunction
Function to get the next page data with pagination. Generally being used for infinite scrolls. This function updates the data array.
function getNext(): Promise<void>
getPagefunction
Function to get page data for the specified page. Generally being used with page based paginations, rather than infinite scrolls. This function updates the data array.
function getPage(page: number): Promise<void>
page
:
number
The requested page number.
setSortTypefunction
function setSortType(sortType: IkasCategoryListSortType): Promise<void>
sortType
:
IkasCategoryListSortType
New sort type
toJSONfunction
function toJSON(): { data: IkasCategory[]; type: IkasCategoryListType; sort: IkasCategoryListSortType; limit: number; page: number; count: number; initialized: boolean; minPage: number | ... 1 more ... | undefined; categoryListPropValue: IkasCategoryListPropValue;}