A component handle part of a solution displayed to end users to interact with solution.
The component is rendered under 'operate' section and associated to a digital twin item.
It can be a native dashboard, a grafana dashboard, ...
Attributes
| Name | Type | Description |
|---|---|---|
| solution_component_id | uuid.UUID | identifier of the component. |
| content | str | depending on component type : iframe URL or grafana relative URL (e.g. 'd/your_uid/name') |
| dashboard_id | uuid.UUID | technical UUID of a dashboard only for native dashboard. |
| default_from | str | relative date (e.g. now-1d) used as default value to filter the component content. |
| default_to | str | relative date (e.g. now) used as default value to filter the component content. |
| label_id | uuid.UUID | Business Label identification on which menu displaying the component. |
| name | str | Component name used as the tab name. |
| order | int | Value used to order the tabs. |
| owner_id | uuid.UUID | set to a user to associate for a personal component, leave None for a global component. |
| solution_type | SolutionType | defines component type (Dashboard, Grafana, ...) |
| template_id | uuid.UUID | unique identifier of template (optional). |
| twin_id | uuid.UUID | unique identifier of digital twin item associated. |
| createdById | uuid.UUID | unique identifier of creating user. |
| createdDate | int | timestamp of created date. |
| updatedById | uuid.UUID | unique identifier of updating user. |
| updatedDate | int | timestamp of updated date. |
Methods
api_id()
return current object id on Web API format.
endpoint()
return endpoint name used to contact backend.
from_json()
load the object from a dict originating of a JSON format.
| Name | Type | Default | Description |
|---|---|---|---|
| obj | object to load information from. |
set_id()
specify the id_value neutrally
| Name | Type | Default | Description |
|---|---|---|---|
| id_value |
return:
to_json()
transform current object into a dict that could be JSONIFY.
| Name | Type | Default | Description |
|---|---|---|---|
| target | str | None |
return: dumpable dict.