Options
All
  • Public
  • Public/Protected
  • All
Menu

The options used to initialize a keyselector.

Hierarchy

  • IOptions

Index

Properties

Optional default

default: ReadonlyPartialJSONValue

Default value for default setters and getters if value is not found.

Optional getter

getter: (cell: Cell<ICellModel>) => ReadonlyPartialJSONValue

Type declaration

    • An optional value getter for the selector.

      Parameters

      Returns ReadonlyPartialJSONValue

      The appropriate value for the selector.

key

key: string

The metadata key of interest.

optionValueArray

The map of values to options.

Value corresponds to the unique identifier. Option corresponds to the localizable value to display.

See: <option value="volvo">Volvo</option>

Notes

If a value equals the default, choosing it may erase the key from the metadata.

Optional setter

setter: (cell: Cell<ICellModel>, value: ReadonlyPartialJSONValue) => void

Type declaration

    • An optional value setter for the selector.

      Parameters

      • cell: Cell<ICellModel>

        The currently active cell.

      • value: ReadonlyPartialJSONValue

        The value of the selector.

        Notes

        The setter should set the appropriate metadata value given the value of the selector.

      Returns void

title

title: string

The optional title of the selector - defaults to capitalized key.

Optional validCellTypes

validCellTypes: CellType[]

The optional valid cell types - defaults to all valid types.

Generated using TypeDoc