Formula¶
Definition¶
Extends¶
Extended By¶
None
Description¶
AMI Script Formula
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Formula | getAmiScript() | String | Returns the amiscript defined for this formula, null if not defined. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| Formula | getName() | String | Returns the name of this formula. |
| Formula | getOwner() | DashboardResource | Returns the Dashboard Resource that this formula is owned by. |
| Formula | gettDRI() | String | Returns the DRI of this formula. |
| Formula | invoke(map_of_params) | Object | Executes the formula, using the supplied a map of arguments. The key should be param name. |
| Formula | resetAmiScript() | Object | Resets the amiscript for this formula to the layout's default configuration. |
| Formula | setAmiScript(amiscript) | Object | Sets the amiscript for this formula. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAmiScript()¶
String Formula::getAmiScript()
Description¶
Returns the amiscript defined for this formula, null if not defined.
getClassName()¶
Description¶
Returns the string name of this object's class type.
getName()¶
Description¶
Returns the name of this formula.
getOwner()¶
DashboardResource Formula::getOwner()
Description¶
Returns the Dashboard Resource that this formula is owned by.
gettDRI()¶
Description¶
Returns the DRI of this formula.
invoke(map_of_params)¶
Object Formula::invoke(Map map_of_params)
Description¶
Executes the formula, using the supplied a map of arguments. The key should be param name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| map_of_params | Map | map of params, where the name should match the param name (see getParams method).Missing params are mapped to null, misspelled params are ignored |
resetAmiScript()¶
Object Formula::resetAmiScript()
Description¶
Resets the amiscript for this formula to the layout's default configuration.
setAmiScript(amiscript)¶
Object Formula::setAmiScript(String amiscript)
Description¶
Sets the amiscript for this formula.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| amiscript | String | amiscript to set on this formula |
toJson()¶
Description¶
Returns a json representation of this object.