ChartRobots
Summary
The interface representing a chart Robot instances collection.Provides properties and events that allow for accessing various information about Robots attached to a chart.
Signature
1 | |
Namespace
cAlgo.API
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
Methods
Add (2)
Add (1 of 2)
Summary
Adds a new Robot instance to a chart.
Signature
1 | |
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | The name of a Robot. |
| parameterValues | object[] | The Robot parameter values or an anonymous object that contains Robot parameter values. |
Return Value
ChartRobot
Examples
1 2 3 4 | |
1 2 3 4 | |
Add (2 of 2)
Summary
Adds a new Robot instance to a chart.
Signature
1 | |
Parameters
| Name | Type | Description |
|---|---|---|
| type | RobotType | The type of Robot, you can get RobotType from AlgoRegistry. |
| parameterValues | object[] | The Robot parameter values or an anonymous object that contains Robot parameter values. |
Return Value
ChartRobot
Examples
1 2 3 4 5 | |
1 2 3 4 5 | |
See Also
Remove
Summary
Removes a Robot instance from a chart.
Signature
1 | |
Parameters
| Name | Type | Description |
|---|---|---|
| robot | ChartRobot | The ChartRobot to be removed from a chart. |
Return Value
bool
Properties
Item
Signature
1 | |
Return Value
ChartRobot
Count
Summary
Gets the number of all Robots attached to a chart.
Signature
1 | |
Return Value
int
Events
RobotAdded
Summary
Occurs when a Robot is added to a chart.
Signature
1 | |
RobotRemoved
Summary
Occurs when a Robot is removed from a chart.
Signature
1 | |
RobotModified
Summary
Occurs when a chart Robot instance is modified.
Signature
1 | |
RobotStarted
Summary
Occurs when a chart Robot instance is started.
Signature
1 | |
RobotStopped
Summary
Occurs when a chart Robot instance is stopped.
Signature
1 | |