Array of elements transferred in the ListResponse.items property.
Specifies that list must destroy previously loaded records immediately or keep them until data request is completed.
Array of registered StateService instances.
returns true, if there is a data request executed at the moment (i.e. {@link state} is equal to {@link ProgressState.Progress})
True if the service was already destroyed via destroy call.
True if the service was already initialized via init call.
returns true, if there is no data request executed at the moment (i.e. {@link state} is NOT equal to {@link ProgressState.Progress})
Current execution status of the list.
Cancels the request executed at the moment.
Clears items array. Calls destroyAll method for items array to perform optional destroy logic of the elements. {@see destroyAll}
Performs destroy logic of the list itself and all of the inner services.
Performs initialization logic of the service. This method must be called before first use of the service.
Performs data loading by calling specified fetchMethod delegate.
result of fetchMethod execution.
Callback which is executed if fetchMethod execution finished with error.
Callback which is executed if fetchMethod execution finished successfully.
Registers passed object(s) as filter targets in underlying FiltersService to include their configured properties as parameters to the data request.
Registers passed object(s) as state service to manage the list state.
Resets paging parameters and performs data loading by calling loadData if list not in OperationStatus.Progress state.
result of fetchMethod if it was called. null otherwise.
Removes passed object(s) from state services collection of the list.
Resets the list parameters (sortings, paging, filters) to their default values.
Global settings of list..
These settings are static and their values are copied to the properties of the same name for each instance of List type.
So, changing of this settings will affect all instances of List type that will be created after such changes. If you want to change settings of concrete object you can use it the same name properties.
Generated using TypeDoc
Method for getting data. This parameter is required and its configuration is necessary.
This method get one parameter with the settings of the request implementing ListRequest contract for the simple lists and PagedListRequest one for the paged lists. The return value of this method should be any subscribable object which can be handled by AsyncSubscriber. For the simple lists the response should contain array with the records. As for the paged ones, it should implement ListResponse contract.