Functions

Defined in: src/functions.ts:131

Grok functions

Constructors

Constructor

new Functions(): Functions

Returns

Functions

Accessors

clientCache

Get Signature

get clientCache(): ClientCache

Defined in: src/functions.ts:134

Controls client caching.

Returns

ClientCache

---

onAfterRunAction

Get Signature

get onAfterRunAction(): Observable<FuncCall>

Defined in: src/functions.ts:186

Returns

Observable<FuncCall>

---

onBeforeRunAction

Get Signature

get onBeforeRunAction(): Observable<FuncCall>

Defined in: src/functions.ts:185

Returns

Observable<FuncCall>

---

onParamsUpdated

Get Signature

get onParamsUpdated(): Observable<FuncCall>

Defined in: src/functions.ts:187

Returns

Observable<FuncCall>

Methods

call()

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

Defined in: src/functions.ts:145

Parameters

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

Returns

Promise<any>

---

eval()

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

Defined in: src/functions.ts:149

Parameters

Parameter	Type
name	string
context?	Context

Returns

Promise<any>

---

find()

find(name): Promise<Func | null>

Defined in: src/functions.ts:172

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

Parameters

Parameter	Type
name	string

Returns

Promise<Func | null>

---

get()

get(name): Promise<Func>

Defined in: src/functions.ts:163

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>

---

getCurrentCall()

getCurrentCall(): FuncCall

Defined in: src/functions.ts:181

Returns

FuncCall

---

handleOuterBracketsInColName()

handleOuterBracketsInColName(name, escape): string

Defined in: src/functions.ts:157

Parameters

Parameter	Type
name	string
escape	boolean

Returns

string

---

parse()

parse(command, safe?): any

Defined in: src/functions.ts:153

Parameters

Parameter	Type	Default value
command	string	undefined
safe	boolean	true

Returns

any

---

register()

register(func): Func

Defined in: src/functions.ts:137

Registers a function globally.

Parameters

Parameter	Type
func	IFunctionRegistrationData

Returns

Func

---

registerParamFunc()

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

Defined in: src/functions.ts:141

Parameters

Parameter	Type	Default value
name	string	undefined
type	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "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	boolean | null	null
description	string | null	null

Returns

void

---

scriptSync()

scriptSync(s): any

Defined in: src/functions.ts:177

Parameters

Parameter	Type
s	string

Returns

any