public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Fix typo in GraphTresholdsStyleMode enum (#81960)

Browse Source
This commit is contained in:
paulJonesCalian
2024-02-06 08:20:42 -08:00
committed by GitHub
parent ec5623f552
commit 3942d67f89
19 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
devenv/dev-dashboards/panel-timeseries/timeseries-by-value-color-schemes.json
+1 -1
View File
@@ -516,7 +516,7 @@
"refId": "A"
}
],
"title": "Color line by discrete tresholds",
"title": "Color line by discrete thresholds",
"type": "timeseries"
},
{
packages/grafana-data/src/field/fieldColor.ts
+3 -3
View File
@@ -10,7 +10,7 @@ import { RegistryItem } from '../utils';
import { Registry } from '../utils/Registry';
import { getScaleCalculator, ColorScaleValue } from './scale';
import { fallBackTreshold } from './thresholds';
import { fallBackThreshold } from './thresholds';
/** @beta */
export type FieldValueColorCalculator = (value: number, percent: number, Threshold?: Threshold) => string;
@@ -46,7 +46,7 @@ export const fieldColorModeRegistry = new Registry<FieldColorMode>(() => {
description: 'Derive colors from thresholds',
getCalculator: (_field, theme) => {
return (_value, _percent, threshold) => {
const thresholdSafe = threshold ?? fallBackTreshold;
const thresholdSafe = threshold ?? fallBackThreshold;
return theme.visualization.getColorByName(thresholdSafe.color);
};
},
@@ -251,7 +251,7 @@ export function getFieldSeriesColor(field: Field, theme: GrafanaTheme2): ColorSc
if (!mode.isByValue) {
return {
color: mode.getCalculator(field, theme)(0, 0),
threshold: fallBackTreshold,
threshold: fallBackThreshold,
percent: 1,
};
}
packages/grafana-data/src/field/thresholds.ts
+2 -2
View File
@@ -1,10 +1,10 @@
import { Threshold, FALLBACK_COLOR, Field, ThresholdsMode } from '../types';
export const fallBackTreshold: Threshold = { value: 0, color: FALLBACK_COLOR };
export const fallBackThreshold: Threshold = { value: 0, color: FALLBACK_COLOR };
export function getActiveThreshold(value: number, thresholds: Threshold[] | undefined): Threshold {
if (!thresholds || thresholds.length === 0) {
return fallBackTreshold;
return fallBackThreshold;
}
let active = thresholds[0];
packages/grafana-schema/src/common/common.gen.ts
+2 -2
View File
@@ -409,7 +409,7 @@ export interface HideableFieldConfig {
/**
* TODO docs
*/
export enum GraphTresholdsStyleMode {
export enum GraphThresholdsStyleMode {
Area = 'area',
Dashed = 'dashed',
DashedAndArea = 'dashed+area',
@@ -423,7 +423,7 @@ export enum GraphTresholdsStyleMode {
* TODO docs
*/
export interface GraphThresholdsStyleConfig {
mode: GraphTresholdsStyleMode;
mode: GraphThresholdsStyleMode;
}
/**
packages/grafana-schema/src/common/mudball.cue
+2 -2
View File
@@ -122,11 +122,11 @@ HideableFieldConfig: {
} @cuetsy(kind="interface")
// TODO docs
GraphTresholdsStyleMode: "off" | "line" | "dashed" | "area" | "line+area" | "dashed+area" | "series" @cuetsy(kind="enum",memberNames="Off|Line|Dashed|Area|LineAndArea|DashedAndArea|Series")
GraphThresholdsStyleMode: "off" | "line" | "dashed" | "area" | "line+area" | "dashed+area" | "series" @cuetsy(kind="enum",memberNames="Off|Line|Dashed|Area|LineAndArea|DashedAndArea|Series")
// TODO docs
GraphThresholdsStyleConfig: {
mode: GraphTresholdsStyleMode
mode: GraphThresholdsStyleMode
} @cuetsy(kind="interface")
// TODO docs
packages/grafana-ui/src/components/uPlot/config.ts
+8 -8
View File
@@ -4,7 +4,7 @@ import {
BarAlignment,
GraphDrawStyle,
GraphGradientMode,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
LineInterpolation,
VisibilityMode,
StackingMode,
@@ -21,7 +21,7 @@ export const graphFieldOptions: {
axisPlacement: Array<SelectableValue<AxisPlacement>>;
fillGradient: Array<SelectableValue<GraphGradientMode>>;
stacking: Array<SelectableValue<StackingMode>>;
thresholdsDisplayModes: Array<SelectableValue<GraphTresholdsStyleMode>>;
thresholdsDisplayModes: Array<SelectableValue<GraphThresholdsStyleMode>>;
} = {
drawStyle: [
{ label: 'Lines', value: GraphDrawStyle.Line },
@@ -73,11 +73,11 @@ export const graphFieldOptions: {
],
thresholdsDisplayModes: [
{ label: 'Off', value: GraphTresholdsStyleMode.Off },
{ label: 'As lines', value: GraphTresholdsStyleMode.Line },
{ label: 'As lines (dashed)', value: GraphTresholdsStyleMode.Dashed },
{ label: 'As filled regions', value: GraphTresholdsStyleMode.Area },
{ label: 'As filled regions and lines', value: GraphTresholdsStyleMode.LineAndArea },
{ label: 'As filled regions and lines (dashed)', value: GraphTresholdsStyleMode.DashedAndArea },
{ label: 'Off', value: GraphThresholdsStyleMode.Off },
{ label: 'As lines', value: GraphThresholdsStyleMode.Line },
{ label: 'As lines (dashed)', value: GraphThresholdsStyleMode.Dashed },
{ label: 'As filled regions', value: GraphThresholdsStyleMode.Area },
{ label: 'As filled regions and lines', value: GraphThresholdsStyleMode.LineAndArea },
{ label: 'As filled regions and lines (dashed)', value: GraphThresholdsStyleMode.DashedAndArea },
],
};
packages/grafana-ui/src/components/uPlot/config/UPlotConfigBuilder.test.ts
+3 -3
View File
@@ -8,7 +8,7 @@ import {
VisibilityMode,
ScaleOrientation,
ScaleDirection,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
ScaleDistribution,
} from '@grafana/schema';
@@ -811,7 +811,7 @@ describe('UPlotConfigBuilder', () => {
steps: [],
},
config: {
mode: GraphTresholdsStyleMode.Area,
mode: GraphThresholdsStyleMode.Area,
},
theme: darkTheme,
});
@@ -822,7 +822,7 @@ describe('UPlotConfigBuilder', () => {
steps: [],
},
config: {
mode: GraphTresholdsStyleMode.Area,
mode: GraphThresholdsStyleMode.Area,
},
theme: darkTheme,
});
packages/grafana-ui/src/components/uPlot/config/UPlotThresholds.ts
+8 -8
View File
@@ -2,7 +2,7 @@ import tinycolor from 'tinycolor2';
import uPlot from 'uplot';
import { GrafanaTheme2, Threshold, ThresholdsConfig, ThresholdsMode } from '@grafana/data';
import { GraphThresholdsStyleConfig, GraphTresholdsStyleMode } from '@grafana/schema';
import { GraphThresholdsStyleConfig, GraphThresholdsStyleMode } from '@grafana/schema';
import { getGradientRange, scaleGradient } from './gradientFills';
@@ -19,8 +19,8 @@ export interface UPlotThresholdOptions {
export function getThresholdsDrawHook(options: UPlotThresholdOptions) {
const dashSegments =
options.config.mode === GraphTresholdsStyleMode.Dashed ||
options.config.mode === GraphTresholdsStyleMode.DashedAndArea
options.config.mode === GraphThresholdsStyleMode.Dashed ||
options.config.mode === GraphThresholdsStyleMode.DashedAndArea
? [10, 10]
: null;
@@ -123,15 +123,15 @@ export function getThresholdsDrawHook(options: UPlotThresholdOptions) {
ctx.save();
switch (config.mode) {
case GraphTresholdsStyleMode.Line:
case GraphTresholdsStyleMode.Dashed:
case GraphThresholdsStyleMode.Line:
case GraphThresholdsStyleMode.Dashed:
addLines(u, scaleKey, steps, theme);
break;
case GraphTresholdsStyleMode.Area:
case GraphThresholdsStyleMode.Area:
addAreas(u, scaleKey, steps, theme);
break;
case GraphTresholdsStyleMode.LineAndArea:
case GraphTresholdsStyleMode.DashedAndArea:
case GraphThresholdsStyleMode.LineAndArea:
case GraphThresholdsStyleMode.DashedAndArea:
addAreas(u, scaleKey, steps, theme);
addLines(u, scaleKey, steps, theme);
}
packages/grafana-ui/src/graveyard/TimeSeries/utils.ts
+3 -3
View File
@@ -21,7 +21,7 @@ import {
AxisPlacement,
GraphDrawStyle,
GraphFieldConfig,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
VisibilityMode,
ScaleDirection,
ScaleOrientation,
@@ -519,8 +519,8 @@ export const preparePlotConfigBuilder: UPlotConfigPrepFn<{
// Render thresholds in graph
if (customConfig.thresholdsStyle && config.thresholds) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphTresholdsStyleMode.Off;
if (thresholdDisplay !== GraphTresholdsStyleMode.Off) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphThresholdsStyleMode.Off;
if (thresholdDisplay !== GraphThresholdsStyleMode.Off) {
builder.addThresholds({
config: customConfig.thresholdsStyle,
thresholds: config.thresholds,
packages/grafana-ui/src/schema.ts
+1 -1
View File
@@ -27,7 +27,7 @@ export {
StackingMode,
type StackingConfig,
type StackableFieldConfig,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
type GraphThresholdsStyleConfig,
type GraphFieldConfig,
type LegendPlacement,
public/app/core/components/TimeSeries/utils.ts
+3 -3
View File
@@ -22,7 +22,7 @@ import {
AxisPlacement,
GraphDrawStyle,
GraphFieldConfig,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
VisibilityMode,
ScaleDirection,
ScaleOrientation,
@@ -520,8 +520,8 @@ export const preparePlotConfigBuilder: UPlotConfigPrepFn<{
// Render thresholds in graph
if (customConfig.thresholdsStyle && config.thresholds) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphTresholdsStyleMode.Off;
if (thresholdDisplay !== GraphTresholdsStyleMode.Off) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphThresholdsStyleMode.Off;
if (thresholdDisplay !== GraphThresholdsStyleMode.Off) {
builder.addThresholds({
config: customConfig.thresholdsStyle,
thresholds: config.thresholds,
public/app/features/alerting/unified/components/rule-editor/QueryWrapper.tsx
+2 -2
View File
@@ -13,7 +13,7 @@ import {
ThresholdsConfig,
} from '@grafana/data';
import { DataQuery } from '@grafana/schema';
import { GraphTresholdsStyleMode, Icon, InlineField, Input, Tooltip, useStyles2, Stack } from '@grafana/ui';
import { GraphThresholdsStyleMode, Icon, InlineField, Input, Tooltip, useStyles2, Stack } from '@grafana/ui';
import { QueryEditorRow } from 'app/features/query/components/QueryEditorRow';
import { AlertQuery } from 'app/types/unified-alerting-dto';
@@ -45,7 +45,7 @@ interface Props {
onRunQueries: () => void;
index: number;
thresholds: ThresholdsConfig;
thresholdsType?: GraphTresholdsStyleMode;
thresholdsType?: GraphThresholdsStyleMode;
onChangeThreshold?: (thresholds: ThresholdsConfig, index: number) => void;
condition: string | null;
onSetCondition: (refId: string) => void;
public/app/features/alerting/unified/components/rule-editor/VizWrapper.tsx
+2 -2
View File
@@ -3,7 +3,7 @@ import React from 'react';
import AutoSizer from 'react-virtualized-auto-sizer';
import { GrafanaTheme2, isTimeSeriesFrames, PanelData, ThresholdsConfig } from '@grafana/data';
import { GraphTresholdsStyleMode } from '@grafana/schema';
import { GraphThresholdsStyleMode } from '@grafana/schema';
import { useStyles2 } from '@grafana/ui';
import appEvents from 'app/core/app_events';
import { GraphContainer } from 'app/features/explore/Graph/GraphContainer';
@@ -15,7 +15,7 @@ import { getStatusMessage } from './util';
interface Props {
data: PanelData;
thresholds?: ThresholdsConfig;
thresholdsType?: GraphTresholdsStyleMode;
thresholdsType?: GraphThresholdsStyleMode;
onThresholdsChange?: (thresholds: ThresholdsConfig) => void;
}
public/app/features/alerting/unified/components/rule-editor/util.ts
+4 -4
View File
@@ -9,7 +9,7 @@ import {
ThresholdsConfig,
ThresholdsMode,
} from '@grafana/data';
import { GraphTresholdsStyleMode } from '@grafana/schema';
import { GraphThresholdsStyleMode } from '@grafana/schema';
import { config } from 'app/core/config';
import { EvalFunction } from 'app/features/alerting/state/alertDef';
import { isExpressionQuery } from 'app/features/expressions/guards';
@@ -136,7 +136,7 @@ export function warningFromSeries(series: DataFrame[]): Error | undefined {
export type ThresholdDefinition = {
config: ThresholdsConfig;
mode: GraphTresholdsStyleMode;
mode: GraphThresholdsStyleMode;
};
export type ThresholdDefinitions = Record<string, ThresholdDefinition>;
@@ -210,7 +210,7 @@ export function getThresholdsForQueries(queries: AlertQuery[], condition: string
mode: ThresholdsMode.Absolute,
steps: [],
},
mode: GraphTresholdsStyleMode.Line,
mode: GraphThresholdsStyleMode.Line,
};
}
@@ -218,7 +218,7 @@ export function getThresholdsForQueries(queries: AlertQuery[], condition: string
appendSingleThreshold(originRefID, threshold[0]);
} else if (originRefID && hasValidOrigin && isRangeThreshold) {
appendRangeThreshold(originRefID, threshold, condition.evaluator.type);
thresholds[originRefID].mode = GraphTresholdsStyleMode.LineAndArea;
thresholds[originRefID].mode = GraphThresholdsStyleMode.LineAndArea;
}
});
} catch (err) {
public/app/plugins/panel/barchart/module.tsx
+2 -2
View File
@@ -9,7 +9,7 @@ import {
VizOrientation,
} from '@grafana/data';
import { config } from '@grafana/runtime';
import { GraphTransform, GraphTresholdsStyleMode, StackingMode, VisibilityMode } from '@grafana/schema';
import { GraphTransform, GraphThresholdsStyleMode, StackingMode, VisibilityMode } from '@grafana/schema';
import { graphFieldOptions, commonOptionsBuilder } from '@grafana/ui';
import { ThresholdsStyleEditor } from '../timeseries/ThresholdsStyleEditor';
@@ -93,7 +93,7 @@ export const plugin = new PanelPlugin<Options, FieldConfig>(BarChartPanel)
path: 'thresholdsStyle',
name: 'Show thresholds',
category: ['Thresholds'],
defaultValue: { mode: GraphTresholdsStyleMode.Off },
defaultValue: { mode: GraphThresholdsStyleMode.Off },
settings: {
options: graphFieldOptions.thresholdsDisplayModes,
},
public/app/plugins/panel/barchart/utils.ts
+3 -3
View File
@@ -21,7 +21,7 @@ import {
AxisColorMode,
AxisPlacement,
GraphTransform,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
ScaleDirection,
ScaleDistribution,
ScaleOrientation,
@@ -209,8 +209,8 @@ export const preparePlotConfigBuilder: UPlotConfigPrepFn<BarChartOptionsEX> = ({
// Render thresholds in graph
if (customConfig.thresholdsStyle && field.config.thresholds) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphTresholdsStyleMode.Off;
if (thresholdDisplay !== GraphTresholdsStyleMode.Off) {
const thresholdDisplay = customConfig.thresholdsStyle.mode ?? GraphThresholdsStyleMode.Off;
if (thresholdDisplay !== GraphThresholdsStyleMode.Off) {
builder.addThresholds({
config: customConfig.thresholdsStyle,
thresholds: field.config.thresholds,
public/app/plugins/panel/timeseries/ThresholdsStyleEditor.tsx
+4 -4
View File
@@ -1,17 +1,17 @@
import React, { useCallback } from 'react';
import { StandardEditorProps, SelectableValue } from '@grafana/data';
import { GraphTresholdsStyleMode } from '@grafana/schema';
import { GraphThresholdsStyleMode } from '@grafana/schema';
import { Select } from '@grafana/ui';
type Props = StandardEditorProps<
SelectableValue<{ mode: GraphTresholdsStyleMode }>,
{ options: Array<SelectableValue<GraphTresholdsStyleMode>> }
SelectableValue<{ mode: GraphThresholdsStyleMode }>,
{ options: Array<SelectableValue<GraphThresholdsStyleMode>> }
>;
export const ThresholdsStyleEditor = ({ item, value, onChange, id }: Props) => {
const onChangeCb = useCallback(
(v: SelectableValue<GraphTresholdsStyleMode>) => {
(v: SelectableValue<GraphThresholdsStyleMode>) => {
onChange({
mode: v.value,
});
public/app/plugins/panel/timeseries/config.ts
+2 -2
View File
@@ -15,7 +15,7 @@ import {
LineStyle,
VisibilityMode,
StackingMode,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
GraphTransform,
} from '@grafana/schema';
import { graphFieldOptions, commonOptionsBuilder } from '@grafana/ui';
@@ -228,7 +228,7 @@ export function getGraphFieldConfig(cfg: GraphFieldConfig, isTime = true): SetFi
path: 'thresholdsStyle',
name: 'Show thresholds',
category: ['Thresholds'],
defaultValue: { mode: GraphTresholdsStyleMode.Off },
defaultValue: { mode: GraphThresholdsStyleMode.Off },
settings: {
options: graphFieldOptions.thresholdsDisplayModes,
},
public/app/plugins/panel/timeseries/migrations.ts
+3 -3
View File
@@ -23,7 +23,7 @@ import {
GraphDrawStyle,
GraphFieldConfig,
GraphGradientMode,
GraphTresholdsStyleMode,
GraphThresholdsStyleMode,
LineInterpolation,
LineStyle,
VisibilityMode,
@@ -529,9 +529,9 @@ export function graphToTimeseriesOptions(angular: any): {
});
}
let displayMode = area ? GraphTresholdsStyleMode.Area : GraphTresholdsStyleMode.Line;
let displayMode = area ? GraphThresholdsStyleMode.Area : GraphThresholdsStyleMode.Line;
if (line && area) {
displayMode = GraphTresholdsStyleMode.LineAndArea;
displayMode = GraphThresholdsStyleMode.LineAndArea;
}
// TODO move into standard ThresholdConfig ?