Class: FuncCall

dg.FuncCall

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

Hierarchy

• Entity

  ↳ FuncCall

Constructors

constructor

• new FuncCall(dart)

Parameters

Name	Type
dart	any

Overrides

Entity.constructor

Defined in

src/functions.ts:292

Properties

aux

• aux: any

Defined in

src/functions.ts:289

---

dart

• Readonly dart: any

Overrides

Entity.dart

Defined in

src/functions.ts:275

---

inputParams

• inputParams: FuncCallParams

Input parameter metadata. See inputs for parameter values.

Defined in

src/functions.ts:284

---

inputs

• inputs: Object

Named input values. See inputParams for parameter metadata.

Index signature

▪ [name: string]: any

Defined in

src/functions.ts:278

---

options

• options: any

Defined in

src/functions.ts:290

---

outputParams

• outputParams: FuncCallParams

Output parameter metadata. See outputs for parameter values.

Defined in

src/functions.ts:287

---

outputs

• outputs: Object

Named output values. See outputParams for parameter metadata.

Index signature

▪ [name: string]: any

Defined in

src/functions.ts:281

Accessors

adHoc

• get adHoc(): boolean

Returns

boolean

Defined in

src/functions.ts:326

• set adHoc(a): void

Parameters

Name	Type
a	boolean

Returns

void

Defined in

src/functions.ts:327

---

author

• get author(): User

Who created entity *

Returns

User

Overrides

Entity.author

Defined in

src/functions.ts:329

---

context

• get context(): Context

Function call execution context.

Returns

Context

Defined in

src/functions.ts:339

• set context(context): void

Parameters

Name	Type
context	Context

Returns

void

Defined in

src/functions.ts:340

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

errorMessage

• get errorMessage(): null | string

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

Returns

null | string

Defined in

src/functions.ts:343

---

finished

• get finished(): Dayjs

Returns

Dayjs

Defined in

src/functions.ts:322

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

func

• get func(): Func

Function this call is associated with.

Returns

Func

Defined in

src/functions.ts:308

• set func(func): void

Parameters

Name	Type
func	Func

Returns

void

Defined in

src/functions.ts:309

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

parentCall

• get parentCall(): FuncCall

Returns

FuncCall

Defined in

src/functions.ts:311

• set parentCall(c): void

Parameters

Name	Type
c	FuncCall

Returns

void

Defined in

src/functions.ts:312

---

path

• get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95

---

started

• get started(): Dayjs

Returns

Dayjs

Defined in

src/functions.ts:314

• set started(value): void

Parameters

Name	Type
value	Dayjs

Returns

void

Defined in

src/functions.ts:316

---

status

• get status(): string

Returns

string

Defined in

src/functions.ts:324

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

Methods

buildEditor

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

Parameters

Name	Type
root	HTMLDivElement
options?	Object
options.condensed?	boolean
options.showTableSelectors?	boolean

Returns

Promise<InputBase<any>[]>

Defined in

src/functions.ts:380

---

call

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

Executes the function call

Parameters

Name	Type	Default value
showProgress	boolean	false
progress?	ProgressIndicator	undefined
options?	Object	undefined
options.processed?	boolean	undefined
options.report?	boolean	undefined

Returns

Promise<FuncCall>

Defined in

src/functions.ts:359

---

callSync

▸ callSync(options?): FuncCall

Executes the function call synchronously

Parameters

Name	Type
options?	Object
options.processed?	boolean
options.report?	boolean

Returns

FuncCall

Defined in

src/functions.ts:369

---

cancel

▸ cancel(): Promise<void>

Returns

Promise<void>

Defined in

src/functions.ts:364

---

clone

▸ clone(): FuncCall

Makes a shallow copy.

Returns

FuncCall

Defined in

src/functions.ts:385

---

edit

▸ edit(): void

Shows the corresponding dialog (or view).

Returns

void

Defined in

src/functions.ts:374

---

getEditor

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

Parameters

Name	Type
condensed?	boolean
showTableSelectors?	boolean

Returns

Promise<HTMLDivElement>

Defined in

src/functions.ts:376

---

getOutputParamValue

▸ getOutputParamValue(): any

Returns the first output parameter value, or null.

Returns

any

Defined in

src/functions.ts:346

---

getParamValue

▸ getParamValue(name): any

Returns function call parameter value

Parameters

Name	Type
name	string

Returns

any

Defined in

src/functions.ts:334

---

getProperties

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

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

setAuxValue

▸ setAuxValue(name, value): void

Parameters

Name	Type
name	string
value	any

Returns

void

Defined in

src/functions.ts:350

---

setParamValue

▸ setParamValue(name, value): void

Parameters

Name	Type
name	string
value	any

Returns

void

Defined in

src/functions.ts:354

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125