ListColumn
ListColumn class
Represents a column in a Table.
class ListColumn;
Properties
| Property | Type | Description |
|---|---|---|
| name | string | Gets and sets the name of the column. |
| totalsCalculation | TotalsCalculation | Gets and sets the type of calculation in the Totals row of the list column. |
| range | Range | Readonly. Gets the range of this list column. |
| isArrayFormula | boolean | Readonly. Indicates whether the fomula is array formula. |
| formula | string | Gets and sets the formula of the list column. |
| totalsRowLabel | string | Gets and sets the display labels of total row. |
Methods
| Method | Description |
|---|---|
| getName() | @deprecated. Please use the ’name’ property instead. Gets and sets the name of the column. |
| setName(string) | @deprecated. Please use the ’name’ property instead. Gets and sets the name of the column. |
| getTotalsCalculation() | @deprecated. Please use the ’totalsCalculation’ property instead. Gets and sets the type of calculation in the Totals row of the list column. |
| setTotalsCalculation(TotalsCalculation) | @deprecated. Please use the ’totalsCalculation’ property instead. Gets and sets the type of calculation in the Totals row of the list column. |
| getRange() | @deprecated. Please use the ‘range’ property instead. Gets the range of this list column. |
| isArrayFormula() | @deprecated. Please use the ‘isArrayFormula’ property instead. Indicates whether the fomula is array formula. |
| getFormula() | @deprecated. Please use the ‘formula’ property instead. Gets and sets the formula of the list column. |
| setFormula(string) | @deprecated. Please use the ‘formula’ property instead. Gets and sets the formula of the list column. |
| getTotalsRowLabel() | @deprecated. Please use the ’totalsRowLabel’ property instead. Gets and sets the display labels of total row. |
| setTotalsRowLabel(string) | @deprecated. Please use the ’totalsRowLabel’ property instead. Gets and sets the display labels of total row. |
| getCustomTotalsRowFormula(boolean, boolean) | Gets the formula of totals row of this list column. |
| setCustomTotalsRowFormula(string, boolean, boolean) | Gets the formula of totals row of this list column. |
| getCustomCalculatedFormula(boolean, boolean) | Gets the formula of this list column. |
| setCustomCalculatedFormula(string, boolean, boolean) | Sets the formula for this list column. |
| getDataStyle() | Gets the style of the data in this column of the table. |
| setDataStyle(Style) | Sets the style of the data in this column of the table. |
| isNull() | Checks whether the implementation object is null. |
name
Gets and sets the name of the column.
name : string;
Remarks
If sets the name of the column, the according cell’ value will be changed too.
totalsCalculation
Gets and sets the type of calculation in the Totals row of the list column.
totalsCalculation : TotalsCalculation;
range
Readonly. Gets the range of this list column.
range : Range;
isArrayFormula
Readonly. Indicates whether the fomula is array formula.
isArrayFormula : boolean;
formula
Gets and sets the formula of the list column.
formula : string;
totalsRowLabel
Gets and sets the display labels of total row.
totalsRowLabel : string;
getName()
@deprecated. Please use the ’name’ property instead. Gets and sets the name of the column.
getName() : string;
Remarks
If sets the name of the column, the according cell’ value will be changed too.
setName(string)
@deprecated. Please use the ’name’ property instead. Gets and sets the name of the column.
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
If sets the name of the column, the according cell’ value will be changed too.
getTotalsCalculation()
@deprecated. Please use the ’totalsCalculation’ property instead. Gets and sets the type of calculation in the Totals row of the list column.
getTotalsCalculation() : TotalsCalculation;
Returns
setTotalsCalculation(TotalsCalculation)
@deprecated. Please use the ’totalsCalculation’ property instead. Gets and sets the type of calculation in the Totals row of the list column.
setTotalsCalculation(value: TotalsCalculation) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TotalsCalculation | The value to set. |
getRange()
@deprecated. Please use the ‘range’ property instead. Gets the range of this list column.
getRange() : Range;
Returns
isArrayFormula()
@deprecated. Please use the ‘isArrayFormula’ property instead. Indicates whether the fomula is array formula.
isArrayFormula() : boolean;
getFormula()
@deprecated. Please use the ‘formula’ property instead. Gets and sets the formula of the list column.
getFormula() : string;
setFormula(string)
@deprecated. Please use the ‘formula’ property instead. Gets and sets the formula of the list column.
setFormula(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTotalsRowLabel()
@deprecated. Please use the ’totalsRowLabel’ property instead. Gets and sets the display labels of total row.
getTotalsRowLabel() : string;
setTotalsRowLabel(string)
@deprecated. Please use the ’totalsRowLabel’ property instead. Gets and sets the display labels of total row.
setTotalsRowLabel(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getCustomTotalsRowFormula(boolean, boolean)
Gets the formula of totals row of this list column.
getCustomTotalsRowFormula(isR1C1: boolean, isLocal: boolean) : string;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns
The formula of this list column.
setCustomTotalsRowFormula(string, boolean, boolean)
Gets the formula of totals row of this list column.
setCustomTotalsRowFormula(formula: string, isR1C1: boolean, isLocal: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | string | the formula for this list column. |
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
getCustomCalculatedFormula(boolean, boolean)
Gets the formula of this list column.
getCustomCalculatedFormula(isR1C1: boolean, isLocal: boolean) : string;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns
The formula of this list column.
setCustomCalculatedFormula(string, boolean, boolean)
Sets the formula for this list column.
setCustomCalculatedFormula(formula: string, isR1C1: boolean, isLocal: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | string | the formula for this list column. |
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
getDataStyle()
Gets the style of the data in this column of the table.
getDataStyle() : Style;
Returns
setDataStyle(Style)
Sets the style of the data in this column of the table.
setDataStyle(style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| style | Style |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;