Type alias SheetAttributes

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

Type declaration

  • colHeaderWidth: (() => number)
      • (): number

      • Returns number

  • elementColHeader: (() => SheetHeadersElement)
      • (): SheetHeadersElement

      • Returns SheetHeadersElement

  • elementGrid: (() => GridElement)
  • elementRowHeader: (() => SheetHeadersElement)
      • (): SheetHeadersElement

      • Returns SheetHeadersElement

  • getModel: (() => ISheetModel)
  • invalidate: ((coords?) => void)
      • (coords?): void

      • Parameters

        Returns void

  • isEditing: boolean
  • isSheet: (() => true)

    For runtime introspection

      • (): true

      • Returns true

  • rowHeaderHeight: (() => number)
      • (): number

      • Returns number

  • cancelEdit:function
    • cancelEdit(): void

    • Returns void

  • contains:function
    • contains(element): boolean

    • Parameters

      • element: Node

      Returns boolean

  • focusDrawing:function
    • 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:function
    • focusSheet(options?): void

    • Focus the sheet

      Parameters

      • Optional options: FocusOptions

      Returns void

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

    • Parameters

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

      Returns void

  • navigateSelection:function
  • startEdit:function
    • startEdit(event?): void

    • Parameters

      Returns void

  • submitEdit:function
    • submitEdit(): void

    • Returns void

Settings

Member Visibility

Theme