gsSQL Sheets Custom Function

TableField

Table column information.

Constructor

new TableField()

Source:

Views.js, line 2756

Members

_isPrimaryTable

Source:

Views.js, line 2785

Properties:

Type	Description
Boolean

aggregateFunction

Source:

Views.js, line 2775

Properties:

Type	Description
String

aliasNames

Source:

Views.js, line 2763

Properties:

Type	Description
Array.<String>

calculatedFormula

Source:

Views.js, line 2773

Properties:

Type	Description
String

columnName

Source:

Views.js, line 2779

Properties:

Type	Description
String

columnTitle

Source:

Views.js, line 2777

Properties:

Type	Description
String

derivedTableColumn

Source:

Views.js, line 2767

Properties:

Type	Description
Number

distinctSetting

Source:

Views.js, line 2781

Properties:

Type	Description
String

fieldName

Source:

Views.js, line 2765

Properties:

Type	Description
String

isPrimaryTable

Description:

Is this field in the primary table.

Source:

Views.js, line 2931

Is this field in the primary table.

originalTable

Source:

Views.js, line 2759

Properties:

Type	Description
String

originalTableColumn

Source:

Views.js, line 2761

Properties:

Type	Description
Number

selectColumn

Source:

Views.js, line 2769

Properties:

Type	Description
Number

subQueryAst

Source:

Views.js, line 2783

Properties:

Type	Description
Object

tableColumn

Description:

Get field column number.

Source:

Views.js, line 2794

Get field column number.

tableInfo

Source:

Views.js, line 2787

Properties:

Type	Description
Table

tempField

Source:

Views.js, line 2771

Properties:

Type	Description
Boolean

Methods

addAlias(columnAlias) → {TableField}

Description:

Alias name assigned to field in select statement.

Source:

Views.js, line 2823

Parameters:

Name	Type	Description
`columnAlias`	String	alias name

Returns:

Type: TableField

getData(tableRow) → {any}

Description:

Retrieve field data for tableRow

Source:

Views.js, line 2950

Parameters:

Name	Type	Description
`tableRow`	Number	row to read data from

Returns:

data

Type: any

setAggregateFunction(value) → {TableField}

Description:

Aggregate function number used (e.g. 'SUM')

Source:

Views.js, line 2862

Parameters:

Name	Type	Description
`value`	String	aggregate function name or ''

Returns:

Type: TableField

setCalculatedFormula(value) → {TableField}

Description:

Calculated formula for field (e.g. 'CASE WHEN QUANTITY >= 100 THEN 1 ELSE 0 END')

Source:

Views.js, line 2872

Parameters:

Name	Type	Description
`value`	String

Returns:

Type: TableField

setColumnName(columnName) → {TableField}

Description:

Set the columnname.

Source:

Views.js, line 2902

Parameters:

Name	Type	Description
`columnName`	String

Returns:

Type: TableField

setColumnTitle(columnTitle) → {TableField}

Description:

Set column TITLE. If an alias is available, that is used - otherwise it is column name.

Source:

Views.js, line 2892

Parameters:

Name	Type	Description
`columnTitle`	String	column title used in output

Returns:

Type: TableField

setDistinctSetting(distinctSetting) → {TableField}

Description:

Set any count modified like 'DISTINCT' or 'ALL'.

Source:

Views.js, line 2912

Parameters:

Name	Type	Description
`distinctSetting`	String

Returns:

Type: TableField

setIsPrimaryTable(isPrimary) → {TableField}

Description:

Set if this field belongs to primary table (i.e. select * from table), rather than a joined tabled.

Source:

Views.js, line 2922

Parameters:

Name	Type	Description
`isPrimary`	Boolean	true if from primary table.

Returns:

Type: TableField

setIsTempField(value) → {TableField}

Description:

Fields referenced BUT not in final output.

Source:

Views.js, line 2852

Parameters:

Name	Type	Description
`value`	Boolean

Returns:

Type: TableField

setOriginalTable(table) → {TableField}

Description:

Original table name before any derived table updates.

Source:

Views.js, line 2803

Parameters:

Name	Type	Description
`table`	String	original table name

Returns:

Type: TableField

setOriginalTableColumn(column) → {TableField}

Description:

Column name found in column title row.

Source:

Views.js, line 2813

Parameters:

Name	Type	Description
`column`	Number

Returns:

Type: TableField

setSelectColumn(column) → {TableField}

Description:

Set column number in table data for field.

Source:

Views.js, line 2841

Parameters:

Name	Type	Description
`column`	Number	column number.

Returns:

Type: TableField

setSubQueryAst(ast) → {TableField}

Description:

The AST from just the subquery in the SELECT.

Source:

Views.js, line 2882

Parameters:

Name	Type	Description
`ast`	Object	subquery ast.

Returns:

Type: TableField

setTableInfo(tableInfo) → {TableField}

Description:

Link this field to the table info.

Source:

Views.js, line 2940

Parameters:

Name	Type	Description
`tableInfo`	Table

Returns:

Type: TableField

(static) getAllExtendedAliasNames(masterFields) → {Array.<String>}

Description:

Search through list of fields and return a list of those that include the table name (e.g. TABLE.COLUMN vs COLUMN)

Source:

Views.js, line 2961

Parameters:

Name	Type	Description
`masterFields`	Array.<TableField>

Returns:

Type: Array.<String>