Update component descriptions

This commit is contained in:
Christoph Kluge 2024-10-16 16:03:31 +02:00
parent 60d7984d66
commit 39b22267d6
3 changed files with 11 additions and 9 deletions

View File

@ -2,9 +2,10 @@
@component Cluster Per Node List component; renders current state of SELECTABLE metrics for ALL nodes
Properties:
- `cluster String`: The cluster to show status information for
- `from Date?`: Custom Time Range selection 'from' [Default: null]
- `to Date?`: Custom Time Range selection 'to' [Default: null]
- `cluster String`: The nodes' cluster
- `data [Object]`: The node data array for all nodes
- `selectedMetrics [String]`: The array of selected metrics
- `selectedMetrics Object`: The object of metric units
-->
<script>

View File

@ -1,9 +1,10 @@
<!--
@component Displays node info, serves link to signle node page
@component Displays node info, serves links to single node page and lists
Properties:
- `job Object`: The Job Object (GraphQL.Job)
- `jobTags [Number]?`: The jobs tags as IDs, default useful for dynamically updating the tags [Default: job.tags]
- `cluster String`: The nodes' cluster
- `subCluster String`: The nodes' subCluster
- `cluster String`: The nodes' hostname
-->
<script>

View File

@ -2,9 +2,9 @@
@component Data row for a single node displaying metric plots
Properties:
- `job Object`: The job object (GraphQL.Job)
- `metrics [String]`: Currently selected metrics
- `plotWidth Number`: Width of the sub-components
- `cluster String`: The nodes' cluster
- `nodeData Object`: The node data object including metric data
- `selectedMetrics [String]`: The array of selected metrics
-->
<script>