Functions

Grok functions

Constructors

new Functions()

new Functions(): Functions

Returns

Functions

Accessors

clientCache

get clientCache(): ClientCache

Controls client caching.

Returns

ClientCache

Source

src/functions.ts:132

---

onAfterRunAction

get onAfterRunAction(): Observable <FuncCall>

Returns

Observable <FuncCall>

Source

src/functions.ts:180

---

onBeforeRunAction

get onBeforeRunAction(): Observable <FuncCall>

Returns

Observable <FuncCall>

Source

src/functions.ts:179

---

onParamsUpdated

get onParamsUpdated(): Observable <FuncCall>

Returns

Observable <FuncCall>

Source

src/functions.ts:181

Methods

call()

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

Parameters

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

Returns

Promise<any>

Source

src/functions.ts:143

---

eval()

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

Parameters

Parameter	Type
name	string
context?	Context

Returns

Promise<any>

Source

src/functions.ts:147

---

find()

find(name): Promise<null | Func>

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

Parameters

Parameter	Type
name	string

Returns

Promise<null | Func>

Source

src/functions.ts:166

---

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

Parameter	Type
name	string

Returns

Promise <Func>

Source

src/functions.ts:157

---

getCurrentCall()

getCurrentCall(): FuncCall

Returns

FuncCall

Source

src/functions.ts:175

---

parse()

parse(command, safe): any

Parameters

Parameter	Type	Default value
command	string	undefined
safe	boolean	true

Returns

any

Source

src/functions.ts:151

---

register()

register(func): Func

Registers a function globally.

Parameters

Parameter	Type
func	IFunctionRegistrationData

Returns

Func

Source

src/functions.ts:135

---

registerParamFunc()

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

Parameters

Parameter	Type	Default value
name	string	undefined
type	"string" | "bigint" | "object" | "map" | "file" | "view" | "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" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
run	Function	undefined
check	null | boolean	null
description	null | string	null

Returns

void

Source

src/functions.ts:139

---

scriptSync()

scriptSync(s): any

Parameters

Parameter	Type
s	string

Returns

any

Source

src/functions.ts:171