ApplicationApi
Provides run-time access to the Application Module
TypeScript
export interfaceMethods
| Method | Returns | Description |
|---|---|---|
| addApplicationDataEntry(applicationDataEntry) | void | Adds new Application Data Entry |
| createApplicationDataEntry(key, value) | void | Creates new Application Data Entry with given Key and Value |
| deleteApplicationDataEntry(applicationDataEntry) | void | Deletes given Application Data Entry |
| editApplicationDataEntry(applicationDataEntry) | void | Edits given Application Data Entry |
| getApplicationDataEntries() | ApplicationDataEntry[] | Retrieves all Key Value Pairs in Application state |
| getApplicationDataEntriesByValue(value) | ApplicationDataEntry[] | Gets Application Data Entry with given value |
| getApplicationDataEntryByKey(key) | ApplicationDataEntry | undefined | Gets Application Data Entry with given key |
| getApplicationState() | ApplicationState | Retrieves Application section from Adaptable State |
Method Details
addApplicationDataEntry
Adds new Application Data Entry
TypeScript
addApplicationDataEntry(applicationDataEntry: ApplicationDataEntry): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| applicationDataEntry | ApplicationDataEntry | Application Data Entry to add |
Returns
void
createApplicationDataEntry
Creates new Application Data Entry with given Key and Value
TypeScript
createApplicationDataEntry(key: string, value: any): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | the Application Data Entry key |
| value | any | the Application Data Entry value |
Returns
void
deleteApplicationDataEntry
Deletes given Application Data Entry
TypeScript
deleteApplicationDataEntry(applicationDataEntry: ApplicationDataEntry): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| applicationDataEntry | ApplicationDataEntry | Application Data Entry to delete |
Returns
void
editApplicationDataEntry
Edits given Application Data Entry
TypeScript
editApplicationDataEntry(applicationDataEntry: ApplicationDataEntry): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| applicationDataEntry | ApplicationDataEntry | Application Data Entry to edit |
Returns
void
getApplicationDataEntries
Retrieves all Key Value Pairs in Application state
TypeScript
getApplicationDataEntries(): ApplicationDataEntry[];Returns
getApplicationDataEntriesByValue
Gets Application Data Entry with given value
TypeScript
getApplicationDataEntriesByValue(value: any): ApplicationDataEntry[];Parameters
| Parameter | Type | Description |
|---|---|---|
| value | any | the Value of the Application Data Entry to retrieve |
Returns
getApplicationDataEntryByKey
Gets Application Data Entry with given key
TypeScript
getApplicationDataEntryByKey(key: string): ApplicationDataEntry | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | the Key of the Application Data Entry to retrieve |
Returns
ApplicationDataEntry | undefined
getApplicationState
Retrieves Application section from Adaptable State
TypeScript
getApplicationState(): ApplicationState;