Interface CellEditorProps<CT, DT>

interface CellEditorProps<CT, DT> {
    containerBounds?: Bounds;
    defaultTextStyle?: TextStyle;
    disabled?: boolean;
    editState?: EditState<CT, DT>;
    useRichStyling?: boolean;
    zoom?: number;
    onCancelEdit?(): void;
    onChangeEdit?(editState): void;
    onDoneEdit?(): void;
    onNavigate?(direction, select?, contentful?): void;
    onNavigateSelection?(direction): void;
    onStartEdit?(editState): void;
    onSubmitEdit?(editState): void;
    setNaturalSize?(size): void;
}

Type Parameters

CT
DT

Hierarchy (view full)

HTMLAttributes<HTMLElement>
Attributes
- CellEditorProps
  - StringCellEditorProps
  - SheetCellEditorProps

Index

Properties

containerBounds? defaultTextStyle? disabled? editState? useRichStyling? zoom?

Methods

onCancelEdit? onChangeEdit? onDoneEdit? onNavigate? onNavigateSelection? onStartEdit? onSubmitEdit? setNaturalSize?

Properties

`Optional` containerBounds

containerBounds?: Bounds

Position of editor, x, y, width and height

`Optional` defaultTextStyle

defaultTextStyle?: TextStyle

Styling for the textfield

`Optional` disabled

disabled?: boolean

`Optional` editState

editState?: EditState<CT, DT>

editState of the cell

`Optional` useRichStyling

useRichStyling?: boolean

Override defaultText styling with cellStyling?

`Optional` zoom

zoom?: number

Methods

`Optional` onCancelEdit

onCancelEdit(): void
On Cancel callbacks. Hides the editor

Returns void

`Optional` onChangeEdit

onChangeEdit(editState): void
Callback when a value has changed.
Parameters
- editState: EditState<CT, DT>
Returns void

`Optional` onDoneEdit

onDoneEdit(): void
Called when either the cancel or submit is called.

Returns void

`Optional` onNavigate

onNavigate(direction, select?, contentful?): void
Parameters
- direction: CartesianDirection
- Optional select: boolean
- Optional contentful: boolean
Returns void

`Optional` onNavigateSelection

onNavigateSelection(direction): void
Parameters
- direction: CartesianDirection
Returns void

`Optional` onStartEdit

onStartEdit(editState): void
Callback when a value has changed.
Parameters
- editState: EditState<CT, DT>
Returns void

`Optional` onSubmitEdit

onSubmitEdit(editState): void
Callback to submit the value back to data store
Parameters
- editState: EditState<CT, DT>
Returns void

`Optional` setNaturalSize

setNaturalSize(size): void
Parameters
- size: Size
Returns void