The page of data rows currently being displayed in the table
Returns the number of data rows per page
Sets the number of data rows per page.
Changes to count will cause isDataReloadRequired to return true
Returns the current filter values used to restrict the set of data rows.
supply true to return the current filter minus any insignificant values (null, undefined and empty string)
Sets filter values to the filter supplied; any existing filter will be removed
Changes to filter will cause isDataReloadRequired to return true and the current page to be set to 1
Generate array of pages.
When no arguments supplied, the current parameter state of this NgTableParams instance will be used
Which page must be active
Total quantity of items
Quantity of items on page
Quantity of blocks for pagination
Array of pages
Returns the current grouping used to group the data rows
Sets grouping to the group supplied; any existing grouping will be removed.
Changes to group will cause isDataReloadRequired to return true and the current page to be set to 1
Sets grouping to the field and sortDirection supplied; any existing grouping will be removed
Changes to group will cause isDataReloadRequired to return true and the current page to be set to 1
Sets grouping to the group supplied; any existing grouping will be removed.
If sortDirection is supplied, this will be assigned to the sortDirection property of group
Changes to group will cause isDataReloadRequired to return true and the current page to be set to 1
Returns true when an attempt to reload the current parameter values have resulted in a failure.
This method will continue to return true until the reload is successfully called or when the
parameter values have changed
Returns true if filter has significant filter value(s) (any value except null, undefined, or empty string),
otherwise false
Return true when a change to filters require the reload method
to be run so as to ensure the data presented to the user reflects these filters
Returns true when at least one group has been set
Returns true when the group and when supplied, the sortDirection matches an existing group
Return true when a change to this instance should require the reload method
to be run so as to ensure the data rows presented to the user reflects the current state.
Note that this method will return false when the reload method has run but fails. In this case
hasErrorState will return true.
The built-in ngTable directives will watch for when this function returns true and will then call
the reload method to load its data rows
Returns true if sorting by the field supplied. Where direction supplied the field must also be sorted by that direction to return true
Returns sorting values in a format that can be consumed by the angular $orderBy filter service
Returns the index of the current "slice" of data rows
Sets the index of the current "slice" of data rows. The index starts at 1.
Changing the page number will cause isDataReloadRequired to return true
Set new parameters
Trigger a reload of the data rows
Returns the settings for the table.
Sets the settings for the table; new setting values will be merged with the existing settings.
Supplying a new dataset will cause isDataReloadRequired to return true and the ngTableEventsChannel
to fire its datasetChanged event
Returns the current sorting used to order the data rows.
Changes to sorting will cause isDataReloadRequired to return true
Sets sorting values to the sorting supplied; any existing sorting will be removed.
Changes to sorting will cause isDataReloadRequired to return true
Sets sorting to the field and direction supplied; any existing sorting will be removed
Returns the count of the data rows that match the current filter
Sets settings().total to the value supplied.
Typically you will need to set a total in the body of any custom getData function
you supply as a setting value to this instance.
Returns the current parameter values uri-encoded. Set asString to
true for the parameters to be returned as an array of strings of the form 'paramName=value'
otherwise parameters returned as a key-value object
Generated using TypeDoc