FuncCall

Defined in: src/functions.ts:285

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

Extends

• Entity

Constructors

Constructor

new FuncCall(dart): FuncCall

Defined in: src/functions.ts:303

Parameters

Parameter	Type
dart	any

Returns

FuncCall

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Description	Overrides	Defined in
aux	public	any	-	-	src/functions.ts:300
dart	readonly	any	-	Entity.dart	src/functions.ts:286
inputParams	public	FuncCallParams	Input parameter metadata. See inputs for parameter values.	-	src/functions.ts:295
inputs	public	object	Named input values. See inputParams for parameter metadata.	-	src/functions.ts:289
options	public	any	-	-	src/functions.ts:301
outputParams	public	FuncCallParams	Output parameter metadata. See outputs for parameter values.	-	src/functions.ts:298
outputs	public	object	Named output values. See outputParams for parameter metadata.	-	src/functions.ts:292

Accessors

adHoc

Get Signature

get adHoc(): boolean

Defined in: src/functions.ts:337

Returns

boolean

Set Signature

set adHoc(a): void

Defined in: src/functions.ts:338

Parameters

Parameter	Type
a	boolean

Returns

void

---

author

Get Signature

get author(): User

Defined in: src/functions.ts:340

Who created entity *

Returns

User

Overrides

Entity.author

---

context

Get Signature

get context(): Context

Defined in: src/functions.ts:350

Function call execution context.

Returns

Context

Set Signature

set context(context): void

Defined in: src/functions.ts:351

Parameters

Parameter	Type
context	Context

Returns

void

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: src/entities/entity.ts:50

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

debugLogger

Get Signature

get debugLogger(): Logger

Defined in: src/functions.ts:342

Returns

Logger

---

entityType

Get Signature

get entityType(): string

Defined in: src/entities/entity.ts:66

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

errorMessage

Get Signature

get errorMessage(): string | null

Defined in: src/functions.ts:354

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

Returns

string | null

---

finished

Get Signature

get finished(): Dayjs

Defined in: src/functions.ts:333

Returns

Dayjs

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: src/entities/entity.ts:36

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: src/entities/entity.ts:37

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

func

Get Signature

get func(): Func

Defined in: src/functions.ts:319

Function this call is associated with.

Returns

Func

Set Signature

set func(func): void

Defined in: src/functions.ts:320

Parameters

Parameter	Type
func	Func

Returns

void

---

id

Get Signature

get id(): string

Defined in: src/entities/entity.ts:28

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: src/entities/entity.ts:29

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

name

Get Signature

get name(): string

Defined in: src/entities/entity.ts:40

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: src/entities/entity.ts:41

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: src/entities/entity.ts:44

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

parentCall

Get Signature

get parentCall(): FuncCall

Defined in: src/functions.ts:322

Returns

FuncCall

Set Signature

set parentCall(c): void

Defined in: src/functions.ts:323

Parameters

Parameter	Type
c	FuncCall

Returns

void

---

path

Get Signature

get path(): string

Defined in: src/entities/entity.ts:47

Entity path

Returns

string

Inherited from

Entity.path

---

started

Get Signature

get started(): Dayjs

Defined in: src/functions.ts:325

Returns

Dayjs

Set Signature

set started(value): void

Defined in: src/functions.ts:327

Parameters

Parameter	Type
value	Dayjs

Returns

void

---

status

Get Signature

get status(): string

Defined in: src/functions.ts:335

Returns

string

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: src/entities/entity.ts:53

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

Methods

buildEditor()

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

Defined in: src/functions.ts:391

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: src/functions.ts:370

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: src/functions.ts:380

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: src/functions.ts:375

Returns

Promise<void>

---

clone()

clone(): FuncCall

Defined in: src/functions.ts:404

Makes a shallow copy.

Returns

FuncCall

---

edit()

edit(): void

Defined in: src/functions.ts:385

Shows the corresponding dialog (or view).

Returns

void

---

getEditor()

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

Defined in: src/functions.ts:387

Parameters

Parameter	Type
condensed?	boolean
showTableSelectors?	boolean

Returns

Promise<HTMLDivElement>

---

getOutputParamValue()

getOutputParamValue(): any

Defined in: src/functions.ts:357

Returns the first output parameter value, or null.

Returns

any

---

getParamValue()

getParamValue(name): any

Defined in: src/functions.ts:345

Returns function call parameter value

Parameters

Parameter	Type
name	string

Returns

any

---

getProperties()

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

Defined in: src/entities/entity.ts:69

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

---

getResultViews()

getResultViews(): ViewBase[]

Defined in: src/functions.ts:396

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

Returns

ViewBase[]

---

hasTag()

hasTag(tag): boolean

Defined in: src/entities/entity.ts:81

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: src/entities/entity.ts:32

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setAuxValue()

setAuxValue(name, value): void

Defined in: src/functions.ts:361

Parameters

Parameter	Type
name	string
value	any

Returns

void

---

setParamValue()

setParamValue(name, value): void

Defined in: src/functions.ts:365

Parameters

Parameter	Type
name	string
value	any

Returns

void

---

setProperties()

setProperties(props): Promise<any>

Defined in: src/entities/entity.ts:74

Sets entity properties

Parameters

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

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: src/entities/entity.ts:84

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: src/entities/entity.ts:79

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: src/entities/entity.ts:87

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag