Class: Functions

dg.Functions

Grok functions

Constructors

constructor

• new Functions()

Accessors

clientCache

• get clientCache(): ClientCache

Controls client caching.

Returns

ClientCache

Defined in

src/functions.ts:131

---

onAfterRunAction

• get onAfterRunAction(): Observable<FuncCall>

Returns

Observable<FuncCall>

Defined in

src/functions.ts:175

---

onBeforeRunAction

• get onBeforeRunAction(): Observable<FuncCall>

Returns

Observable<FuncCall>

Defined in

src/functions.ts:174

---

onParamsUpdated

• get onParamsUpdated(): Observable<FuncCall>

Returns

Observable<FuncCall>

Defined in

src/functions.ts:176

Methods

call

▸ call(name, parameters?, showProgress?, progress?): Promise<any>

Parameters

Name	Type	Default value
name	string	undefined
parameters	object	{}
showProgress	boolean	false
progress	null | ProgressIndicator	null

Returns

Promise<any>

Defined in

src/functions.ts:142

---

eval

▸ eval(name, context?): Promise<any>

Parameters

Name	Type
name	string
context?	Context

Returns

Promise<any>

Defined in

src/functions.ts:146

---

find

▸ find(name): Promise<null | Func>

Returns a function with the specified name, or null if not found. See also find.

Parameters

Name	Type
name	string

Returns

Promise<null | Func>

Defined in

src/functions.ts:161

---

get

▸ get(name): Promise<Func>

Returns a function with the specified name, or throws an error if there is no such function. See also find.

Parameters

Name	Type
name	string

Returns

Promise<Func>

Defined in

src/functions.ts:152

---

getCurrentCall

▸ getCurrentCall(): FuncCall

Returns

FuncCall

Defined in

src/functions.ts:170

---

register

▸ register(func): Func

Registers a function globally.

Parameters

Name	Type
func	IFunctionRegistrationData

Returns

Func

Defined in

src/functions.ts:134

---

registerParamFunc

▸ registerParamFunc(name, type, run, check?, description?): void

Parameters

Name	Type	Default value
name	string	undefined
type	"string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
run	Function	undefined
check	null | boolean	null
description	null | string	null

Returns

void

Defined in

src/functions.ts:138

---

scriptSync

▸ scriptSync(s): any

Parameters

Name	Type
s	string

Returns

any

Defined in

src/functions.ts:166