DataFrameFormulaLinesHelper

Defined in: js-api/src/dataframe/formula-helpers.ts:11

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

Constructor

new DataFrameFormulaLinesHelper(df): DataFrameFormulaLinesHelper

Defined in: js-api/src/dataframe/formula-helpers.ts:17

Parameters

Parameter	Type
df	DataFrame

Returns

DataFrameFormulaLinesHelper

Overrides

FormulaLinesHelper.constructor

Properties

Property	Modifier	Type	Defined in
df	readonly	DataFrame	js-api/src/dataframe/formula-helpers.ts:12

Accessors

items

Get Signature

get items(): FormulaLine[]

Defined in: js-api/src/helpers.ts:91

Returns

FormulaLine[]

Set Signature

set items(value): void

Defined in: js-api/src/helpers.ts:96

Parameters

Parameter	Type
value	FormulaLine[]

Returns

void

Inherited from

FormulaLinesHelper.items

---

storage

Get Signature

get storage(): string

Defined in: js-api/src/dataframe/formula-helpers.ts:14

Returns

string

Set Signature

set storage(value): void

Defined in: js-api/src/dataframe/formula-helpers.ts:15

Parameters

Parameter	Type
value	string

Returns

void

Overrides

FormulaLinesHelper.storage

Methods

add()

add(item): void

Defined in: js-api/src/helpers.ts:100

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper.add

---

addAll()

addAll(items): void

Defined in: js-api/src/helpers.ts:105

Parameters

Parameter	Type
items	FormulaLine[]

Returns

void

Inherited from

FormulaLinesHelper.addAll

---

addBand()

addBand(item): void

Defined in: js-api/src/helpers.ts:115

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper.addBand

---

addLine()

addLine(item): void

Defined in: js-api/src/helpers.ts:110

Parameters

Parameter	Type
item	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper.addLine

---

clear()

clear(): FormulaLinesHelper

Defined in: js-api/src/helpers.ts:136

Returns

FormulaLinesHelper

Inherited from

FormulaLinesHelper.clear

---

removeAt()

removeAt(idx, count?): void

Defined in: js-api/src/helpers.ts:126

Parameters

Parameter	Type	Default value
idx	number	undefined
count	number	1

Returns

void

Inherited from

FormulaLinesHelper.removeAt

---

removeWhere()

removeWhere(predicate): void

Defined in: js-api/src/helpers.ts:132

Parameters

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

Returns

void

Inherited from

FormulaLinesHelper.removeWhere

---

updateAt()

updateAt(idx, value): void

Defined in: js-api/src/helpers.ts:120

Parameters

Parameter	Type
idx	number
value	FormulaLine

Returns

void

Inherited from

FormulaLinesHelper.updateAt

---

getMeta()

static getMeta(item): FormulaLineMeta

Defined in: js-api/src/helpers.ts:143

Parameters

Parameter	Type
item	FormulaLine

Returns

FormulaLineMeta

Inherited from

FormulaLinesHelper.getMeta

---

getMetaByFormula()

static getMetaByFormula(formula, type): FormulaLineMeta

Defined in: js-api/src/helpers.ts:145

Parameters

Parameter	Type
formula	string
type	string

Returns

FormulaLineMeta

Inherited from

FormulaLinesHelper.getMetaByFormula

---

setDefaults()

static setDefaults(item): FormulaLine

Defined in: js-api/src/helpers.ts:141

Parameters

Parameter	Type
item	FormulaLine

Returns

FormulaLine

Inherited from

FormulaLinesHelper.setDefaults