FuncCall

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

Extends

• Entity

Constructors

new FuncCall()

new FuncCall(dart): FuncCall

Parameters

Parameter	Type
dart	any

Returns

FuncCall

Overrides

Entity . constructor

Source

src/functions.ts:297

Properties

Property	Modifier	Type	Description	Overrides
aux	public	any	-	-
dart	readonly	any	-	Entity.dart
inputParams	public	FuncCallParams	Input parameter metadata. See inputs for parameter values.	-
inputs	public	object	Named input values. See inputParams for parameter metadata.	-
options	public	any	-	-
outputParams	public	FuncCallParams	Output parameter metadata. See outputs for parameter values.	-
outputs	public	object	Named output values. See outputParams for parameter metadata.	-

Accessors

adHoc

get adHoc(): boolean

set adHoc(a): void

Parameters

Parameter	Type
a	boolean

Returns

boolean

Source

src/functions.ts:331

---

author

get author(): User

Who created entity *

Returns

User

Source

src/functions.ts:334

---

context

get context(): Context

Function call execution context.

set context(context): void

Parameters

Parameter	Type
context	Context

Returns

Context

Source

src/functions.ts:344

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:99

---

errorMessage

get errorMessage(): null | string

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

Returns

null | string

Source

src/functions.ts:348

---

finished

get finished(): Dayjs

Returns

Dayjs

Source

src/functions.ts:327

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:85

---

func

get func(): Func

Function this call is associated with.

set func(func): void

Parameters

Parameter	Type
func	Func

Returns

Func

Source

src/functions.ts:313

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:77

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:89

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:93

---

parentCall

get parentCall(): FuncCall

set parentCall(c): void

Parameters

Parameter	Type
c	FuncCall

Returns

FuncCall

Source

src/functions.ts:316

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:96

---

started

get started(): Dayjs

set started(value): void

Parameters

Parameter	Type
value	Dayjs

Returns

Dayjs

Source

src/functions.ts:319

---

status

get status(): string

Returns

string

Source

src/functions.ts:329

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:102

Methods

buildEditor()

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

Parameters

Parameter	Type
root	HTMLDivElement
options?	object
options.condensed?	boolean
options.showTableSelectors?	boolean

Returns

Promise <InputBase<any>[]>

Source

src/functions.ts:385

---

call()

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

Executes the function call

Parameters

Parameter	Type	Default value
showProgress	boolean	false
progress?	ProgressIndicator	undefined
options?	object	undefined
options.processed?	boolean	undefined
options.report?	boolean	undefined

Returns

Promise <FuncCall>

Source

src/functions.ts:364

---

callSync()

callSync(options?): FuncCall

Executes the function call synchronously

Parameters

Parameter	Type
options?	object
options.processed?	boolean
options.report?	boolean

Returns

FuncCall

Source

src/functions.ts:374

---

cancel()

cancel(): Promise<void>

Returns

Promise<void>

Source

src/functions.ts:369

---

clone()

clone(): FuncCall

Makes a shallow copy.

Returns

FuncCall

Source

src/functions.ts:395

---

edit()

edit(): void

Shows the corresponding dialog (or view).

Returns

void

Source

src/functions.ts:379

---

getEditor()

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

Parameters

Parameter	Type
condensed?	boolean
showTableSelectors?	boolean

Returns

Promise<HTMLDivElement>

Source

src/functions.ts:381

---

getOutputParamValue()

getOutputParamValue(): any

Returns the first output parameter value, or null.

Returns

any

Source

src/functions.ts:351

---

getParamValue()

getParamValue(name): any

Returns function call parameter value

Parameters

Parameter	Type	Description
name	string

Returns

any

Source

src/functions.ts:339

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:111

---

getResultViews()

getResultViews(): ViewBase[]

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

Returns

ViewBase[]

Source

src/functions.ts:390

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:123

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:81

---

setAuxValue()

setAuxValue(name, value): void

Parameters

Parameter	Type
name	string
value	any

Returns

void

Source

src/functions.ts:355

---

setParamValue()

setParamValue(name, value): void

Parameters

Parameter	Type
name	string
value	any

Returns

void

Source

src/functions.ts:359

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:116

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:126

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:121

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:129