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
↳
DataFrameFormulaLinesHelper
Constructors
constructor
• new DataFrameFormulaLinesHelper(df
)
Parameters
Name | Type |
---|---|
df | DataFrame |
Overrides
FormulaLinesHelper.constructor
Defined in
Properties
df
• Readonly
df: DataFrame
Defined in
Accessors
items
• get
items(): FormulaLine
[]
Returns
Inherited from
FormulaLinesHelper.items
Defined in
• set
items(value
): void
Parameters
Name | Type |
---|---|
value | FormulaLine [] |
Returns
void
Inherited from
FormulaLinesHelper.items
Defined in
storage
• get
storage(): string
Returns
string
Overrides
FormulaLinesHelper.storage
Defined in
• set
storage(value
): void
Parameters
Name | Type |
---|---|
value | string |
Returns
void
Overrides
FormulaLinesHelper.storage
Defined in
Methods
add
▸ add(item
): void
Parameters
Name | Type |
---|---|
item | FormulaLine |
Returns
void
Inherited from
Defined in
addAll
▸ addAll(items
): void
Parameters
Name | Type |
---|---|
items | FormulaLine [] |
Returns
void
Inherited from
Defined in
addBand
▸ addBand(item
): void
Parameters
Name | Type |
---|---|
item | FormulaLine |
Returns
void
Inherited from
Defined in
addLine
▸ addLine(item
): void
Parameters
Name | Type |
---|---|
item | FormulaLine |
Returns
void
Inherited from
Defined in
clear
▸ clear(): FormulaLinesHelper
Returns
Inherited from
Defined in
removeAt
▸ removeAt(idx
, count?
): void
Parameters
Name | Type | Default value |
---|---|---|
idx | number | undefined |
count | number | 1 |
Returns
void
Inherited from
Defined in
removeWhere
▸ removeWhere(predicate
): void
Parameters
Name | Type |
---|---|
predicate | (value : FormulaLine , index : number , array : FormulaLine []) => boolean |
Returns
void
Inherited from
FormulaLinesHelper.removeWhere
Defined in
updateAt
▸ updateAt(idx
, value
): void
Parameters
Name | Type |
---|---|
idx | number |
value | FormulaLine |
Returns
void
Inherited from
Defined in
getMeta
▸ Static
getMeta(item
): FormulaLineMeta
Parameters
Name | Type |
---|---|
item | FormulaLine |
Returns
Inherited from
Defined in
setDefaults
▸ Static
setDefaults(item
): FormulaLine
Parameters
Name | Type |
---|---|
item | FormulaLine |
Returns
Inherited from
FormulaLinesHelper.setDefaults