DataSetApi
Provides run-time access to Data Sets
TypeScript
export interfaceMethods
| Method | Returns | Description |
|---|---|---|
| clearCurrentDataSet() | void | Clears currently selected Data Set |
| getCurrentDataSet() | DataSet | undefined | Retrieves the currently applied Data Set |
| getDataSetByName(dataSetName) | DataSet | Retrieves Data Set from State with given name |
| getDataSets() | DataSet[] | Retrieves the Data Sets from Data Set Options |
| openDataSetSettingsPanel() | void | Opens Settings Panel with Data Set section selected and visible |
| setDataSet(dataSetName) | void | Loads the given Data Set (makes it the Current one) |
Method Details
clearCurrentDataSet
Clears currently selected Data Set
TypeScript
clearCurrentDataSet(): void;Returns
void
getCurrentDataSet
Retrieves the currently applied Data Set
TypeScript
getCurrentDataSet(): DataSet | undefined;Returns
DataSet | undefined
getDataSetByName
Retrieves Data Set from State with given name
TypeScript
getDataSetByName(dataSetName: string): DataSet;Parameters
| Parameter | Type | Description |
|---|---|---|
| dataSetName | string | name of Data Set to retrieve |
Returns
getDataSets
Retrieves the Data Sets from Data Set Options
TypeScript
getDataSets(): DataSet[];Returns
DataSet[]
openDataSetSettingsPanel
Opens Settings Panel with Data Set section selected and visible
TypeScript
openDataSetSettingsPanel(): void;Returns
void
setDataSet
Loads the given Data Set (makes it the Current one)
TypeScript
setDataSet(dataSetName: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| dataSetName | string | Name of Data Set to load |
Returns
void