OptionComponent
Options can comprise multiple components. This table describes each component of an option.
Key
| Field | Type | Requirement | Description |
|---|---|---|---|
| index | index | required | A 1-based index differentiating each part and indicating the stacking order of them. An option component with a higher index is displayed on top of those with lower values, similar to CSS z-index property. |
| option_id | id | required | A reference to the key option_id in the Option table. |
Where
| Field | Type | Requirement | Description |
|---|---|---|---|
| panel_id | string | optional | Identifier of the panel this option is displayed over. |
| x_screen | integer | optional | X coordinates of the option component relative to the left edge of the screen in pixels. |
| y_screen | integer | optional | Y coordinates of the option component relative to the top edge of the screen in pixels. |
| x_viewport | float | optional | X coordinates of the option component relative to the left edge of the screen expressed as a fraction of the screen width. |
| y_viewport | float | optional | Y coordinates of the option component relative to the top edge of the screen expressed as a fraction of the screen height. |
What
| Field | Type | Requirement | Description |
|---|---|---|---|
| description | string | required | A human readable, compact description of the component. |
| symbol_name | string | optional | The name of the displayed symbol. |
| symbol_count | integer | optional | The number of symbols represented in this component. |
| symbol_layout | enum | optional | How the symbols are laid out. |
| color_name | string | optional | The human-readable name of the component color, e.g., red. |
| color_hex | string | optional | The hexadecimal RGB color code of the component (e.g., #FF0000 for red) with optional alpha channel for transparency. |
| orientation | enum | optional | Indicates the symbol orientation. |