Skip to main content

Class: DataFrameFormulaLinesHelper

dg.DataFrameFormulaLinesHelper

FormulaLinesHelper provides methods for working with Formula Lines. Primarily intended for use in Viewer and DataFrame metadata. Documentation: https://datagrok.ai/help/develop/how-to/show-formula-lines

Hierarchy

Constructors

constructor

new DataFrameFormulaLinesHelper(df)

Parameters

NameType
dfDataFrame

Overrides

FormulaLinesHelper.constructor

Defined in

src/dataframe.ts:2243

Properties

df

Readonly df: DataFrame

Defined in

src/dataframe.ts:2238

Accessors

items

get items(): FormulaLine[]

Returns

FormulaLine[]

Inherited from

FormulaLinesHelper.items

Defined in

src/helpers.ts:50

set items(value): void

Parameters

NameType
valueFormulaLine[]

Returns

void

Inherited from

FormulaLinesHelper.items

Defined in

src/helpers.ts:55


storage

get storage(): string

Returns

string

Overrides

FormulaLinesHelper.storage

Defined in

src/dataframe.ts:2240

set storage(value): void

Parameters

NameType
valuestring

Returns

void

Overrides

FormulaLinesHelper.storage

Defined in

src/dataframe.ts:2241

Methods

add

add(item): void

Parameters

NameType
itemFormulaLine

Returns

void

Inherited from

FormulaLinesHelper.add

Defined in

src/helpers.ts:59


addAll

addAll(items): void

Parameters

NameType
itemsFormulaLine[]

Returns

void

Inherited from

FormulaLinesHelper.addAll

Defined in

src/helpers.ts:64


addBand

addBand(item): void

Parameters

NameType
itemFormulaLine

Returns

void

Inherited from

FormulaLinesHelper.addBand

Defined in

src/helpers.ts:74


addLine

addLine(item): void

Parameters

NameType
itemFormulaLine

Returns

void

Inherited from

FormulaLinesHelper.addLine

Defined in

src/helpers.ts:69


clear

clear(): FormulaLinesHelper

Returns

FormulaLinesHelper

Inherited from

FormulaLinesHelper.clear

Defined in

src/helpers.ts:93


removeAt

removeAt(idx, count?): void

Parameters

NameTypeDefault value
idxnumberundefined
countnumber1

Returns

void

Inherited from

FormulaLinesHelper.removeAt

Defined in

src/helpers.ts:85


removeWhere

removeWhere(predicate): void

Parameters

NameType
predicate(value: FormulaLine, index: number, array: FormulaLine[]) => boolean

Returns

void

Inherited from

FormulaLinesHelper.removeWhere

Defined in

src/helpers.ts:89


updateAt

updateAt(idx, value): void

Parameters

NameType
idxnumber
valueFormulaLine

Returns

void

Inherited from

FormulaLinesHelper.updateAt

Defined in

src/helpers.ts:79


getMeta

Static getMeta(item): FormulaLineMeta

Parameters

NameType
itemFormulaLine

Returns

FormulaLineMeta

Inherited from

FormulaLinesHelper.getMeta

Defined in

src/helpers.ts:100


setDefaults

Static setDefaults(item): FormulaLine

Parameters

NameType
itemFormulaLine

Returns

FormulaLine

Inherited from

FormulaLinesHelper.setDefaults

Defined in

src/helpers.ts:98