Files
grafana/public/app/plugins/panel/barchart/suggestions.ts
Torkel Ödegaard 781067ee45 VisualizationSuggestions: Support image & text instead of real previews. Adds suggestions for all non data panels when there are no data (#42074)
* Make suggestion cards support img & text mode instead of only preview

* Generic solution for non data panels

* minor review tweaks
2021-11-25 10:52:01 +01:00

97 lines
2.4 KiB
TypeScript

import { VisualizationSuggestionsBuilder, VizOrientation } from '@grafana/data';
import { LegendDisplayMode, StackingMode, VisibilityMode } from '@grafana/schema';
import { SuggestionName } from 'app/types/suggestions';
import { BarChartFieldConfig, BarChartOptions } from './types';
export class BarChartSuggestionsSupplier {
getListWithDefaults(builder: VisualizationSuggestionsBuilder) {
return builder.getListAppender<BarChartOptions, BarChartFieldConfig>({
name: SuggestionName.BarChart,
pluginId: 'barchart',
options: {
showValue: VisibilityMode.Never,
legend: {
displayMode: LegendDisplayMode.Hidden,
placement: 'right',
} as any,
},
fieldConfig: {
defaults: {
unit: 'short',
custom: {},
},
overrides: [],
},
cardOptions: {
previewModifier: (s) => {
s.options!.barWidth = 0.8;
},
},
});
}
getSuggestionsForData(builder: VisualizationSuggestionsBuilder) {
const list = this.getListWithDefaults(builder);
const { dataSummary } = builder;
if (dataSummary.frameCount !== 1) {
return;
}
if (!dataSummary.hasNumberField || !dataSummary.hasStringField) {
return;
}
// if you have this many rows barchart might not be a good fit
if (dataSummary.rowCountTotal > 50) {
return;
}
// Vertical bars
list.append({
name: SuggestionName.BarChart,
});
if (dataSummary.numberFieldCount > 1) {
list.append({
name: SuggestionName.BarChartStacked,
options: {
stacking: StackingMode.Normal,
},
});
list.append({
name: SuggestionName.BarChartStackedPercent,
options: {
stacking: StackingMode.Percent,
},
});
}
// horizontal bars
list.append({
name: SuggestionName.BarChartHorizontal,
options: {
orientation: VizOrientation.Horizontal,
},
});
if (dataSummary.numberFieldCount > 1) {
list.append({
name: SuggestionName.BarChartHorizontalStacked,
options: {
stacking: StackingMode.Normal,
orientation: VizOrientation.Horizontal,
},
});
list.append({
name: SuggestionName.BarChartHorizontalStackedPercent,
options: {
orientation: VizOrientation.Horizontal,
stacking: StackingMode.Percent,
},
});
}
}
}