Script
Extends
Constructors
new Script()
new Script(
dart
):Script
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
Overrides
Constructs
Script
Source
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
aux | public | any | Func .aux |
dart | public | any | Func .dart |
options | public | object | Func .options |
Accessors
author
get
author():User
Who created entity *
Returns
Source
createdOn
get
createdOn():Dayjs
Time when entity was created *
Returns
Dayjs
Source
description
get
description():string
Returns
string
Source
environment
get
environment():string
Environment name. See also: https://datagrok.ai/help/datagrok/functions/func-params-annotation
set
environment(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
friendlyName
get
friendlyName():string
Entity friendly name
set
friendlyName(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
helpUrl
get
helpUrl():string
Help URL.
Returns
string
Source
id
get
id():string
Entity ID (GUID)
set
id(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
inputs
get
inputs():Property
[]
Input parameters
Returns
Property
[]
Source
language
get
language():"r"
|"javascript"
|"julia"
|"octave"
|"python"
|"nodejs"
|"grok"
Script language. See also: https://datagrok.ai/help/datagrok/functions/func-params-annotation
set
language(s
):void
Parameters
Parameter | Type |
---|---|
s | "r" | "javascript" | "julia" | "octave" | "python" | "nodejs" | "grok" |
Returns
"r"
| "javascript"
| "julia"
| "octave"
| "python"
| "nodejs"
| "grok"
Source
name
get
name():string
Entity short name
set
name(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
nqName
get
nqName():string
Entity full-qualified name
Returns
string
Source
outputs
get
outputs():Property
[]
Output parameters
Returns
Property
[]
Source
package
get
package():Package
A package this function belongs to.
Returns
Source
path
get
path():string
Entity path
Returns
string
Source
reference
get
reference():string
Reference header parameter. See also: https://datagrok.ai/help/datagrok/functions/func-params-annotation
set
reference(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
sample
get
sample():string
Sample table. See also: https://datagrok.ai/help/datagrok/functions/func-params-annotation
set
sample(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
script
get
script():string
Script
set
script(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
tags
get
tags():string
[]
Script tags. See also: https://datagrok.ai/help/datagrok/functions/func-params-annotation
set
tags(tags
):void
Parameters
Parameter | Type |
---|---|
tags | string [] |
Returns
string
[]
Source
type
get
type():string
Returns
string
Source
updatedOn
get
updatedOn():null
|Dayjs
Time when entity was updated *
Returns
null
| Dayjs
Source
Methods
apply()
apply(
parameters
):Promise
<any
>
Executes the function with the specified parameters, and returns result. If necessary, the corresponding package will be loaded as part of the call.
Parameters
Parameter | Type |
---|---|
parameters | any [] | object |
Returns
Promise
<any
>
Inherited from
Source
applySync()
applySync(
parameters
):any
Executes the function synchronously, and returns the result. If the function is asynchronous, throws an exception.
Parameters
Parameter | Type |
---|---|
parameters | object |
Returns
any
Inherited from
Source
getProperties()
getProperties():
Promise
<object
>
Gets entity properties
Returns
Promise
<object
>
Inherited from
Source
hasTag()
hasTag(
tag
):boolean
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
newId()
newId():
void
Generates new id for this entity.
Returns
void
Inherited from
Source
prepare()
prepare(
parameters
):FuncCall
Returns FuncCall object in a stand-by state
Parameters
Parameter | Type |
---|---|
parameters | object |
Returns
Inherited from
Source
setProperties()
setProperties(
props
):Promise
<any
>
Sets entity properties
Parameters
Parameter | Type |
---|---|
props | object |
Returns
Promise
<any
>
Inherited from
Source
tag()
tag(
tag
):boolean
Adds a specified tag
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
toString()
toString():
string
Returns a string representing the object
Returns
string
Inherited from
Source
unTag()
unTag(
tag
):boolean
Removes a specified tag
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
byName()
static
byName(name
):Func
Returns a function with the specified name.
Parameters
Parameter | Type |
---|---|
name | string |
Returns
Inherited from
Source
create()
static
create(script
):Script
Parameters
Parameter | Type |
---|---|
script | string |
Returns
Source
find()
static
find(params
?):Func
[]
Returns functions with the specified attributes.
Parameters
Parameter | Type |
---|---|
params ? | object |
params.meta ? | any |
params.name ? | string |
params.package ? | string |
params.returnSemType ? | string |
params.returnType ? | string |
params.tags ? | string [] |
Returns
Func
[]
Inherited from
Source
findAll()
static
findAll(params
?):Promise
<Func
[]>
Parameters
Parameter | Type |
---|---|
params ? | object |
params.meta ? | any |
params.name ? | string |
params.package ? | string |
params.returnSemType ? | string |
params.returnType ? | string |
params.tags ? | string [] |
Returns
Promise
<Func
[]>
Inherited from
Deprecated
Use find, it's the same now but does not make a server query and synchronous.