Interface IColumn

isIColumn

delete

• delete(options?: ITransaction.OperationOptions): void

  Removes the column from the table.

  Parameters

  • Optionaloptions: ITransaction.OperationOptions

  Returns void

  Remarks

  This will cause the columns to shift left and their indexes to change. Any associated filters/sorts will also be removed.

getCalculatedFormula

• getCalculatedFormula(): string | null

  Returns the formula this column calculates its rows with.

  Returns string | null

  The formula without its leading =, as it reads in the column's first body row, or null if this is not a calculated column.

  Remarks

  A column becomes calculated when a formula is entered into one of its cells and the rest of the column is empty: the formula is filled down the column, and every row added to the table afterwards is given it too. Entering a different formula into a calculated column replaces it for the whole column, unless the column already holds a cell that differs.

  Example

  sheet.getRange('D2').setFormula('=[@Price]*[@Qty]');
  // once the column has filled
  table.getColumnByName('Total').getCalculatedFormula(); // '[@Price]*[@Qty]'
  Copy

getFilter

• getFilter(): IFilter | null

  Returns the filter for this column.

  Returns IFilter | null

getId

• getId(): string

  The unique id of the column.

  Returns string

  Remarks

  This will not change during the lifetime of the column.

getIndex

• getIndex(): number

  The index of the column within the table.

  Returns number

getName

• getName(): string

  A string representing the unique caption of the table column. This is what shall be displayed in the header row in the UI, and is referenced through functions. This name shall be unique per table.

  Returns string

getRange

• getRange(options?: ICellRange.GetRangeOptions): ICellRange

  Returns the range of this column within the table. This includes the header and foot row if applicable.

  Parameters

  • Optionaloptions: ICellRange.GetRangeOptions

  Returns ICellRange

getSort

• getSort(): ISort | null

  Returns the sort field for this column.

  Returns ISort | null

getTable

• getTable(): ITable

  Returns the table this column belongs to.

  Returns ITable

getTotalsRowFormula

• getTotalsRowFormula(): string | number | null

  Returns what this column totals.

  Returns string | number | null

  A SUBTOTAL function number when the column is totaled by one over itself, the formula without its leading = for anything else, or null if there is none.

  Remarks

  While the totals row is shown this is what its cell holds, so a formula typed into the cell is returned here, and =SUBTOTAL(109,[Column]) typed into it returns 109.

getTotalsRowLabel

• getTotalsRowLabel(): string | null

  Returns the text shown in the totals row for this column.

  Returns string | null

  The label or null if there is none.

  Remarks

  While the totals row is shown this is what its cell holds, so text typed into the cell is the label.

isHiddenButton

• isHiddenButton(): boolean

  Returns whether the filter/sort button for this column is hidden.

  Returns boolean

setHiddenButton

• setHiddenButton(hidden: boolean): this

  Sets whether the filter/sort button for this column is hidden.

  Parameters

  • hidden: boolean

  Returns this

setName

• setName(name: string): this

  Sets the name of the column.

  Parameters

  • name: string

  Returns this

setTotalsRowFormula

• setTotalsRowFormula(formula: string | number | undefined): this

  Sets what this column totals.

  Parameters

  • formula: string | number | undefined

    A SUBTOTAL function number (101 to 110; 109 is sum, 101 average, 103 count), a formula with or without the leading =, or undefined for none. A function number totals this column: 109 is =SUBTOTAL(109,[Column]).

  Returns this

  Remarks

  A totals cell shows a label or a formula, never both: setting a formula removes the column's totals label. While the totals row is hidden the formula is kept, and shown with the row.

  Example

  table.setShowTotals(true);
  table.getColumnByName('Amount').setTotalsRowFormula(109);
  table.getColumnByName('Price').setTotalsRowFormula('=MAX([Price])-MIN([Price])');
  Copy

setTotalsRowLabel

• setTotalsRowLabel(label: string): this

  Sets the text shown in the totals row for this column.

  Parameters

  • label: string

    The text, or an empty string for none.

  Returns this

  Remarks

  A totals cell shows a label or a formula, never both: setting a label removes the column's totals formula. While the totals row is hidden the label is kept, and shown with the row.

toJSON

• toJSON(): ColumnJSON | null

  Returns ColumnJSON | null

  The current state as a JSON object or null if not serializable.