FuncOptions
Defined in: js-api/src/api/ddt.api.g.ts:329
Constructors
Constructor
new FuncOptions():
FuncOptions
Returns
FuncOptions
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
Action | static | string | 'action' | Shows the function in the 'Action' pane | js-api/src/api/ddt.api.g.ts:334 |
AllowAddAsColumn | static | string | 'allowAddAsColumn' | Allows to add this function results as a column from the context menu | js-api/src/api/ddt.api.g.ts:449 |
AutostartImmediate | static | string | 'autostartImmediate' | - | js-api/src/api/ddt.api.g.ts:339 |
BrowseOnly | static | string | 'browseOnly' | When set to 'true', the app operates in 'browseOnly' mode, using the browse tree for navigation and displaying results only within the browse view | js-api/src/api/ddt.api.g.ts:366 |
BrowsePath | static | string | 'browsePath' | Path in the browse tree, such as 'Oligo' | js-api/src/api/ddt.api.g.ts:369 |
Cache | static | string | 'cache' | Function that should be cached | js-api/src/api/ddt.api.g.ts:402 |
CacheInvalidateOn | static | string | 'cache.invalidateOn' | Cron string that specifies when the cache is invalidated | js-api/src/api/ddt.api.g.ts:405 |
CellRendererCellType | static | string | 'cellType' | Applies to [FuncTypes.CellRenderer]. Cell type (name of the renderer to be used in the UI). | js-api/src/api/ddt.api.g.ts:350 |
CellRendererColumnTags | static | string | 'columnTags' | Applies to [FuncTypes.CellRenderer]. Comma-separated list of key-value pairs that represent required tags for a column to be picked up by the renderer. | js-api/src/api/ddt.api.g.ts:346 |
ColumnlessFilter | static | string | 'columnlessFilter' | When set to 'true', the Filters Panel adds the filter without the column-selection dialog (a columnless filter) | js-api/src/api/ddt.api.g.ts:388 |
DemoPath | static | string | 'demoPath' | Demo path, such as 'Viewers | Radar' |
Editor | static | string | 'editor' | Fully qualified name of the function that edits corresponding function calls | js-api/src/api/ddt.api.g.ts:331 |
ExcludeActionsPanel | static | string | 'exclude-actions-panel' | - | js-api/src/api/ddt.api.g.ts:456 |
ExcludeCurrentValueMenu | static | string | 'exclude-current-value-menu' | - | js-api/src/api/ddt.api.g.ts:458 |
GridChart | static | string | 'gridChart' | When set to 'true', the function is shown in the grid context menu: Add | Summary Columns |
IncludeInCreationScript | static | string | 'includeInCreationScript' | - | js-api/src/api/ddt.api.g.ts:341 |
InputPropertyType | static | string | 'propertyType' | Applies to [FuncTypes.ValueEditor]. Refers to [Types]. | js-api/src/api/ddt.api.g.ts:353 |
InspectorPanel | static | string | 'inspectorPanel' | Function that returns a Widget that gets added as a tab to the "Inspector" window | js-api/src/api/ddt.api.g.ts:391 |
PrimaryFilter | static | string | 'primaryFilter' | When set to 'true', the function is higher-priority to be set in Filters Panel | js-api/src/api/ddt.api.g.ts:385 |
Queue | static | string | 'queue' | Runs a package JS function as a celery task in a docker-based worker. 'true' — an auto-created Node worker container; a name — the package's dockerfiles/[name] container. | js-api/src/api/ddt.api.g.ts:395 |
RunOnInput | static | string | 'runOnInput' | Boolean value that controls whether a function should be executed when the input changes. | js-api/src/api/ddt.api.g.ts:378 |
RunOnOpen | static | string | 'runOnOpen' | Boolean value that controls whether a function should be executed when the function preview opens. Applicable to models as well. | js-api/src/api/ddt.api.g.ts:382 |
ScriptHandlerComment | static | string | 'scriptHandler.commentStart' | Specifies comment start sign for this [FuncTypes.ScriptHandler]. Default: # | js-api/src/api/ddt.api.g.ts:423 |
ScriptHandlerEditorFunc | static | string | 'scriptHandler.editorFunction' | Specifies a package function (qualified name, e.g. 'Flow:flowScriptEditor') that opens a custom editor view for scripts of this [FuncTypes.ScriptHandler]'s language. The function takes one script parameter and returns a view. When absent, or when the function is not present, the default CodeMirror script editor is used. | js-api/src/api/ddt.api.g.ts:446 |
ScriptHandlerEditorMode | static | string | 'scriptHandler.codeEditorMode' | Specifies code editor mode that will be used in CodeMirror for this [FuncTypes.ScriptHandler]. Defaults to language. | js-api/src/api/ddt.api.g.ts:439 |
ScriptHandlerExtensions | static | string | 'scriptHandler.extensions' | Specifies comma separated extensions that this [FuncTypes.ScriptHandler] supports. Mandatory options if tag [FuncTypes.ScriptHandler] is present. | js-api/src/api/ddt.api.g.ts:416 |
ScriptHandlerLanguage | static | string | 'scriptHandler.language' | Specifies language of this [FuncTypes.ScriptHandler]. Mandatory options if tag [FuncTypes.ScriptHandler] is present. | js-api/src/api/ddt.api.g.ts:412 |
ScriptHandlerName | static | string | 'scriptHandler.friendlyName' | Specifies friendlyName of this [FuncTypes.ScriptHandler] to be used in UI. Defaults to language | js-api/src/api/ddt.api.g.ts:420 |
ScriptHandlerParserFunc | static | string | 'scriptHandler.parserFunction' | Specifies function that will handle parsing of text into Scritp object. | js-api/src/api/ddt.api.g.ts:432 |
ScriptHandlerTemplate | static | string | 'scriptHandler.templateScript' | Specifies template script for this [FuncTypes.ScriptHandler]. | js-api/src/api/ddt.api.g.ts:435 |
ScriptHandlerVectorization | static | string | 'scriptHandler.vectorizationFunction' | Specifies function that will handle vectorizations of scripts for this [FuncTypes.ScriptHandler]. The function should accept Script and return String with code that is vectorized. Scalar script inputs in this case are corresponding to dataframe column names. Dataframe that has [VectorScript.vecInputTableName] name should be used as target. | js-api/src/api/ddt.api.g.ts:429 |
SearchPattern | static | string | 'searchPattern' | A way to invoke this function using the natural (English) language. Used by the AI. Passed parameters would be substituted accordingly. Example: "compound activity details for target ${target}" | js-api/src/api/ddt.api.g.ts:454 |
SemType | static | string | 'semType' | Applies to [FuncTypes.ValueEditor]. | js-api/src/api/ddt.api.g.ts:356 |
Server | static | string | 'server' | When set to 'true', runs a package JS function server-side in the default worker queue — an alias of [Queue] = 'true'. | js-api/src/api/ddt.api.g.ts:399 |
Toolbox | static | string | 'toolbox' | Shows the function in the toolbox | js-api/src/api/ddt.api.g.ts:337 |
ViewerPath | static | string | 'viewerPath' | Viewer path in the top menu, should include the viewer name (Add | JavaScript Viewers |
ViewerPosition | static | string | 'viewerPosition' | Specifies the position of the viewer (top, bottom, left, right, fill, auto) | js-api/src/api/ddt.api.g.ts:408 |
VisibilityCondition | static | string | 'condition' | Applies to [FuncTypes.Panel] | js-api/src/api/ddt.api.g.ts:359 |