diff --git a/web/frontend/src/Analysis.root.svelte b/web/frontend/src/Analysis.root.svelte index e47a81e..689b7a2 100644 --- a/web/frontend/src/Analysis.root.svelte +++ b/web/frontend/src/Analysis.root.svelte @@ -1,9 +1,9 @@ + Properties: + - `filterPresets Object`: Optional predefined filter values +--> diff --git a/web/frontend/src/Job.root.svelte b/web/frontend/src/Job.root.svelte index 1de0171..d481436 100644 --- a/web/frontend/src/Job.root.svelte +++ b/web/frontend/src/Job.root.svelte @@ -1,12 +1,12 @@ + Properties: + - `dbid Number`: The jobs DB ID + - `username String`: Empty string if auth. is disabled, otherwise the username as string + - `authlevel Number`: The current users authentication level + - `roles [Number]`: Enum containing available roles +--> diff --git a/web/frontend/src/Node.root.svelte b/web/frontend/src/Node.root.svelte index 894ccd9..8082c5a 100644 --- a/web/frontend/src/Node.root.svelte +++ b/web/frontend/src/Node.root.svelte @@ -1,12 +1,12 @@ + Properties: + - `cluster String`: Currently selected cluster + - `hostname String`: Currently selected host (== node) + - `presetFrom Date?`: Custom Time Range selection 'from' [Default: null] + - `presetTo Date?`: Custom Time Range selection 'to' [Default: null] +-->
diff --git a/web/frontend/src/User.root.svelte b/web/frontend/src/User.root.svelte index 9a3548a..c1f0fb8 100644 --- a/web/frontend/src/User.root.svelte +++ b/web/frontend/src/User.root.svelte @@ -1,10 +1,10 @@ + Properties: + - `user Object`: The GraphQL user object + - `filterPresets Object`: Optional predefined filter values +--> diff --git a/web/frontend/src/config/UserSettings.svelte b/web/frontend/src/config/UserSettings.svelte index 2df1152..dade973 100644 --- a/web/frontend/src/config/UserSettings.svelte +++ b/web/frontend/src/config/UserSettings.svelte @@ -1,10 +1,10 @@ + Properties: + - `username String!`: Empty string if auth. is disabled, otherwise the username as string + - `isApi Bool!`: Is currently logged in user api authority +--> - - -
+ + + + + - - -
Color Scheme for Timeseries Plots {cbmode ? `(Color Blind Friendly Palettes)` : ``}
- {#if displayMessage && message.target == "cs"}
- Update: {message.msg} -
{/if} - - - - - {#key activeRow} - {#each Object.entries(cbmode ? cvdschemes : colorschemes) as [name, rgbrow]} - - - - - - {/each} - {/key} - -
{name} - { - activeRow = JSON.stringify(rgbrow) - updateSetting(e, { - selector: "#colorscheme-form", - target: "cs", - }); - }} - /> - - {#each rgbrow as rgb} - - {/each} -
- -
+
Color Scheme for Timeseries Plots {cbmode ? `(Color Blind Friendly Palettes)` : ``}
+ {#if displayMessage && message.target == "cs"} +
+ + Update: {message.msg} + +
+ {/if} + + + + + {#key activeRow} + {#each Object.entries(cbmode ? cvdschemes : colorschemes) as [name, rgbrow]} + + + + + + {/each} + {/key} + +
{name} + { + activeRow = JSON.stringify(rgbrow) + updateSetting(e, { + selector: "#colorscheme-form", + target: "cs", + }); + }} + /> + + {#each rgbrow as rgb} + + {/each} +
+ + + \ No newline at end of file diff --git a/web/frontend/src/config/user/PlotRenderOptions.svelte b/web/frontend/src/config/user/PlotRenderOptions.svelte index 26e6563..2f6af91 100644 --- a/web/frontend/src/config/user/PlotRenderOptions.svelte +++ b/web/frontend/src/config/user/PlotRenderOptions.svelte @@ -1,224 +1,222 @@ - Events: - - `update-config, {selector: String, target: String}`: Trigger upstream update of the config option - --> - - - - -
updateSetting(e, { - selector: "#line-width-form", - target: "lw", - })} + + + + updateSetting(e, { + selector: "#line-width-form", + target: "lw", + })} + > + + - - -
Line Width
- - {#if displayMessage && message.target == "lw"} -
- - Update: {message.msg} - -
+
Line Width
+ + {#if displayMessage && message.target == "lw"} +
+ + Update: {message.msg} + +
+ {/if} + + +
+ + +
+ Width of the lines in the timeseries plots. +
+
+ + +
+ + + + + +
updateSetting(e, { + selector: "#plots-per-row-form", + target: "ppr", + })} + > + + +
Plots per Row
+ {#if displayMessage && message.target == "ppr"} +
+ + Update: {message.msg} + +
+ {/if} + + +
+ + +
+ How many plots to show next to each other on pages such as + /monitoring/job/, /monitoring/system/... +
+
+ +
+ + + + + + +
updateSetting(e, { + selector: "#backgrounds-form", + target: "bg", + })} + > + + +
Colored Backgrounds
+ {#if displayMessage && message.target == "bg"} +
+ + Update: {message.msg} + +
+ {/if} + + +
+
+ {#if config.plot_general_colorBackground} + + {:else} + {/if} - - -
- - -
- Width of the lines in the timeseries plots. -
+
- - - - - - -
updateSetting(e, { - selector: "#plots-per-row-form", - target: "ppr", - })} +
+ {#if config.plot_general_colorBackground} + + {:else} + + {/if} + +
+
+ + + + +
updateSetting(e, { + selector: "#colorblindmode-form", + target: "cbm", + })} + > + + - - -
Plots per Row
- {#if displayMessage && message.target == "ppr"}
- Update: {message.msg} -
{/if} - - -
- - -
- How many plots to show next to each other on pages such as - /monitoring/job/, /monitoring/system/... +
Color Blind Mode
+ {#if displayMessage && message.target == "cbm"} +
+ + Update: {message.msg} +
+ {/if} + + +
+
+ {#if config?.plot_general_colorblindMode} + + {:else} + + {/if} +
- - - - - - -
updateSetting(e, { - selector: "#backgrounds-form", - target: "bg", - })} - > - - -
Colored Backgrounds
- {#if displayMessage && message.target == "bg"}
- Update: {message.msg} -
{/if} - - -
-
- {#if config.plot_general_colorBackground} - - {:else} - - {/if} - -
-
- {#if config.plot_general_colorBackground} - - {:else} - - {/if} - -
+
+ {#if config?.plot_general_colorblindMode} + + {:else} + + {/if} +
- - - - -
updateSetting(e, { - selector: "#colorblindmode-form", - target: "cbm", - })} - > - - -
Color Blind Mode
- {#if displayMessage && message.target == "cbm"}
- Update: {message.msg} -
{/if} - - -
-
- {#if config?.plot_general_colorblindMode} - - {:else} - - {/if} - -
-
- {#if config?.plot_general_colorblindMode} - - {:else} - - {/if} - -
-
- -
- - +
+ + + + \ No newline at end of file diff --git a/web/frontend/src/config/user/UserOptions.svelte b/web/frontend/src/config/user/UserOptions.svelte index 7f9e5e4..49f3c17 100644 --- a/web/frontend/src/config/user/UserOptions.svelte +++ b/web/frontend/src/config/user/UserOptions.svelte @@ -1,82 +1,80 @@ - Events: - - `update-config, {selector: String, target: String}`: Trigger upstream update of the config option - --> - @@ -133,41 +131,41 @@ {#if isApi} - - - Generate JWT - {#if jwt} - -

- Your token is displayed on the right. Press this button to copy it to the clipboard. -

- {#if displayCheck} -

- Copied! -

- {/if} - {:else} - -

- Generate a JSON Web Token for use with the ClusterCockpit REST-API endpoints. -

- {/if} - - + + + Generate JWT + {#if jwt} + +

+ Your token is displayed on the right. Press this button to copy it to the clipboard. +

+ {#if displayCheck} +

+ Copied! +

+ {/if} + {:else} + +

+ Generate a JSON Web Token for use with the ClusterCockpit REST-API endpoints. +

+ {/if} + + - - - Display JWT - - - + + + Display JWT + + + {/if} \ No newline at end of file diff --git a/web/frontend/src/generic/Filters.svelte b/web/frontend/src/generic/Filters.svelte index c7b49fd..44fc408 100644 --- a/web/frontend/src/generic/Filters.svelte +++ b/web/frontend/src/generic/Filters.svelte @@ -1,19 +1,20 @@ + Properties: + - `menuText String?`: Optional text to show in the dropdown menu [Default: null] + - `filterPresets Object?`: Optional predefined filter values [Default: {}] + - `disableClusterSelection Bool?`: Is the selection disabled [Default: false] + - `startTimeQuickSelect Bool?`: Render startTime quick selections [Default: false] + - `matchedJobs Number?`: Number of jobs matching the filter [Default: -2] + - `showFilter Func`: If the filter component should be rendered in addition to total count info [Default: true] + - `applyFilters Func`: The callback function to apply current filter selection + + Functions: + - `void updateFilters (additionalFilters: Object, force: Bool)`: + Handles new filters from nested components, triggers upstream update event. + 'additionalFilters' usually added to existing selection, but can be forced to overwrite instead. +--> (isOpen = !isOpen)}> diff --git a/web/frontend/src/generic/filters/Duration.svelte b/web/frontend/src/generic/filters/Duration.svelte index 75f2e80..3056d9f 100644 --- a/web/frontend/src/generic/filters/Duration.svelte +++ b/web/frontend/src/generic/filters/Duration.svelte @@ -1,16 +1,12 @@ + Properties: + - `isOpen Bool?`: Is this filter component opened [Bindable, Default: false] + - `presetDuration Object?`: Object containing the latest duration filter parameters + - Default: { lessThan: null, moreThan: null, from: null, to: null } + - `setFilter Func`: The callback function to apply current filter selection +--> (isOpen = !isOpen)}> diff --git a/web/frontend/src/generic/filters/InfoBox.svelte b/web/frontend/src/generic/filters/InfoBox.svelte index ea9eb3f..0c24998 100644 --- a/web/frontend/src/generic/filters/InfoBox.svelte +++ b/web/frontend/src/generic/filters/InfoBox.svelte @@ -1,17 +1,23 @@ + Properties: + - `icon String`: Sveltestrap icon name + - `modified Bool?`: Optional if filter is modified + - `onclick Func`: Opens Modal on click + - `children Func`: Internal prop, Svelte 5 version of +--> - - {/if} - {#if !nextButtonDisabled} - - {/if} +
+ +
+ +
+ + { ((page - 1) * itemsPerPage) + 1 } - { Math.min((page - 1) * itemsPerPage + itemsPerPage, totalItems) } of { totalItems } { itemText } + +
+
+ {#if !backButtonDisabled} + + + {/if} + {#if !nextButtonDisabled} + + {/if} +
diff --git a/web/frontend/src/generic/plots/Comparogram.svelte b/web/frontend/src/generic/plots/Comparogram.svelte index 9d6c3bd..b6f5fd1 100644 --- a/web/frontend/src/generic/plots/Comparogram.svelte +++ b/web/frontend/src/generic/plots/Comparogram.svelte @@ -1,16 +1,22 @@ + Properties: + - `metric String?`: The metric name [Default: ""] + - `width Number?`: The plot width [Default: 0] + - `height Number?`: The plot height [Default: 300] + - `data [Array]`: The data object [Default: null] + - `title String?`: Plot title [Default: ""] + - `xlabel String?`: Plot X axis label [Default: ""] + - `ylabel String?`: Plot Y axis label [Default: ""] + - `yunit String?`: Plot Y axis unit [Default: ""] + - `xticks Array`: Array containing jobIDs [Default: []] + - `xinfo Array`: Array containing job information [Default: []] + - `forResources Bool?`: Render this plot for allocated jobResources [Default: false] + - `plot Sync Object!`: uPlot cursor synchronization key +-->
-
- inputChanged(e, 'from')} /> +
+ inputChanged(e, 'from')} /> - Full Range: {sliderMin} - {sliderMax} + Full Range: {sliderMin} - {sliderMax} - inputChanged(e, 'to')} /> -
+ inputChanged(e, 'to')} /> +
-
-
-
rangeChanged(e, 'from')} - style="left: {100 * sliderFrom}%" - >
-
rangeChanged(e, 'to')} - style="left: {100 * sliderTo}%" - >
-
+
+
+
rangeChanged(e, 'from')} + style="left: {100 * sliderFrom}%" + >
+
rangeChanged(e, 'to')} + style="left: {100 * sliderTo}%" + >
+
diff --git a/web/frontend/src/generic/select/HistogramSelection.svelte b/web/frontend/src/generic/select/HistogramSelection.svelte index 2ece0ee..0468efd 100644 --- a/web/frontend/src/generic/select/HistogramSelection.svelte +++ b/web/frontend/src/generic/select/HistogramSelection.svelte @@ -1,11 +1,12 @@ + Properties: + - `cluster String`: Currently selected cluster + - `selectedHistograms [String]`: The currently selected metrics to display as histogram + - `ìsOpen Bool`: Is selection opened [Bindable] + - `applyChange Func`: The callback function to apply current selection +--> diff --git a/web/frontend/src/job/Metric.svelte b/web/frontend/src/job/Metric.svelte index 0c76095..431b7b2 100644 --- a/web/frontend/src/job/Metric.svelte +++ b/web/frontend/src/job/Metric.svelte @@ -1,15 +1,14 @@ + Properties: + - `job Object`: The GQL job object + - `metricName String`: The metrics name + - `metricUnit Object`: The metrics GQL unit object + - `nativeScope String`: The metrics native scope + - `presetScopes [String]`: The preset scopes returned for this metric + - `isShared Bool?`: If this job used shared resources; will adapt threshold indicators accordingly in downstream plots [Default: false] +--> - {#if jobFootprintData.length === 0} -
No footprint data for job available.
- {:else} - {#each jobFootprintData as fpd, index} - {#if fpd.impact !== 4} -
-
 {fpd.name} ({fpd.stat})
-
-
- {#if fpd.impact === 3} - - {:else if fpd.impact === 2} - - {:else if fpd.impact === 0} - - {:else if fpd.impact === -1} - - {/if} - {#if fpd.impact === 3} - - {:else if fpd.impact === 2} - - {:else if fpd.impact === 1} - - {:else if fpd.impact === 0} - - {:else if fpd.impact === -1} - - {/if} -
-
- {fpd.value} / {fpd.peak} - {fpd.unit}   -
-
- {fpd.message} -
- - {#if fpd.dir} - - - - {/if} - - - - {#if !fpd.dir} - - - - {/if} - - {:else} -
-
-  {fpd.name} ({fpd.stat}) -
-
-
- -
-
- {fpd.value}  -
-
-
- {fpd.message} - {/if} - {/each} - {/if} + {#if jobFootprintData.length === 0} +
No footprint data for job available.
+ {:else} + {#each jobFootprintData as fpd, index} + {#if fpd.impact !== 4} +
+
 {fpd.name} ({fpd.stat})
+
+
+ {#if fpd.impact === 3} + + {:else if fpd.impact === 2} + + {:else if fpd.impact === 0} + + {:else if fpd.impact === -1} + + {/if} + {#if fpd.impact === 3} + + {:else if fpd.impact === 2} + + {:else if fpd.impact === 1} + + {:else if fpd.impact === 0} + + {:else if fpd.impact === -1} + + {/if} +
+
+ {fpd.value} / {fpd.peak} + {fpd.unit}   +
+
+ {fpd.message} +
+ + {#if fpd.dir} + + + + {/if} + + + + {#if !fpd.dir} + + + + {/if} + + {:else} +
+
+  {fpd.name} ({fpd.stat}) +
+
+
+ +
+
+ {fpd.value}  +
+
+
+ {fpd.message} + {/if} + {/each} + {/if}