GridFilterApi
Provides run-time access to Grid Filter section of Adaptable State.
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| clearGridFilter() | Clears the Grid Filter (for the current Layout) |
| getCurrentGridFilter() | Retrieves the Grid Filter from the current Layout |
| getCurrentGridFilterExpression() | Retrieves the Grid Filter's Expression from the current layout |
| openUIEditorForGridFilter(expression) | Opens the AdapTableQL UI Components (Expression Editor & Query Builder) |
| reApplyGridFilter() | Re-applies the Grid Filter |
| setGridFilterExpression(expression) | Sets the Grid Filter (for the current layout) |
| setGridFilterExpressionUsingNamedQuery(namedQuery) | Sets the Grid Filter (for the current layout) |
| suspendGridFilter() | Suspends the Grid Filter |
| unSuspendGridFilter() | Unsuspends the Grid Filter |
Method Details
clearGridFilter
Clears the Grid Filter (for the current Layout)
TypeScript
clearGridFilter(): void;Returns
void
getCurrentGridFilter
Retrieves the Grid Filter from the current Layout
TypeScript
getCurrentGridFilter(): GridFilter | undefined;Returns
GridFilter | undefined
getCurrentGridFilterExpression
Retrieves the Grid Filter's Expression from the current layout
TypeScript
getCurrentGridFilterExpression(): string | undefined;Returns
string | undefined
openUIEditorForGridFilter
Opens the AdapTableQL UI Components (Expression Editor & Query Builder)
TypeScript
openUIEditorForGridFilter(expression?: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| expression | string | current Grid Filter expression |
Returns
void
reApplyGridFilter
Re-applies the Grid Filter
TypeScript
reApplyGridFilter(): void;Returns
void
setGridFilterExpression
Sets the Grid Filter (for the current layout)
TypeScript
setGridFilterExpression(expression: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| expression | string | filter string |
Returns
void
setGridFilterExpressionUsingNamedQuery
Sets the Grid Filter (for the current layout)
TypeScript
setGridFilterExpressionUsingNamedQuery(namedQuery: NamedQuery): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| namedQuery | NamedQuery | : NamedQuery to use |
Returns
void
suspendGridFilter
Suspends the Grid Filter
TypeScript
suspendGridFilter(): void;Returns
void
unSuspendGridFilter
Unsuspends the Grid Filter
TypeScript
unSuspendGridFilter(): void;Returns
void