GraphNG: rename "points" to "showPoints" (#29635)

* rename "points" to "showPoints"

* rename ShowPoints enum to PointVisibility
This commit is contained in:
Leon Sorokin 2020-12-07 09:29:34 -06:00 committed by GitHub
parent 874f2fafb2
commit fee0d44e5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 24 deletions

View File

@ -13,7 +13,7 @@ import {
import { alignDataFrames } from './utils';
import { UPlotChart } from '../uPlot/Plot';
import { PlotProps } from '../uPlot/types';
import { AxisPlacement, GraphFieldConfig, DrawStyle, PointMode } from '../uPlot/config';
import { AxisPlacement, GraphFieldConfig, DrawStyle, PointVisibility } from '../uPlot/config';
import { useTheme } from '../../themes';
import { VizLayout } from '../VizLayout/VizLayout';
import { LegendDisplayMode, LegendItem, LegendOptions } from '../Legend/Legend';
@ -36,7 +36,7 @@ export interface GraphNGProps extends Omit<PlotProps, 'data' | 'config'> {
const defaultConfig: GraphFieldConfig = {
drawStyle: DrawStyle.Line,
points: PointMode.Auto,
showPoints: PointVisibility.Auto,
axisPlacement: AxisPlacement.Auto,
};
@ -145,7 +145,7 @@ export const GraphNG: React.FC<GraphNGProps> = ({
const colorMode = getFieldColorModeForField(field);
const seriesColor = colorMode.getCalculator(field, theme)(0, 0);
const pointsMode = customConfig.drawStyle === DrawStyle.Points ? PointMode.Always : customConfig.points;
const showPoints = customConfig.drawStyle === DrawStyle.Points ? PointVisibility.Always : customConfig.showPoints;
builder.addSeries({
scaleKey,
@ -153,7 +153,7 @@ export const GraphNG: React.FC<GraphNGProps> = ({
lineColor: seriesColor,
lineWidth: customConfig.lineWidth,
lineInterpolation: customConfig.lineInterpolation,
points: pointsMode,
showPoints,
pointSize: customConfig.pointSize,
pointColor: seriesColor,
fillOpacity: customConfig.fillOpacity,

View File

@ -9,7 +9,7 @@ export enum AxisPlacement {
Hidden = 'hidden',
}
export enum PointMode {
export enum PointVisibility {
Auto = 'auto', // will show points when the density is low or line is hidden
Never = 'never',
Always = 'always',
@ -41,7 +41,7 @@ export interface AreaConfig {
}
export interface PointsConfig {
points?: PointMode;
showPoints?: PointVisibility;
pointSize?: number;
pointColor?: string;
pointSymbol?: string; // eventually dot,star, etc
@ -72,11 +72,11 @@ export const graphFieldOptions = {
{ label: 'Step After', value: LineInterpolation.StepAfter },
] as Array<SelectableValue<LineInterpolation>>,
points: [
{ label: 'Auto', value: PointMode.Auto, description: 'Show points when the density is low' },
{ label: 'Always', value: PointMode.Always },
{ label: 'Never', value: PointMode.Never },
] as Array<SelectableValue<PointMode>>,
showPoints: [
{ label: 'Auto', value: PointVisibility.Auto, description: 'Show points when the density is low' },
{ label: 'Always', value: PointVisibility.Always },
{ label: 'Never', value: PointVisibility.Never },
] as Array<SelectableValue<PointVisibility>>,
axisPlacement: [
{ label: 'Auto', value: AxisPlacement.Auto, description: 'First field on the left, everything else on the right' },

View File

@ -3,7 +3,7 @@
import { UPlotConfigBuilder } from './UPlotConfigBuilder';
import { GrafanaTheme } from '@grafana/data';
import { expect } from '../../../../../../public/test/lib/common';
import { AxisPlacement, DrawStyle, PointMode } from '../config';
import { AxisPlacement, DrawStyle, PointVisibility } from '../config';
describe('UPlotConfigBuilder', () => {
describe('scales config', () => {
@ -127,7 +127,7 @@ describe('UPlotConfigBuilder', () => {
scaleKey: 'scale-x',
fillColor: '#ff0000',
fillOpacity: 0.5,
points: PointMode.Auto,
showPoints: PointVisibility.Auto,
pointSize: 5,
pointColor: '#00ff00',
lineColor: '#0000ff',

View File

@ -1,6 +1,6 @@
import tinycolor from 'tinycolor2';
import uPlot, { Series } from 'uplot';
import { DrawStyle, LineConfig, AreaConfig, PointsConfig, PointMode, LineInterpolation } from '../config';
import { DrawStyle, LineConfig, AreaConfig, PointsConfig, PointVisibility, LineInterpolation } from '../config';
import { barsBuilder, smoothBuilder, stepBeforeBuilder, stepAfterBuilder } from '../paths';
import { PlotConfigBuilder } from '../types';
@ -16,7 +16,7 @@ export class UPlotSeriesBuilder extends PlotConfigBuilder<SeriesProps, Series> {
lineInterpolation,
lineColor,
lineWidth,
points,
showPoints,
pointColor,
pointSize,
fillColor,
@ -67,13 +67,13 @@ export class UPlotSeriesBuilder extends PlotConfigBuilder<SeriesProps, Series> {
};
// we cannot set points.show property above (even to undefined) as that will clear uPlot's default auto behavior
if (points === PointMode.Auto) {
if (showPoints === PointVisibility.Auto) {
if (drawStyle === DrawStyle.Bars) {
pointsConfig.points!.show = false;
}
} else if (points === PointMode.Never) {
} else if (showPoints === PointVisibility.Never) {
pointsConfig.points!.show = false;
} else if (points === PointMode.Always) {
} else if (showPoints === PointVisibility.Always) {
pointsConfig.points!.show = true;
}

View File

@ -2,7 +2,7 @@ import { FieldColorModeId, FieldConfigProperty, PanelPlugin } from '@grafana/dat
import { LegendDisplayMode } from '@grafana/ui';
import {
GraphFieldConfig,
PointMode,
PointVisibility,
DrawStyle,
AxisPlacement,
graphFieldOptions,
@ -76,11 +76,11 @@ export const plugin = new PanelPlugin<Options, GraphFieldConfig>(GraphPanel)
showIf: c => c.drawStyle === DrawStyle.Line,
})
.addRadio({
path: 'points',
name: 'Points',
defaultValue: graphFieldOptions.points[0].value,
path: 'showPoints',
name: 'Show points',
defaultValue: graphFieldOptions.showPoints[0].value,
settings: {
options: graphFieldOptions.points,
options: graphFieldOptions.showPoints,
},
})
.addSliderInput({
@ -92,7 +92,7 @@ export const plugin = new PanelPlugin<Options, GraphFieldConfig>(GraphPanel)
max: 10,
step: 1,
},
showIf: c => c.points !== PointMode.Never,
showIf: c => c.showPoints !== PointVisibility.Never,
})
.addRadio({
path: 'axisPlacement',