# Data Set Technical Reference Canonical page: https://www.adaptabletools.com/docs/technical-reference-data-set ## Data Set Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [dataSets](https://www.adaptabletools.com/docs/reference/datasetoptions.md#datasets) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md)`[]` | Collection of Data Sets to provide data to AdapTable | [] | ### Data Set Object | Property | Type | Description | Default | | --- | --- | --- | --- | | [description](https://www.adaptabletools.com/docs/reference/dataset.md#description) | `string` | Describes the Data Set | | | [form](https://www.adaptabletools.com/docs/reference/dataset.md#form) | [`AdaptableForm`](https://www.adaptabletools.com/docs/reference/adaptableform.md)`<`[`DataSetFormContext`](https://www.adaptabletools.com/docs/reference/datasetformcontext.md)`>` | Params for Data Set popup form | | | [info](https://www.adaptabletools.com/docs/reference/dataset.md#info) | `Record` | Additional info for Data Set | | | [loadData](https://www.adaptabletools.com/docs/reference/dataset.md#loaddata) | `(info: `[`DataSetSelectedInfo`](https://www.adaptabletools.com/docs/reference/datasetselectedinfo.md)`) => TData[] \| Promise` | 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](https://www.adaptabletools.com/docs/reference/dataset.md#name) | `string` | Name of Data Set | | | [onFormSubmit](https://www.adaptabletools.com/docs/reference/dataset.md#onformsubmit) | `(context: `[`DataSetFormContext`](https://www.adaptabletools.com/docs/reference/datasetformcontext.md)`) => void \| Promise` | 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](https://www.adaptabletools.com/docs/reference/dataset.md#onselect) | `(info: `[`DataSetSelectedInfo`](https://www.adaptabletools.com/docs/reference/datasetselectedinfo.md)`) => void \| Promise` | 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. | undefined | | [IsReadOnly](https://www.adaptabletools.com/docs/reference/dataset.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') | | ### Adaptable Form The form in the Data Set is defined as follows: Defines the form. `fields` is a list of fields, rows of fields, or field groups. `buttons` are the form buttons. `layout` is `rows` (the default) or `inline`. | Property | Type | Description | Default | | --- | --- | --- | --- | | [buttons](https://www.adaptabletools.com/docs/reference/adaptableform.md#buttons) | [`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`[]` | Buttons to include in the Form | | | [description](https://www.adaptabletools.com/docs/reference/adaptableform.md#description) | `string` | Additional information to appear in the Form | | | [fields](https://www.adaptabletools.com/docs/reference/adaptableform.md#fields) | `(`[`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md)` \| `[`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md)`[] \| `[`AdaptableFormFieldGroup`](https://www.adaptabletools.com/docs/reference/adaptableformfieldgroup.md)`)[]` | Collection of Dynamic Fields and Field Groups to display.

Items can be:
- a single (rendered on its own row in the
default `rows` layout, or as one cell in the `inline` layout),
- an array of (rendered side-by-side on the
same row in the `rows` layout), or
- an (a labelled section that
visually groups related fields). | | | [layout](https://www.adaptabletools.com/docs/reference/adaptableform.md#layout) | [`AdaptableFormLayout`](https://www.adaptabletools.com/docs/reference/adaptableformlayout.md) | How the form's fields are arranged on screen.

- `rows` (default): each field on its own row, label on the left and
input on the right. Suitable for popups / wizards.
- `inline`: fields are placed side-by-side on a single horizontal line,
with the label rendered immediately before its input. Designed for
compact contexts such as Dashboard Custom Toolbars where vertical
real-estate is scarce. | 'rows' | | [onSubmit](https://www.adaptabletools.com/docs/reference/adaptableform.md#onsubmit) | `(formData: TData, context: T) => void` | Optional form-level submit hook.

Fired when the user presses `Enter` while focus is inside any field
input AND the form is currently valid. The full `formData` is passed
through, typed as `TData` if you've supplied a custom shape.

Use this as an ergonomic shortcut to avoid wiring an explicit "Submit"
button - or in addition to one, so power users can press Enter to
commit. If the form is invalid the hook is not invoked. | | | [title](https://www.adaptabletools.com/docs/reference/adaptableform.md#title) | `string` | Title to appear in the Form | | Each field is an : | Property | Type | Description | Default | | --- | --- | --- | --- | | [clearToDefault](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#cleartodefault) | `boolean` | For single `select` fields only. When the user clears the combobox,
whether to restore instead of leaving the field empty.

Defaults to `true` when `defaultValue` is set, otherwise `false`.
Set to `false` when an empty selection is a distinct state from the default. | | | [defaultValue](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#defaultvalue) | `string \| boolean \| number \| Array` | Field Default Value - can be of type string, boolean, number, or for
`select` fields with `multi: true` an array of those.

For single `select` fields, this is also the value restored when the user
clears the combobox (unless is `false`). | | | [disabled](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#disabled) | `boolean \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => boolean)` | Disable the field's input. Either a boolean or a function evaluated
against the current form data. Disabled fields render but the user
cannot edit them. | | | [fieldType](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#fieldtype) | [`AdaptableFormFieldType`](https://www.adaptabletools.com/docs/reference/adaptableformfieldtype.md) | Field Type - dictates which UI control is rendered | | | [helpText](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#helptext) | `string` | Inline help text rendered immediately below the field's input. Useful
for short explanations such as "format: YYYY-MM-DD" or "min 3 chars". | | | [hidden](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#hidden) | `boolean \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => boolean)` | Hide the field. Either a boolean or a function evaluated against the
current form data. Hidden fields are not rendered and are excluded from
validation. | | | [label](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#label) | `string` | Label to display in the Field | | | [max](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#max) | `number \| string` | Maximum allowed value. For `number` and `slider`: the highest accepted
number. For `date`, `time` and `datetime`: the latest allowed value in
ISO format. | | | [maxLength](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#maxlength) | `number` | Maximum length for `text` and `textarea` fields. | | | [min](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#min) | `number \| string` | Minimum allowed value. For `number` and `slider`: the lowest accepted
number. For `date`, `time` and `datetime`: the earliest allowed value
in ISO format (`YYYY-MM-DD` / `HH:mm` / `YYYY-MM-DDTHH:mm`). | | | [minLength](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#minlength) | `number` | Minimum length for `text` and `textarea` fields. | | | [multi](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#multi) | `boolean` | For `select` fields only. When `true` the field renders as a
multi-select combobox; the field's value is an array of selected
`option.value`s rather than a single value. | false | | [name](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#name) | `string` | Name of the Field | | | [onValueChange](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#onvaluechange) | `(value: any, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => void` | Optional callback invoked whenever value of this field changes | | | [options](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#options) | [`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[] \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => `[`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[] \| Promise<`[`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[]>)` | Items to populate the `select` and `radio` fieldTypes.

Either a static array, or a function that derives the options from the
current form data and Adaptable context. The function form may return
a Promise for asynchronously-loaded options - the form will render the
field with no items until the promise resolves. | | | [pattern](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#pattern) | `string` | Regular expression that the value of a `text` field must match. | | | [placeholder](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#placeholder) | `string` | Placeholder text shown inside `text`, `textarea`, `number`, `date`,
`time` and `datetime` inputs when empty. For `select` fields it is
rendered as the empty-state label when no value is selected.

When omitted on a `select` field with a , the label of
the matching `options` entry is used as the empty-state label. | | | [render](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#render) | `(params: `[`AdaptableFormFieldRenderParams`](https://www.adaptabletools.com/docs/reference/adaptableformfieldrenderparams.md)`) => React.ReactNode` | For `custom` fields only. Renders an arbitrary React node as the
field's input. Receives the current value, a `setValue` setter
(controlled), the current form data, the Adaptable context and the
resolved `disabled` state.

Use this as an escape hatch when none of the built-in `fieldType`s
fit - e.g. to render a star-rating widget, a tag editor or any
bespoke control. | | | [required](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#required) | `boolean` | If `true` the field is treated as required. An empty value (`''`,
`null`, `undefined`, or unchecked checkbox) will produce a validation
error. | | | [rows](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#rows) | `number` | For `textarea` fields: the visible number of text rows. | 3 | | [step](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#step) | `number` | Stepping interval for `number`, `slider`, `time` and `datetime`
fields. | | | [tooltip](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#tooltip) | `string` | Tooltip shown when hovering the field's label. | | | [validate](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#validate) | `(value: any, formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => string \| null \| undefined` | Custom field-level validation. Return an error message string to mark
the field invalid, or `null`/`undefined` if the value is valid.

Custom validation runs *after* built-in checks (`required`, `min`,
`max`, `pattern`, etc.) - the first failing check wins. | | `fieldType` is an : [See API: adaptableformfieldtype](https://www.adaptabletools.com/docs/reference/adaptableformfieldtype.md) Select and radio `options` are objects: | Property | Type | Description | | --- | --- | --- | | [label](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md#label) | `string` | Text shown for this choice. | | [value](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md#value) | `any` | Value written into the form data when this choice is selected. | `layout` is an : [See API: adaptableformlayout](https://www.adaptabletools.com/docs/reference/adaptableformlayout.md) `buttons` are objects: | Property | Type | Description | Default | | --- | --- | --- | --- | | [buttonStyle](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#buttonstyle) | [`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)`)` | Style for Button - can be object or function that provides a `ButtonStyle` object | | | [disabled](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#disabled) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function that disables / enables the button based on its evaluation result | | | [hidden](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#hidden) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function which sets whether Button is hidden | | | [icon](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)`)` | Icon for Button - can be object or function that provides a `AdaptableIcon` object | | | [iconPosition](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#iconposition) | `'start' \| 'end'` | Where the icon appears relative to the label | 'start' | | [label](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#label) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Label for Button - can be string or function that provides string | | | [onClick](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#onclick) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => void` | Function to invoke when button is clicked | | | [tooltip](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#tooltip) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Tooltip for Button - can be string or function that provides string | | `buttonStyle` is a : | Property | Type | Description | Default | | --- | --- | --- | --- | | [className](https://www.adaptabletools.com/docs/reference/buttonstyle.md#classname) | `string` | CSS Classname to use for the Button | | | [tone](https://www.adaptabletools.com/docs/reference/buttonstyle.md#tone) | `'success' \| 'error' \| 'neutral' \| 'none' \| 'warning' \| 'info' \| 'accent'` | Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent' | 'neutral' | | [variant](https://www.adaptabletools.com/docs/reference/buttonstyle.md#variant) | `'text' \| 'outlined' \| 'raised'` | How Button appears - values: 'text', 'outlined', 'raised' | 'outlined' | `form` and `onFormSubmit` receive a [`DataSetFormContext`](https://www.adaptabletools.com/docs/reference/datasetformcontext.md): | Property | Type | Description | | --- | --- | --- | | [dataSet](https://www.adaptabletools.com/docs/reference/datasetformcontext.md#dataset) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md) | The DataSet which triggered the Form | | [adaptableContext](https://www.adaptabletools.com/docs/reference/datasetformcontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | --- ## Data Set API | Method | Returns | Description | | --- | --- | --- | | [clearCurrentDataSet()](https://www.adaptabletools.com/docs/reference/datasetapi.md#clearcurrentdataset) | `void` | Clears currently selected Data Set | | [getCurrentDataSet()](https://www.adaptabletools.com/docs/reference/datasetapi.md#getcurrentdataset) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md)` \| undefined` | Retrieves the currently applied Data Set | | [getDataSetByName(dataSetName)](https://www.adaptabletools.com/docs/reference/datasetapi.md#getdatasetbyname) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md) | Retrieves Data Set from State with given name | | [getDataSets()](https://www.adaptabletools.com/docs/reference/datasetapi.md#getdatasets) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md)`[]` | Retrieves the Data Sets from Data Set Options | | [openDataSetSettingsPanel()](https://www.adaptabletools.com/docs/reference/datasetapi.md#opendatasetsettingspanel) | `void` | Opens Settings Panel with Data Set section selected and visible | | [setDataSet(dataSetName)](https://www.adaptabletools.com/docs/reference/datasetapi.md#setdataset) | `void` | Loads the given Data Set (makes it the Current one) | --- ## DataSet Selected Event The DataSet Selector provides a way to supply an entirely new Data Set to AdapTable based on user selection. This Event is only fired if the DataSet definition **does not** contain a Form If the DataSet contains a Form, any wiring should be done in the `onClick` of the form's submit [Button](https://www.adaptabletools.com/docs/ui-tutorial-displaying-adaptable-buttons/index.md) ### DataSetSelectedInfo The [`DatasetSelectedInfo`](https://www.adaptabletools.com/docs/reference/datasetselectedinfo.md) object returned by the Event contains the DataSet that has been selected: | Property | Type | Description | | --- | --- | --- | | [dataSet](https://www.adaptabletools.com/docs/reference/datasetselectedinfo.md#dataset) | [`DataSet`](https://www.adaptabletools.com/docs/reference/dataset.md) | Data Set that was selected. | | [adaptableContext](https://www.adaptabletools.com/docs/reference/datasetselectedinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | ### Event Subscription Subscribing to the Event is done the same way as with all [Adaptable Events](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md): ```ts api.eventApi.on('DataSetSelected', (eventInfo: DataSetSelectedInfo) => { // do something with the info }); ``` ---