Functions
Grok functions
Constructors
new Functions()
new Functions():
Functions
Returns
Accessors
clientCache
get
clientCache():ClientCache
Controls client caching.
Returns
Source
onAfterRunAction
get
onAfterRunAction():Observable
<FuncCall
>
Returns
Observable
<FuncCall
>
Source
onBeforeRunAction
get
onBeforeRunAction():Observable
<FuncCall
>
Returns
Observable
<FuncCall
>
Source
onParamsUpdated
get
onParamsUpdated():Observable
<FuncCall
>
Returns
Observable
<FuncCall
>
Source
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
eval()
eval(
name
,context
?):Promise
<any
>
Parameters
Parameter | Type |
---|---|
name | string |
context ? | Context |
Returns
Promise
<any
>
Source
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
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
getCurrentCall()
getCurrentCall():
FuncCall
Returns
Source
handleOuterBracketsInColName()
handleOuterBracketsInColName(
name
,escape
):string
Parameters
Parameter | Type |
---|---|
name | string |
escape | boolean |
Returns
string
Source
parse()
parse(
command
,safe
):any
Parameters
Parameter | Type | Default value |
---|---|---|
command | string | undefined |
safe | boolean | true |
Returns
any
Source
register()
register(
func
):Func
Registers a function globally.
Parameters
Parameter | Type |
---|---|
func | IFunctionRegistrationData |
Returns
Source
registerParamFunc()
registerParamFunc(
name
,type
,run
,check
,description
):void
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 | null | boolean | null |
description | null | string | null |
Returns
void
Source
scriptSync()
scriptSync(
s
):any
Parameters
Parameter | Type |
---|---|
s | string |
Returns
any