@gdacm/grafana-items 0.1.17 → 0.1.18

package/dist/index.d.ts

@@ -63,6 +63,7 @@ export { PanelOptionsGeomapLayer } from "./items/PanelOptionsGeomapLayer.js";
 export { PanelOptionsGeomapTooltip } from "./items/PanelOptionsGeomapTooltip.js";
 export { PanelOptionsGeomapView } from "./items/PanelOptionsGeomapView.js";
 export { PanelOptionsGeomap } from "./items/PanelOptionsGeomap.js";
+export { PieChartLegendOptions } from "./items/PieChartLegendOptions.js";
 export { PanelOptionsPieChart } from "./items/PanelOptionsPieChart.js";
 export { PanelOptionsStat } from "./items/PanelOptionsStat.js";
 export { PanelOptionsTableSortBy } from "./items/PanelOptionsTableSortBy.js";

package/dist/index.js

@@ -262,13 +262,11 @@ function defineObject(cls, key, type, option) {
 * @param {string} [option.name]
 * @param {(instance: T) => void} [option.onInit]
 * @param {(metaOptions: GenericMetaOptions) => T} [option.onDefault]
-* @param {Boolean} [option.setNew]
 * @param {String} [option.typeName]
 */
 function defineGrafanaObject(cls, key, type, option) {
 	const metaClassInfo = getMetaClassInfo(cls);
 	const name = option?.name ? option.name : key;
-	const setNew = option?.setNew ?? false;
 	const caseName = name.charAt(0).toUpperCase() + name.slice(1);
 	const typeName = option?.typeName ? option.typeName : type.name;
 	if (metaClassInfo.typeNamesToInclude.includes(type.name) === false) {
@@ -297,7 +295,7 @@ function defineGrafanaObject(cls, key, type, option) {
 		metaClassInfo.methods.push(`${setName}(${name}: ${typeName}): this;`);
 	}
 	const setNewName = `setNew${caseName}`;
-	if (hasPrototype(cls, setNewName) === false && setNew) {
+	if (hasPrototype(cls, setNewName) === false) {
 		setPrototype(
 			cls,
 			setNewName,
@@ -562,8 +560,8 @@ var GrafanaItemClassBuilder = class {
 	* @param {string} [option.name]
 	* @param {(instance: T) => void} [option.onInit]
 	* @param {(metaOptions: GenericMetaOptions) => T} [option.onDefault]
-	* @param {Boolean} [option.setNew]
 	* @param {String} [option.typeName]
+	* @param {String} [option.setNew]
 	* @return {this}
 	*/
 	defineGrafanaObject(key, type, option) {
@@ -837,7 +835,7 @@ var OverrideProperty = defineGrafanaItemClass("OverrideProperty", GrafanaItem).d
 var Datasource = defineGrafanaItemClass("Datasource", GrafanaItem).defineValue("type", String).defineValue("uid", String).asClass;
 //#endregion
 //#region src/items/Annotation.js
-var Annotation = defineGrafanaItemClass("Annotation", GrafanaItem).defineValue("builtIn", Number).defineGrafanaObject("datasource", Datasource, { setNew: true }).defineValue("enable", Boolean).defineValue("hide", Boolean).defineValue("iconColor", String).defineValue("name", String).defineValue("type", String).asClass;
+var Annotation = defineGrafanaItemClass("Annotation", GrafanaItem).defineValue("builtIn", Number).defineGrafanaObject("datasource", Datasource).defineValue("enable", Boolean).defineValue("hide", Boolean).defineValue("iconColor", String).defineValue("name", String).defineValue("type", String).asClass;
 //#endregion
 //#region src/items/Annotations.js
 var Annotations = defineGrafanaItemClass("Annotations", GrafanaItem).defineArray("list", Annotation, { itemName: "annotation" }).asClass;
@@ -900,7 +898,7 @@ code: (thresholds, value, color) => {
 } }).asClass;
 //#endregion
 //#region src/items/FieldConfigDefault.js
-var FieldConfigDefault = defineGrafanaItemClass("FieldConfigDefault", GrafanaItem).defineGrafanaObject("color", Color, { setNew: true }).defineGrafanaObject("custom", FieldConfigCustom, {}).defineValue("decimals", Number).defineValue("fieldMinMax", Boolean).defineArray("mappings", Mapping).defineValue("max", Number).defineValue("min", Number).defineGrafanaObject("thresholds", Thresholds, {}).defineValue("unit", String).defineMethod("setColorMode", "(mode: string): this;", { 
+var FieldConfigDefault = defineGrafanaItemClass("FieldConfigDefault", GrafanaItem).defineGrafanaObject("color", Color).defineGrafanaObject("custom", FieldConfigCustom).defineValue("decimals", Number).defineValue("fieldMinMax", Boolean).defineArray("mappings", Mapping).defineValue("max", Number).defineValue("min", Number).defineGrafanaObject("thresholds", Thresholds).defineValue("unit", String).defineMethod("setColorMode", "(mode: string): this;", { 
 /**
 * @param {FieldConfigDefault} fieldConfigDefault
 * @param {String} mode
@@ -913,13 +911,13 @@ code: (fieldConfigDefault, mode) => {
 } }).asClass;
 //#endregion
 //#region src/items/FieldConfigOverride.js
-var FieldConfigOverride = defineGrafanaItemClass("FieldConfigOverride", GrafanaItem).defineValue("__systemRef", String, { name: "systemRef" }).defineGrafanaObject("matcher", OverrideMatcher, { setNew: true }).defineArray("properties", OverrideProperty, { itemName: "property" }).asClass;
+var FieldConfigOverride = defineGrafanaItemClass("FieldConfigOverride", GrafanaItem).defineValue("__systemRef", String, { name: "systemRef" }).defineGrafanaObject("matcher", OverrideMatcher).defineArray("properties", OverrideProperty, { itemName: "property" }).asClass;
 //#endregion
 //#region src/items/HideFrom.js
 var HideFrom = defineGrafanaItemClass("HideFrom", GrafanaItem).defineValue("graph", Boolean).defineValue("legend", Boolean).defineValue("tooltip", Boolean).defineValue("viz", Boolean).asClass;
 //#endregion
 //#region src/items/FieldConfig.js
-var FieldConfig = defineGrafanaItemClass("FieldConfig", GrafanaItem).defineGrafanaObject("defaults", FieldConfigDefault, {}).defineArray("overrides", FieldConfigOverride).defineMethod("addNewOverrideHideSeriesFrom", "(names: string[]): this", { 
+var FieldConfig = defineGrafanaItemClass("FieldConfig", GrafanaItem).defineGrafanaObject("defaults", FieldConfigDefault).defineArray("overrides", FieldConfigOverride).defineMethod("addNewOverrideHideSeriesFrom", "(names: string[]): this", { 
 /**
 * @param {FieldConfig} fieldConfig
 * @param {String[]} names
@@ -935,7 +933,7 @@ code: (fieldConfig, names) => {
 } }).asClass;
 //#endregion
 //#region src/items/Target.js
-var Target = defineGrafanaItemClass("Target", GrafanaItem).defineValue("alias", String).defineValue("refId", String).defineValue("query", String).defineGrafanaObject("datasource", Datasource, { setNew: true }).defineValue("seriesCount", Number).defineValue("scenarioId", String).defineValue("stringInput", String).asClass;
+var Target = defineGrafanaItemClass("Target", GrafanaItem).defineValue("alias", String).defineValue("refId", String).defineValue("query", String).defineGrafanaObject("datasource", Datasource).defineValue("seriesCount", Number).defineValue("scenarioId", String).defineValue("stringInput", String).asClass;
 //#endregion
 //#region src/items/Link.js
 var Link = defineGrafanaItemClass("Link", GrafanaItem).defineConstructor((instance) => instance.setType("link")).defineValue("asDropdown", Boolean).defineValue("icon", String).defineValue("includeVars", Boolean).defineValue("keepTime", Boolean).defineArray("tags", String, { setEmpty: true }).defineValue("targetBlank", Boolean).defineValue("title", String).defineValue("tooltip", String).defineValue("type", String).defineValue("url", String).asClass;
@@ -944,7 +942,7 @@ var Link = defineGrafanaItemClass("Link", GrafanaItem).defineConstructor((instan
 var DataTransformation = defineGrafanaItemClass("DataTransformation", GrafanaItem).asClass;
 //#endregion
 //#region src/items/Panel.js
-var Panel = defineGrafanaItemClass("Panel", GrafanaItem).defineValue("cacheTimeout", String).defineGrafanaObject("datasource", Datasource, { onDefault: (options) => void 0 }).defineValue("description", String).defineGrafanaObject("fieldConfig", FieldConfig, { onDefault: (options) => new FieldConfig(options) }).defineGrafanaObject("gridPos", GridPos, { setNew: true }).defineMethod("setPos", "(x: number, y: number, w: number, h: number): this;", { 
+var Panel = defineGrafanaItemClass("Panel", GrafanaItem).defineValue("cacheTimeout", String).defineGrafanaObject("datasource", Datasource, { onDefault: (options) => void 0 }).defineValue("description", String).defineGrafanaObject("fieldConfig", FieldConfig, { onDefault: (options) => new FieldConfig(options) }).defineGrafanaObject("gridPos", GridPos).defineMethod("setPos", "(x: number, y: number, w: number, h: number): this;", { 
 /**
 * @param {Panel} panel
 * @param {number} x
@@ -972,7 +970,7 @@ var TemplateCurrent = defineGrafanaItemClass("TemplateCurrent", GrafanaItem).def
 var TemplateOption = defineGrafanaItemClass("TemplateOption", GrafanaItem).defineValue("selected", Boolean).defineValue("text", String).defineValue("value", String).asClass;
 //#endregion
 //#region src/items/Template.js
-var Template = defineGrafanaItemClass("Template", GrafanaItem).defineGrafanaObject("current", TemplateCurrent, { setNew: true }).defineValue("definition", String).defineValue("description", String).defineValue("hide", Number).defineValue("label", String).defineValue("multi", Boolean).defineValue("name", String).defineArray("options", TemplateOption).defineValue("query", Object).defineValue("refresh", Number).defineValue("regex", String).defineValue("sort", Number).defineValue("type", String).defineValue("useTags", Boolean).asClass;
+var Template = defineGrafanaItemClass("Template", GrafanaItem).defineGrafanaObject("current", TemplateCurrent).defineValue("definition", String).defineValue("description", String).defineValue("hide", Number).defineValue("label", String).defineValue("multi", Boolean).defineValue("name", String).defineArray("options", TemplateOption).defineValue("query", Object).defineValue("refresh", Number).defineValue("regex", String).defineValue("sort", Number).defineValue("type", String).defineValue("useTags", Boolean).asClass;
 //#endregion
 //#region src/items/Templating.js
 var Templating = defineGrafanaItemClass("Templating", GrafanaItem).defineArray("list", Template, { itemName: "template" }).asClass;
@@ -1080,7 +1078,7 @@ var FieldConfigCustomGauge = defineGrafanaItemClass("FieldConfigCustomGauge", Fi
 var FieldConfigCustomGeomap = defineGrafanaItemClass("FieldConfigCustomGeomap", FieldConfigCustom).defineGrafanaObject("hideFrom", HideFrom, { onDefault: (options) => new HideFrom(options).setLegend(false).setTooltip(false).setViz(false) }).asClass;
 //#endregion
 //#region src/items/FieldConfigCustomPieChart.js
-var FieldConfigCustomPieChart = defineGrafanaItemClass("FieldConfigCustomPieChart", FieldConfigCustom).asClass;
+var FieldConfigCustomPieChart = defineGrafanaItemClass("FieldConfigCustomPieChart", FieldConfigCustom).with((builder) => defineHideableFieldConfig(builder)).asClass;
 //#endregion
 //#region src/items/LineStyle.js
 var LineStyle = defineGrafanaItemClass("LineStyle", GrafanaItem).defineValue("fill", String).asClass;
@@ -1143,7 +1141,7 @@ var PanelOptionsGaugeEffect = defineGrafanaItemClass("PanelOptionsGaugeEffect",
 var PanelOptionsGaugeReduceOptions = defineGrafanaItemClass("PanelOptionsGaugeReduceOptions", GrafanaItem).defineArray("calcs", String, { setEmpty: true }).defineValue("fields", String).defineValue("limit", Number).defineValue("values", Boolean).asClass;
 //#endregion
 //#region src/items/PanelOptionsGauge.js
-var PanelOptionsGauge = defineGrafanaItemClass("PanelOptionsGauge", PanelOptions).defineValue("barShape", String).defineValue("barWidthFactor", Number).defineGrafanaObject("effects", PanelOptionsGaugeEffect, { setNew: true }).defineValue("endpointMarker", String).defineValue("minVizHeight", Number).defineValue("minVizWidth", Number).defineValue("orientation", String).defineGrafanaObject("reduceOptions", PanelOptionsGaugeReduceOptions, { setNew: true }).defineValue("segmentCount", Number).defineValue("segmentSpacing", Number).defineValue("shape", String).defineValue("showThresholdLabels", Boolean).defineValue("showThresholdMarkers", Boolean).defineValue("sizing", String).defineValue("sparkline", Boolean).defineValue("textMode", String).asClass;
+var PanelOptionsGauge = defineGrafanaItemClass("PanelOptionsGauge", PanelOptions).defineValue("barShape", String).defineValue("barWidthFactor", Number).defineGrafanaObject("effects", PanelOptionsGaugeEffect).defineValue("endpointMarker", String).defineValue("minVizHeight", Number).defineValue("minVizWidth", Number).defineValue("orientation", String).defineGrafanaObject("reduceOptions", PanelOptionsGaugeReduceOptions).defineValue("segmentCount", Number).defineValue("segmentSpacing", Number).defineValue("shape", String).defineValue("showThresholdLabels", Boolean).defineValue("showThresholdMarkers", Boolean).defineValue("sizing", String).defineValue("sparkline", Boolean).defineValue("textMode", String).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomapBasemap.js
 var PanelOptionsGeomapBasemap = defineGrafanaItemClass("PanelOptionsGeomapBasemap", GrafanaItem).defineObject("config", Object).defineValue("name", String).defineValue("noRepeat", Boolean).defineValue("type", String).asClass;
@@ -1173,16 +1171,13 @@ var StyleTextConfig = defineGrafanaItemClass("StyleTextConfig", GrafanaItem).def
 var PanelOptionsGeomapLayerConfigStyle = defineGrafanaItemClass("PanelOptionsGeomapLayerConfigStyle", GrafanaItem).defineGrafanaObject("color", StyleColor, { onDefault: (options) => new StyleColor(options) }).defineValue("opacity", Number, { onDefault: (options) => 1 }).defineGrafanaObject("rotation", StyleRotation, { onDefault: (options) => new StyleRotation(options) }).defineGrafanaObject("size", StyleSize, { onDefault: (options) => new StyleSize(options) }).defineGrafanaObject("symbol", StyleSymbol, { onDefault: (options) => new StyleSymbol(options) }).defineGrafanaObject("symbolAlign", StyleSymbolAlign, { onDefault: (options) => new StyleSymbolAlign(options) }).defineGrafanaObject("textConfig", StyleTextConfig, { onDefault: (options) => new StyleTextConfig(options) }).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomapLayerConfig.js
-var PanelOptionsGeomapLayerConfig = defineGrafanaItemClass("PanelOptionsGeomapLayerConfig", GrafanaItem).defineValue("showLegend", Boolean).defineGrafanaObject("style", PanelOptionsGeomapLayerConfigStyle, {
-	onDefault: (options) => new PanelOptionsGeomapLayerConfigStyle(options),
-	setNew: true
-}).asClass;
+var PanelOptionsGeomapLayerConfig = defineGrafanaItemClass("PanelOptionsGeomapLayerConfig", GrafanaItem).defineValue("showLegend", Boolean).defineGrafanaObject("style", PanelOptionsGeomapLayerConfigStyle, { onDefault: (options) => new PanelOptionsGeomapLayerConfigStyle(options) }).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomapLayerLocation.js
 var PanelOptionsGeomapLayerLocation = defineGrafanaItemClass("PanelOptionsGeomapLayerLocation", GrafanaItem).defineValue("mode", String).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomapLayer.js
-var PanelOptionsGeomapLayer = defineGrafanaItemClass("PanelOptionsGeomapLayer", GrafanaItem).defineGrafanaObject("config", PanelOptionsGeomapLayerConfig, { setNew: true }).defineGrafanaObject("location", PanelOptionsGeomapLayerLocation, { setNew: true }).defineValue("name", String).defineValue("tooltip", Boolean).defineValue("type", String).asClass;
+var PanelOptionsGeomapLayer = defineGrafanaItemClass("PanelOptionsGeomapLayer", GrafanaItem).defineGrafanaObject("config", PanelOptionsGeomapLayerConfig).defineGrafanaObject("location", PanelOptionsGeomapLayerLocation).defineValue("name", String).defineValue("tooltip", Boolean).defineValue("type", String).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomapTooltip.js
 var PanelOptionsGeomapTooltip = defineGrafanaItemClass("PanelOptionsGeomapTooltip", GrafanaItem).defineValue("mode", String).asClass;
@@ -1191,10 +1186,13 @@ var PanelOptionsGeomapTooltip = defineGrafanaItemClass("PanelOptionsGeomapToolti
 var PanelOptionsGeomapView = defineGrafanaItemClass("PanelOptionsGeomapView", GrafanaItem).defineValue("allLayers", Boolean).defineValue("id", String).defineValue("lat", Number).defineValue("lon", Number).defineValue("noRepeat", Boolean).defineValue("shared", Boolean).defineValue("zoom", Number).asClass;
 //#endregion
 //#region src/items/PanelOptionsGeomap.js
-var PanelOptionsGeomap = defineGrafanaItemClass("PanelOptionsGeomap", PanelOptions).defineGrafanaObject("basemap", PanelOptionsGeomapBasemap, { setNew: true }).defineGrafanaObject("controls", PanelOptionsGeomapControls, { setNew: true }).defineArray("layers", PanelOptionsGeomapLayer).defineGrafanaObject("tooltip", PanelOptionsGeomapTooltip, { setNew: true }).defineGrafanaObject("view", PanelOptionsGeomapView, { setNew: true }).asClass;
+var PanelOptionsGeomap = defineGrafanaItemClass("PanelOptionsGeomap", PanelOptions).defineGrafanaObject("basemap", PanelOptionsGeomapBasemap).defineGrafanaObject("controls", PanelOptionsGeomapControls).defineArray("layers", PanelOptionsGeomapLayer).defineGrafanaObject("tooltip", PanelOptionsGeomapTooltip).defineGrafanaObject("view", PanelOptionsGeomapView).asClass;
+//#endregion
+//#region src/items/PieChartLegendOptions.js
+var PieChartLegendOptions = defineGrafanaItemClass("PieChartLegendOptions", VizLegendOptions).defineArray("values", String).asClass;
 //#endregion
 //#region src/items/PanelOptionsPieChart.js
-var PanelOptionsPieChart = defineGrafanaItemClass("PanelOptionsPieChart", PanelOptions).asClass;
+var PanelOptionsPieChart = defineGrafanaItemClass("PanelOptionsPieChart", PanelOptions).defineArray("displayLabels", String).defineGrafanaObject("legend", PieChartLegendOptions).defineValue("pieType", String).defineValue("sort", String).defineGrafanaObject("tooltip", VizTooltipOptions).asClass;
 //#endregion
 //#region src/items/PanelOptionsStat.js
 var PanelOptionsStat = defineGrafanaItemClass("PanelOptionsStat", PanelOptions).asClass;
@@ -1251,10 +1249,7 @@ var definePanel = (builder, typeName, fieldConfigCustom, panelOptions, options)
 			code(instance.fieldConfig.defaults.custom);
 			return instance;
 		}
-	}).defineGrafanaObject("options", panelOptions, {
-		setNew: true,
-		onDefault: (options) => new panelOptions(options)
-	});
+	}).defineGrafanaObject("options", panelOptions, { onDefault: (options) => new panelOptions(options) });
 };
 //#endregion
 //#region src/items/TextPanel.js
@@ -1301,6 +1296,6 @@ var TimeSeries = defineGrafanaItemClass("TimeSeries", Panel).with((builder) => d
 	return instance;
 } }).asClass;
 //#endregion
-export { Annotation, Annotations, BarChart, Color, Dashboard, DataTransformation, Datasource, DatasourceInfinity, FieldConfig, FieldConfigCustom, FieldConfigCustomBarChart, FieldConfigCustomGauge, FieldConfigCustomGeomap, FieldConfigCustomPieChart, FieldConfigCustomTable, FieldConfigCustomTableCellOptions, FieldConfigCustomTableFooter, FieldConfigCustomTimeSerie, FieldConfigDefault, FieldConfigOverride, Gauge, Geomap, GrafanaItem, GridPos, HideFrom, Influxdb, LineStyle, Link, Mapping, OverrideMatcher, OverrideMatcherOptionsByNames, OverrideProperty, Panel, PanelOptions, PanelOptionsBarChart, PanelOptionsGauge, PanelOptionsGaugeEffect, PanelOptionsGaugeReduceOptions, PanelOptionsGeomap, PanelOptionsGeomapBasemap, PanelOptionsGeomapControls, PanelOptionsGeomapLayer, PanelOptionsGeomapLayerConfig, PanelOptionsGeomapLayerConfigStyle, PanelOptionsGeomapLayerLocation, PanelOptionsGeomapTooltip, PanelOptionsGeomapView, PanelOptionsPieChart, PanelOptionsStat, PanelOptionsTable, PanelOptionsTableSortBy, PanelOptionsText, PanelOptionsTextCode, PanelOptionsTimeSeries, PieChart, ScaleDistribution, Stacking, Stat, StyleColor, StyleRotation, StyleSize, StyleSymbol, StyleSymbolAlign, StyleTextConfig, Table, Target, TargetInfinity, Template, TemplateCurrent, TemplateOption, Templating, Testdata, TextPanel, ThresholdStyle, Thresholds, ThresholdsStep, TimePicker, TimeRange, TimeSeries, VizLegendOptions, VizTextDisplayOptions, VizTooltipOptions };
+export { Annotation, Annotations, BarChart, Color, Dashboard, DataTransformation, Datasource, DatasourceInfinity, FieldConfig, FieldConfigCustom, FieldConfigCustomBarChart, FieldConfigCustomGauge, FieldConfigCustomGeomap, FieldConfigCustomPieChart, FieldConfigCustomTable, FieldConfigCustomTableCellOptions, FieldConfigCustomTableFooter, FieldConfigCustomTimeSerie, FieldConfigDefault, FieldConfigOverride, Gauge, Geomap, GrafanaItem, GridPos, HideFrom, Influxdb, LineStyle, Link, Mapping, OverrideMatcher, OverrideMatcherOptionsByNames, OverrideProperty, Panel, PanelOptions, PanelOptionsBarChart, PanelOptionsGauge, PanelOptionsGaugeEffect, PanelOptionsGaugeReduceOptions, PanelOptionsGeomap, PanelOptionsGeomapBasemap, PanelOptionsGeomapControls, PanelOptionsGeomapLayer, PanelOptionsGeomapLayerConfig, PanelOptionsGeomapLayerConfigStyle, PanelOptionsGeomapLayerLocation, PanelOptionsGeomapTooltip, PanelOptionsGeomapView, PanelOptionsPieChart, PanelOptionsStat, PanelOptionsTable, PanelOptionsTableSortBy, PanelOptionsText, PanelOptionsTextCode, PanelOptionsTimeSeries, PieChart, PieChartLegendOptions, ScaleDistribution, Stacking, Stat, StyleColor, StyleRotation, StyleSize, StyleSymbol, StyleSymbolAlign, StyleTextConfig, Table, Target, TargetInfinity, Template, TemplateCurrent, TemplateOption, Templating, Testdata, TextPanel, ThresholdStyle, Thresholds, ThresholdsStep, TimePicker, TimeRange, TimeSeries, VizLegendOptions, VizTextDisplayOptions, VizTooltipOptions };
 
 //# sourceMappingURL=index.js.map