SheetXL - v0.3.20
    Preparing search index...

    Class Table

    Implementation of ITable.

    Hierarchy

    • AbstractAnchored<State, CommitView>
      • Table

    Implements

    Index

    Constructors

    constructor

    Accessors

    isIAnchored isITable

    Methods

    addColumn addListeners addRows beginCommit close convertToRange delete deleteRowsAt getAnchorCoords getAnchorType getColumnFilter getColumns getDescription getFilter getName getRange getShowFilterButton getShowHeaders getShowTotals getSnapshot getSort getStyle getStyleAt getStyleOptions getUsedRange getVisibleCellCoords getVisibleRefRangeCoords insertFilter insertSort isClosed isFirstColumnVisible isHeaderVisible isLastColumnVisible isProtected isTotalVisible resize select setDescription setName setShowFilterButton setShowHeaders setShowTotals toJSON updateStyleOptions

    Constructors

    • Parameters

      • options: ConstructorOptions

      Returns Table

    Accessors

    • get isIAnchored(): true

      For runtime type checking.

      Returns true

    • get isITable(): true

      For runtime type checking.

      Returns true

    Methods

    • Add a single column.

      Parameters

      • offset: number
      • name: string

      Returns Column

      Not implemented To remove columns use the resize

    • {@inheritDoc IListener.ISource.addListeners}

      Parameters

      Returns Remove

    • Resize the table.

      Parameters

      • _offset: number

        The new size of the table.

      • count: number = 1

      Returns this

      This will throw an exception if:

      1. The top row changes.
      2. If doesn't overlap with the original table.
      3. If overlaps with another non-overlapping object (e.g. another table or a merge).

    • Batches all 'transactional' changes until they have all be committed or rolled back.

      Parameters

      • Optionaloptions: string | OperationOptions

        Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.

      Returns ITransaction

      Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.

      Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.

    • Similar to delete but cleans resources and can't be undone.

      Returns void

    • Convert the existing table to a range. This will remove the table but preserve the original data and formatting.

      Parameters

      • maxCells: number = Number.MAX_SAFE_INTEGER

        The maximum number of convert.

      Returns ICellRange

      This can be an expensive operation.

    • Delete the rows from the table.

      Parameters

      • _offset: number

        The index to clear from

      • count: number = 1

      Returns this

      Not implemented

    • Returns an column for the given offset.

      Parameters

      • offset: number

      Returns IColumn

    • Specifies if filter buttons are being shown.

      Returns boolean

    • Specifies if headers are being shown for the table.

      Returns boolean

    • Specifies if totals are being shown for the table.

      Returns boolean

    • Returns a cell style for the given coords.

      Parameters

      Returns IStyle

      This will return a CellStyle rendered with the table styling but not any other styling.

      • This is used by the preview.

    • Returns the bounds for the ref accounting for hidden headers.

      Returns IRange.Coords

      This is used for borders and drag areas that are based on visible edges. excluding hidden rows/columns (headers).

    • Enabled and returns an IAutoFilter. Only one AutoFilter per table is supported so this will return the same instance if it has already been created.

      Returns IAutoFilter

    • Only one sort per table is supported so this will. return the same instance if it has already been created.

      Returns IAutoSort

    • Returns if the model has been closed

      Returns boolean

    • Returns a flag indicating if the first column is visible due to hidden headers.

      Returns boolean

    • Returns a flag indicating if the header is visible due to hidden headers.

      Returns boolean

    • Returns a flag indicating if the first column is visible due to hidden headers.

      Returns boolean

    • If the anchor is unable to be modified.

      Returns boolean

    • Returns a flag indicating if the footer is visible due to hidden headers.

      Returns boolean

    • Resize the table.

      Parameters

      Returns ICellRange

      This will throw an exception if:

      1. The top row changes.
      2. If doesn't overlap with the original table.
      3. If overlaps with another non-overlapping object (e.g. another table or a merge).

    • This is the alternative text use for assistive technologies.

      Parameters

      • description: string

        A short human readable text. Default value null.

      Returns Table

    • Set the name for a table object.

      Parameters

      • name: string

        A unique name.

      Returns Table

    • Specifies if filter buttons are being shown.

      Parameters

      • showFilterButton: boolean

      Returns this

      If the autoFilter is not enabled this will have no effect.

    • Specifies if headers are being shown for the table.

      Parameters

      • showHeaders: boolean

      Returns this

    • Specifies if totals are being shown for the table.

      Parameters

      • showTotals: boolean

      Returns this

    • Updates the table StyleInfo.

      Parameters

      • options: StyleOptions

        Style options unique to the table.

      • description: string = 'Update Style Info'

      Returns this

      This will merge with the existing values.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods