Class: FormulaLinesHelper

dg.FormulaLinesHelper

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

• FormulaLinesHelper

  ↳ DataFrameFormulaLinesHelper

  ↳ ViewerFormulaLinesHelper

Constructors

constructor

• new FormulaLinesHelper()

Accessors

items

• get items(): FormulaLine[]

Returns

FormulaLine[]

Defined in

src/helpers.ts:50

• set items(value): void

Parameters

Name	Type
value	FormulaLine[]

Returns

void

Defined in

src/helpers.ts:55

---

storage

• Abstract get storage(): string

Returns

string

Defined in

src/helpers.ts:47

• Abstract set storage(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/helpers.ts:48

Methods

add

▸ add(item): void

Parameters

Name	Type
item	FormulaLine

Returns

void

Defined in

src/helpers.ts:59

---

addAll

▸ addAll(items): void

Parameters

Name	Type
items	FormulaLine[]

Returns

void

Defined in

src/helpers.ts:64

---

addBand

▸ addBand(item): void

Parameters

Name	Type
item	FormulaLine

Returns

void

Defined in

src/helpers.ts:74

---

addLine

▸ addLine(item): void

Parameters

Name	Type
item	FormulaLine

Returns

void

Defined in

src/helpers.ts:69

---

clear

▸ clear(): FormulaLinesHelper

Returns

FormulaLinesHelper

Defined in

src/helpers.ts:93

---

removeAt

▸ removeAt(idx, count?): void

Parameters

Name	Type	Default value
idx	number	undefined
count	number	1

Returns

void

Defined in

src/helpers.ts:85

---

removeWhere

▸ removeWhere(predicate): void

Parameters

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

Returns

void

Defined in

src/helpers.ts:89

---

updateAt

▸ updateAt(idx, value): void

Parameters

Name	Type
idx	number
value	FormulaLine

Returns

void

Defined in

src/helpers.ts:79

---

getMeta

▸ Static getMeta(item): FormulaLineMeta

Parameters

Name	Type
item	FormulaLine

Returns

FormulaLineMeta

Defined in

src/helpers.ts:100

---

setDefaults

▸ Static setDefaults(item): FormulaLine

Parameters

Name	Type
item	FormulaLine

Returns

FormulaLine

Defined in

src/helpers.ts:98