Interface SheetElement

Type returned via ref property

interface SheetElement {
    colHeaderWidth: (() => number);
    elementColHeader: (() => SheetHeadersElement);
    elementGrid: (() => GridElement);
    elementRowHeader: (() => SheetHeadersElement);
    getModel: (() => ISheetModel);
    invalidate: ((coords?) => void);
    isEditing: boolean;
    isSheet: (() => true);
    rowHeaderHeight: (() => number);
    cancelEdit(): void;
    focusDrawing(drawing?): boolean;
    focusSheet(options?): void;
    navigate(direction, select?, contentFul?, incrementAmount?): void;
    navigateSelection(direction): void;
    startEdit(event?): void;
    submitEdit(): void;
}

Hierarchy (view full)

Properties

colHeaderWidth elementColHeader elementGrid elementRowHeader getModel invalidate isEditing isSheet rowHeaderHeight

Methods

cancelEdit focusDrawing focusSheet navigate navigateSelection startEdit submitEdit

Properties

colHeaderWidth

colHeaderWidth: (() => number)

Type declaration

    • (): number

    • Returns number

elementColHeader

elementColHeader: (() => SheetHeadersElement)

Type declaration

    • (): SheetHeadersElement

    • Returns SheetHeadersElement

elementGrid

elementGrid: (() => GridElement)

Type declaration

elementRowHeader

elementRowHeader: (() => SheetHeadersElement)

Type declaration

    • (): SheetHeadersElement

    • Returns SheetHeadersElement

getModel

getModel: (() => ISheetModel)

Type declaration

invalidate

invalidate: ((coords?) => void)

Type declaration

    • (coords?): void

    • Parameters

      Returns void

isEditing

isEditing: boolean

isSheet

isSheet: (() => true)

For runtime introspection

Type declaration

    • (): true

    • Returns true

rowHeaderHeight

rowHeaderHeight: (() => number)

Type declaration

    • (): number

    • Returns number

Methods

cancelEdit

  • cancelEdit(): void

  • Returns void

focusDrawing

  • focusDrawing(drawing?): boolean

  • Focus a specific drawing. If not provided will focus the first selected drawing.

    Parameters

    Returns boolean

    Remarks

    The focusDrawing does not scroll. TODO - have this honor focus scroll options.

focusSheet

  • focusSheet(options?): void

  • Focus the sheet

    Parameters

    • Optional options: FocusOptions

    Returns void

navigate

  • navigate(direction, select?, contentFul?, incrementAmount?): void

  • Parameters

    • direction: CartesianDirection
    • Optional select: boolean
    • Optional contentFul: boolean
    • Optional incrementAmount: number

    Returns void

navigateSelection

  • navigateSelection(direction): void

  • Parameters

    Returns void

startEdit

  • startEdit(event?): void

  • Parameters

    Returns void

submitEdit

  • submitEdit(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

colHeaderWidthelementColHeaderelementGridelementRowHeadergetModelinvalidateisEditingisSheetrowHeaderHeightcancelEditfocusDrawingfocusSheetnavigatenavigateSelectionstartEditsubmitEdit