NamedQueryApi
Provides run-time access to Named Queries
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| addNamedQueries(namedQueries) | Adds multiple new Named Query to Adaptable State |
| addNamedQuery(namedQueries) | Adds a new Named Query to Adaptable State |
| getNamedQueries() | Gets all Named Queries in Adaptable State |
| getNamedQueryByName(namedQueryName) | Retrieves Named Query with given name from State |
| getNamedQueryState() | Retrieves Query section from Adaptable State |
| isValidNamedQuery(namedQuery) | Checks if the given Named Query has a valid name |
| openNamedQuerySettingsPanel() | Opens Settings Panel with Query section selected and visible |
| runNamedQuery(namedQuery) | Runs the given Named Query |
| runQueryByName(queryName) | Runs Named Query which has given name |
Method Details
addNamedQueries
Adds multiple new Named Query to Adaptable State
TypeScript
addNamedQueries(namedQueries: NamedQuery[]): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| namedQueries | NamedQuery[] |
Returns
void
addNamedQuery
Adds a new Named Query to Adaptable State
TypeScript
addNamedQuery(namedQueries: NamedQuery): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| namedQueries | NamedQuery |
Returns
void
getNamedQueries
Gets all Named Queries in Adaptable State
TypeScript
getNamedQueries(): NamedQuery[];Returns
getNamedQueryByName
Retrieves Named Query with given name from State
TypeScript
getNamedQueryByName(namedQueryName: string): NamedQuery | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| namedQueryName | string | Name of Named Query |
Returns
NamedQuery | undefined
getNamedQueryState
Retrieves Query section from Adaptable State
TypeScript
getNamedQueryState(): NamedQueryState;Returns
isValidNamedQuery
Checks if the given Named Query has a valid name
TypeScript
isValidNamedQuery(namedQuery: NamedQuery): NamedQueryValidationResult;Parameters
| Parameter | Type |
|---|---|
| namedQuery | NamedQuery |
Returns
NamedQueryValidationResult
openNamedQuerySettingsPanel
Opens Settings Panel with Query section selected and visible
TypeScript
openNamedQuerySettingsPanel(): void;Returns
void
runNamedQuery
Runs the given Named Query
TypeScript
runNamedQuery(namedQuery: NamedQuery): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| namedQuery | NamedQuery | Query to Run |
Returns
void
runQueryByName
Runs Named Query which has given name
TypeScript
runQueryByName(queryName: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| queryName | string | Name of Named Query |
Returns
void