Queries hooks
This is the collection of queries hooks within the ui-react module. There are 21 queries hooks in total.
useResultTable
The useResultTable hook returns an object containing the entire data of the ResultTable of the given query, and registers a listener so that any changes to that result will cause a re-render.
useResultTableCellIds
The useResultTableCellIds hook returns the Ids of every Cell used across the whole ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.
useResultTableCellIdsListener
The useResultTableCellIdsListener hook registers a listener function with a Queries object that will be called whenever the Cell Ids that appear anywhere in a ResultTable change.
useResultTableListener
The useResultTableListener hook registers a listener function with a Queries object that will be called whenever data in a ResultTable changes.
useResultRowIds
The useResultRowIds hook returns the Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.
useResultRowIdsListener
The useResultRowIdsListener hook registers a listener function with a Queries object that will be called whenever the Row Ids in a ResultTable change.
useResultSortedRowIds
The useResultSortedRowIds hook returns the sorted (and optionally, paginated) Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.
useResultSortedRowIdsListener
The useResultSortedRowIdsListener hook registers a listener function with a Queries object that will be called whenever the sorted (and optionally, paginated) Row Ids in a ResultTable change.
useResultRow
The useResultRow hook returns an object containing the data of a single Row in the ResultTable of the given query, and registers a listener so that any changes to that Row will cause a re-render.
useResultRowCount
The useResultRowCount hook returns the count of the Row objects in the ResultTable of the given query, and registers a listener so that any changes to that result will cause a re-render.
useResultRowCountListener
The useResultRowCountListener hook registers a listener function with a Queries object that will be called whenever the count of ResultRow objects in a ResultTable changes.
useResultRowListener
The useResultRowListener hook registers a listener function with a Queries object that will be called whenever data in a result Row changes.
useResultCellIds
The useResultCellIds hook returns the Ids of every Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause a re-render.
useResultCellIdsListener
The useResultCellIdsListener hook registers a listener function with a Queries object that will be called whenever the Cell Ids in a result Row change.
useResultCell
The useResultCell hook returns the value of a single Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to that value will cause a re-render.
useResultCellListener
The useResultCellListener hook registers a listener function with a Queries object that will be called whenever data in a Cell changes.
useCreateQueries
The useCreateQueries hook is used to create a Queries object within a React application with convenient memoization.
useQueries
The useQueries hook is used to get a reference to a Queries object from within a Provider component context.
useQueriesIds
The useQueriesIds hook is used to retrieve the Ids of all the named Queries objects present in the current Provider component context.
useQueriesOrQueriesById
The useQueriesOrQueriesById hook is used to get a reference to a Queries object from within a Provider component context, or have it passed directly to this hook.
useQueryIds
The useQueryIds hook gets an array of the Query Ids registered with a Queries object, and registers a listener so that any changes to that result will cause a re-render.