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

Extends

• FormulaLinesHelper

Constructors

new DataFrameFormulaLinesHelper()

new DataFrameFormulaLinesHelper(df): DataFrameFormulaLinesHelper

Parameters

Parameter	Type
df	DataFrame

Returns

DataFrameFormulaLinesHelper

Overrides

FormulaLinesHelper . constructor

Source

src/dataframe.ts:2469

Properties

Property	Modifier	Type
df	readonly	DataFrame

Accessors

items

get items(): FormulaLine[]

set items(value): void

Parameters

Parameter	Type
value	FormulaLine[]

Returns

FormulaLine[]

Source

src/helpers.ts:88

---

storage

get storage(): string

set storage(value): void

Parameters

Parameter	Type
value	string

Returns

string

Source

src/dataframe.ts:2466

Methods

add()

add(item): void

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper . add

Source

src/helpers.ts:97

---

addAll()

addAll(items): void

Parameters

Parameter	Type
items	FormulaLine[]

Returns

void

Inherited from

FormulaLinesHelper . addAll

Source

src/helpers.ts:102

---

addBand()

addBand(item): void

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper . addBand

Source

src/helpers.ts:112

---

addLine()

addLine(item): void

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper . addLine

Source

src/helpers.ts:107

---

clear()

clear(): FormulaLinesHelper

Returns

FormulaLinesHelper

Inherited from

FormulaLinesHelper . clear

Source

src/helpers.ts:131

---

removeAt()

removeAt(idx, count): void

Parameters

Parameter	Type	Default value
idx	number	undefined
count	number	1

Returns

void

Inherited from

FormulaLinesHelper . removeAt

Source

src/helpers.ts:123

---

removeWhere()

removeWhere(predicate): void

Parameters

Parameter	Type
predicate	(value, index, array) => boolean

Returns

void

Inherited from

FormulaLinesHelper . removeWhere

Source

src/helpers.ts:127

---

updateAt()

updateAt(idx, value): void

Parameters

Parameter	Type
idx	number
value	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper . updateAt

Source

src/helpers.ts:117

---

getMeta()

static getMeta(item): FormulaLineMeta

Parameters

Parameter	Type
item	FormulaLine

Returns

FormulaLineMeta

Inherited from

FormulaLinesHelper . getMeta

Source

src/helpers.ts:138

---

getMetaByFormula()

static getMetaByFormula(formula, type): FormulaLineMeta

Parameters

Parameter	Type
formula	string
type	string

Returns

FormulaLineMeta

Inherited from

FormulaLinesHelper . getMetaByFormula

Source

src/helpers.ts:140

---

setDefaults()

static setDefaults(item): FormulaLine

Parameters

Parameter	Type
item	FormulaLine

Returns

FormulaLine

Inherited from

FormulaLinesHelper . setDefaults

Source

src/helpers.ts:136