Methods
defineAlgoOrder(definition) → {object}
- Source:
Attaches default handlers if not supplied & returns the algo order definition
Parameters:
Name | Type | Description |
---|---|---|
definition |
object | algorithmic order definition |
Returns:
ao
- Type
- object
Type Definitions
AOInstance
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
state |
object | instance state used during execution Properties
|
||||||||||||||||||||||||
h |
module:Helpers | helpers bound to the instance |
Type:
- object
AOUIDefinition
- Source:
Properties:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label |
string | name of the order to be shown to the user |
|||||||||||||
id |
string | internal algorithmic order ID |
|||||||||||||
uiIcon |
string |
<optional> |
CSS classname of the icon to show |
||||||||||||
customHelp |
string |
<optional> |
documentation |
||||||||||||
connectionTimeout |
number | how long to wait before considering the HF disconnected |
|||||||||||||
actionTimeout |
number | how long to wait for action confirmatio before considering the HF disconnected |
|||||||||||||
header |
object |
<optional> |
rendered at the top of the form Properties
|
||||||||||||
sections |
Array.<object> | the layout definition itself |
|||||||||||||
sections[].title |
string | rendered above the section |
|||||||||||||
sections[].name |
string | unique internal ID for the section |
|||||||||||||
sections[].rows |
Array.<Array.<string>> | array of rows of field IDs to render in the section, two per row. |
|||||||||||||
fields |
object | field definitions, key'd by ID |
|||||||||||||
actions |
Array.<string> | array of action names, maximum 2 |
Type:
- object
EventMetaInformation
- Source:
Properties:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
chanFilter |
object | source channel filter Properties
|
Type:
- object