DataSet
Defines a Data Set object that can provide data to AdapTable
export interface DataSet<TData = any> extendsExtends
Properties
| Property | Type | Description | Default |
|---|---|---|---|
| description | string | Describes the Data Set | |
| form | AdaptableForm<DataSetFormContext> | Params for Data Set popup form | |
| info | Record<string, string | number | boolean | Date> | Additional info for Data Set | |
| loadData | (info:DataSetSelectedInfo) => TData[] | Promise<TData[]> | Optional shortcut that loads row data into the Grid when this Data Set is selected (only when no form is defined). Runs before onSelect. | undefined |
| name | string | Name of Data Set | |
| onFormSubmit | (context:DataSetFormContext) => void | Promise<void> | Invoked when the user submits the Data Set form (Enter key or form button). When no form buttons are defined, an OK button is added automatically. | undefined |
| onSelect | (info:DataSetSelectedInfo) => void | Promise<void> | Invoked when this Data Set is selected and it does not define a form. | undefined |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
description
Describes the Data Set
description: string;Property Value
string
form
Params for Data Set popup form
form?: AdaptableForm<DataSetFormContext>;Property Value
AdaptableForm<DataSetFormContext>
info
Additional info for Data Set
info?: Record<string, string | number | boolean | Date>;Property Value
Record<string, string | number | boolean | Date>
loadData
Optional shortcut that loads row data into the Grid when this Data Set is selected (only when no form is defined). Runs before onSelect.
loadData?: (info: DataSetSelectedInfo) => TData[] | Promise<TData[]>;Default Value
undefined
Property Value
(info:DataSetSelectedInfo) => TData[] | Promise<TData[]>
name
Name of Data Set
name: string;Property Value
string
onFormSubmit
Invoked when the user submits the Data Set form (Enter key or form button). When no form buttons are defined, an OK button is added automatically.
onFormSubmit?: (context: DataSetFormContext) => void | Promise<void>;Default Value
undefined
Property Value
(context:DataSetFormContext) => void | Promise<void>
onSelect
Invoked when this Data Set is selected and it does not define a form.
Use for custom loading logic (e.g. server requests). The DataSetSelected event is still fired for backward compatibility.
onSelect?: (info: DataSetSelectedInfo) => void | Promise<void>;Default Value
undefined
Property Value
(info:DataSetSelectedInfo) => void | Promise<void>
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean