Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

The options used to initialize a keyselector.

Hierarchy

  • IOptions

Index

Properties

Properties

Optional default

default: JSONValue

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

Optional getter

getter: function

An optional value getter for the selector.

param

The currently active cell.

returns

The appropriate value for the selector.

Type declaration

    • (cell: Cell): JSONValue

    • Parameters

      • cell: Cell

      Returns JSONValue

key

key: string

The metadata key of interest.

optionsMap

optionsMap: object

The map of options to values.

Notes

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

Type declaration

  • [key: string]: JSONValue

Optional setter

setter: function

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: JSONValue): void

    • Parameters

      • cell: Cell
      • value: JSONValue

      Returns void

Optional 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