ASP.NET Core MVC Controls | ComponentOne
In This Topic
    Table Class
    In This Topic
    File
    wijmo.grid.sheet.js
    Module
    wijmo.grid.sheet

    Represents a Table within the FlexSheet control.

    Constructor

    constructor

    constructor(name: string, range: CellRange, style?: TableStyle, columns?: TableColumn[], options?: ITableOptions): Table
    

    Initializes a new instance of the Table class.

    Parameters
    • name: string

      The name of the table.

    • range: CellRange

      The range of the table.

    • style: TableStyle Optional

      The table style to use with the table. The default style is the 'TableStyleMedium9' built-in table style, if the style is omitted.

    • columns: TableColumn[] Optional

      The columns of the table.

    • options: ITableOptions Optional

      The options ITableOptions of the table.

    Returns
    Table

    Properties

    alterFirstColumn

    Gets or sets a value that determines whether the first table column should have the style applied.

    Type
    boolean

    alterLastColumn

    Gets or sets a value that determines whether the last table column should have the style applied.

    Type
    boolean

    name

    Gets or sets the table name.

    The table name is used to reference the table programmatically.

    Type
    string

    sheet

    Gets the Sheet this table belongs to.

    Type
    Sheet

    showBandedColumns

    Indicating whether banded column formatting is applied.

    Type
    boolean

    showBandedRows

    Gets or sets a value that determines whether banded row formatting is applied.

    Type
    boolean

    showHeaderRow

    Indicates whether the table should include a header row.

    Type
    boolean

    showTotalRow

    Indicates whether the table should include a total row.

    Type
    boolean

    style

    Gets or sets the TableStyle associated with this table.

    Type
    TableStyle

    Methods

    deleteRows

    deleteRows(index: number, count?: number, shift?: boolean): void
    

    Delete rows of Table.

    Parameters
    • index: number

      The starting index of the deleting rows in Table.

    • count: number Optional

      The numbers of rows to delete. If not specified then one row will be deleted.

    • shift: boolean Optional

      Indicates whether cells beneath the table should be shifted or not. If not specified cells beneath will be shifted.

    Returns
    void

    getColumns

    getColumns(): TableColumn[]
    

    Gets the table's columns.

    Returns
    TableColumn[]

    getRange

    getRange(section?: TableSection, column?: any): CellRange
    

    Gets the range of the specific section and column on the relevant sheet that the table occupies.

    Parameters
    • section: TableSection Optional

      The section of Table. If the section is omitted. It will get the range of entire table.

    • column: any Optional

      The column of Table. The column could be TableColumn instance, column name or column index. If the column is omitted. It will get the range for all columns in the table. If the section is null, the reference of the specific column includes the header row and the totals row if they are visible.

    Returns
    CellRange

    insertRows

    insertRows(index: number, count?: number, shift?: boolean): boolean
    

    Insert rows into Table.

    Parameters
    • index: number

      The position where new rows should be added in table.

    • count: number Optional

      The numbers of rows to add. If not specified then one row will be added.

    • shift: boolean Optional

      Indicates whether cells beneath the table should be shifted or not. If not specified cells beneath will be shifted.

    Returns
    boolean