FuncCall

Defined in: js-api/src/functions.ts:301

Represents a function call https://datagrok.ai/help/datagrok/concepts/functions/function-call

Extends

• Entity

Constructors

Constructor

new FuncCall(dart): FuncCall

Defined in: js-api/src/functions.ts:321

Parameters

Parameter	Type
dart	any

Returns

FuncCall

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Description	Overrides	Defined in
aux	public	any	Auxiliary data associated with this call, not part of the parameters (a MapBag: indexed access plus the map methods; typed any so it can be cast to a package's own shape).	-	js-api/src/functions.ts:317
dart	readonly	any	-	Entity.dart	js-api/src/functions.ts:302
inputParams	public	FuncCallParams	Input parameter metadata. See inputs for parameter values.	-	js-api/src/functions.ts:311
inputs	public	object	Named input values. See inputParams for parameter metadata.	-	js-api/src/functions.ts:305
options	public	any	Call options as key-value pairs (a MapBag: indexed access plus the map methods; typed any so it can be cast to a package's own shape).	-	js-api/src/functions.ts:319
outputParams	public	FuncCallParams	Output parameter metadata. See outputs for parameter values.	-	js-api/src/functions.ts:314
outputs	public	object	Named output values. See outputParams for parameter metadata.	-	js-api/src/functions.ts:308

Accessors

adHoc

Get Signature

get adHoc(): boolean

Defined in: js-api/src/functions.ts:360

Whether the call was made ad hoc (not persisted in the history).

Returns

boolean

Set Signature

set adHoc(a): void

Defined in: js-api/src/functions.ts:361

Parameters

Parameter	Type
a	boolean

Returns

void

---

author

Get Signature

get author(): User

Defined in: js-api/src/functions.ts:364

The user who made the call.

Returns

User

Overrides

Entity.author

---

context

Get Signature

get context(): Context

Defined in: js-api/src/functions.ts:375

Function call execution context.

Returns

Context

Set Signature

set context(context): void

Defined in: js-api/src/functions.ts:376

Parameters

Parameter	Type
context	Context

Returns

void

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

debugLogger

Get Signature

get debugLogger(): Logger

Defined in: js-api/src/functions.ts:367

Logger whose records are attached to this call.

Returns

Logger

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

errorMessage

Get Signature

get errorMessage(): string | null

Defined in: js-api/src/functions.ts:379

Error message, if this call resulted in an exception, or null.

Returns

string | null

---

finished

Get Signature

get finished(): Dayjs

Defined in: js-api/src/functions.ts:354

When the call finished.

Returns

Dayjs

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

func

Get Signature

get func(): Func

Defined in: js-api/src/functions.ts:337

Function this call is associated with.

Returns

Func

Set Signature

set func(func): void

Defined in: js-api/src/functions.ts:338

Parameters

Parameter	Type
func	Func

Returns

void

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:38

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:39

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

parentCall

Get Signature

get parentCall(): FuncCall

Defined in: js-api/src/functions.ts:341

The call this one was made from, or null for a top-level call.

Returns

FuncCall

Set Signature

set parentCall(c): void

Defined in: js-api/src/functions.ts:342

Parameters

Parameter	Type
c	FuncCall

Returns

void

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

started

Get Signature

get started(): Dayjs

Defined in: js-api/src/functions.ts:345

When the call started.

Returns

Dayjs

Set Signature

set started(value): void

Defined in: js-api/src/functions.ts:347

Parameters

Parameter	Type
value	Dayjs

Returns

void

---

status

Get Signature

get status(): string

Defined in: js-api/src/functions.ts:357

Execution status: Created, Running, Completed, Error, or Canceled.

Returns

string

Set Signature

set status(newStatus): void

Defined in: js-api/src/functions.ts:358

Parameters

Parameter	Type
newStatus	string

Returns

void

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

Methods

buildEditor()

buildEditor(root, options?): Promise<InputBase<any>[]>

Defined in: js-api/src/functions.ts:449

Builds the standard input editor into [root] and returns the inputs it created.

Parameters

Parameter	Type
root	HTMLDivElement
options?	{ condensed?: boolean; showTableSelectors?: boolean; }
options.condensed?	boolean
options.showTableSelectors?	boolean

Returns

Promise<InputBase<any>[]>

---

call()

call(showProgress?, progress?, options?): Promise<FuncCall>

Defined in: js-api/src/functions.ts:425

Executes the function call

Parameters

Parameter	Type	Default value
showProgress	boolean	false
progress?	ProgressIndicator	undefined
options?	{ processed?: boolean; report?: boolean; }	undefined
options.processed?	boolean	undefined
options.report?	boolean	undefined

Returns

Promise<FuncCall>

---

callSync()

callSync(options?): FuncCall

Defined in: js-api/src/functions.ts:436

Executes the function call synchronously

Parameters

Parameter	Type
options?	{ processed?: boolean; report?: boolean; }
options.processed?	boolean
options.report?	boolean

Returns

FuncCall

---

cancel()

cancel(): Promise<void>

Defined in: js-api/src/functions.ts:431

Requests cancellation of a running call.

Returns

Promise<void>

---

clone()

clone(): FuncCall

Defined in: js-api/src/functions.ts:462

Makes a shallow copy.

Returns

FuncCall

---

edit()

edit(): void

Defined in: js-api/src/functions.ts:441

Shows the corresponding dialog (or view).

Returns

void

---

evalParamChoices()

evalParamChoices(name): Promise<{ dependsOn: string[]; items: string[]; lookup: {[key: string]: object; } | null; values: {[key: string]: any; }; }>

Defined in: js-api/src/functions.ts:400

Evaluates the parameter's choices source (GrokScript evaluation stays Dart-side). Keys of values and lookup are stringified choice keys. dependsOn names the params whose change should re-trigger the evaluation. lookup is null unless the parameter has propagateChoice: all.

Parameters

Parameter	Type
name	string

Returns

Promise<{ dependsOn: string[]; items: string[]; lookup: {[key: string]: object; } | null; values: {[key: string]: any; }; }>

---

evalParamDefault()

evalParamDefault(name): Promise<any>

Defined in: js-api/src/functions.ts:413

Evaluates the parameter's computed default command and returns the value. Evaluation failures reject the returned promise.

Parameters

Parameter	Type
name	string

Returns

Promise<any>

---

evalParamSuggestions()

evalParamSuggestions(name, text): Promise<{ items: string[]; tooltips: {[key: string]: string; }; }>

Defined in: js-api/src/functions.ts:407

Evaluates the parameter's suggestions source for the typed text — both the Dart and the u2 editors now receive what the user typed. Keys of tooltips are stringified.

Parameters

Parameter	Type
name	string
text	string

Returns

Promise<{ items: string[]; tooltips: {[key: string]: string; }; }>

---

evalParamValidators()

evalParamValidators(name): Promise<object[]>

Defined in: js-api/src/functions.ts:419

Runs the parameter's named validators: against its CURRENT value in the call (resolution and evaluation stay Dart-side; passing validators are omitted).

Parameters

Parameter	Type
name	string

Returns

Promise<object[]>

---

getEditor()

getEditor(condensed?, showTableSelectors?): Promise<HTMLDivElement>

Defined in: js-api/src/functions.ts:444

Builds the standard input editor for this call and returns its root; see also buildEditor.

Parameters

Parameter	Type
condensed?	boolean
showTableSelectors?	boolean

Returns

Promise<HTMLDivElement>

---

getOutputParamValue()

getOutputParamValue(): any

Defined in: js-api/src/functions.ts:382

Returns the first output parameter value, or null.

Returns

any

---

getParamValue()

getParamValue(name): any

Defined in: js-api/src/functions.ts:370

Returns function call parameter value

Parameters

Parameter	Type
name	string

Returns

any

---

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: js-api/src/entities/entity.ts:67

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

getResultViews()

getResultViews(): ViewBase[]

Defined in: js-api/src/functions.ts:454

Returns views with result. Should be called on succeeded FuncCall *

Returns

ViewBase[]

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setAuxValue()

setAuxValue(name, value): void

Defined in: js-api/src/functions.ts:387

Sets an auxiliary value on this call (see aux).

Parameters

Parameter	Type
name	string
value	any

Returns

void

---

setParamValue()

setParamValue(name, value): void

Defined in: js-api/src/functions.ts:392

Sets the input parameter value; same as inputs[name] = value.

Parameters

Parameter	Type
name	string
value	any

Returns

void

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag