Interface SheetCellEditorProps

interface SheetCellEditorProps {
    activeCoords?: CellCoords;
    bodyStyle?: GridSurfaceStyle;
    containerBounds?: Bounds;
    defaultTextStyle?: TextStyle;
    disabled?: boolean;
    editState?: EditState<ICellModel, string>;
    linesVisible?: number;
    onCommandsChange?: ((commands) => void);
    preferFormula?: boolean;
    sheetModel?: ISheetModel;
    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;
}

Hierarchy (view full)

Properties

activeCoords? bodyStyle? containerBounds? defaultTextStyle? disabled? editState? linesVisible? onCommandsChange? preferFormula? sheetModel? useRichStyling? zoom?

Methods

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

Properties

Optional activeCoords

activeCoords?: CellCoords

used for commands will be removed

Optional bodyStyle

bodyStyle?: GridSurfaceStyle

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<ICellModel, string>

editState of the cell

Optional linesVisible

linesVisible?: number

Returns the number of lines to display. The minimum is 1.

Default Value

'The number of lines required to display the text'

Optional onCommandsChange

onCommandsChange?: ((commands) => void)

Notify that there is a new map of commands

Type declaration

    • (commands): void

    • Parameters

      Returns void

Optional preferFormula

preferFormula?: boolean

Optional sheetModel

sheetModel?: ISheetModel

used for commands will be removed

Optional useRichStyling

useRichStyling?: boolean

Override defaultText styling with cellStyling?

Optional zoom

zoom?: number

Methods

Optional onCancelEdit

Optional onChangeEdit

Optional onDoneEdit

Optional onNavigate

Optional onNavigateSelection

Optional onStartEdit

Optional onSubmitEdit

Optional setNaturalSize

Settings

Member Visibility

Theme

On This Page

activeCoordsbodyStylecontainerBoundsdefaultTextStyledisablededitStatelinesVisibleonCommandsChangepreferFormulasheetModeluseRichStylingzoomonCancelEditonChangeEditonDoneEditonNavigateonNavigateSelectiononStartEditonSubmitEditsetNaturalSize