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) => ReadonlyPartialJSONValue | undefined

An optional value getter for the selector.

param

The currently active cell.

returns

The appropriate value for the selector.

Type declaration

    • (cell: Cell): ReadonlyPartialJSONValue | undefined
    • Parameters

      Returns ReadonlyPartialJSONValue | undefined

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, value: ReadonlyPartialJSONValue | undefined) => void

An optional value setter for the selector.

param

The currently active cell.

param

The value of the selector.

Notes

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

Type declaration

    • (cell: Cell, value: ReadonlyPartialJSONValue | undefined): void
    • Parameters

      • cell: Cell
      • value: ReadonlyPartialJSONValue | undefined

      Returns void

title

title: string

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

Optional validCellTypes

validCellTypes: nbformat.CellType[]

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

Generated using TypeDoc