Api session event editor overlay add legend entry
API Event to Add a Legend Entry to a specified Overlay. The Overlay must have a custom legend before entries can be added to it.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlay ID | |
| 1 | REQUIRED | (Boolean or multiple values in array [true, false, true]) | Add to custom difference legend (false adds the entry to the normal custom legend) | |
| 2 | OPTIONAL | (String or multiple values in array ["a", "b", "c"]) | Name (optional) | |
| 3 | OPTIONAL | (TColor or multiple values in array [a, b, c]) | Color (optional) | |
| 4 | OPTIONAL | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Value (optional) |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/add_legend_entry/?f=JSON&token=API_TOKEN
with content:
[ [ 1, 2, 3 ], [ true, false, true ], "", "", "" ]