@intentius/chant-lexicon-grafana 0.97.0 → 0.99.0

package/src/spec/schemas/piechart.jsonschema.json

@@ -0,0 +1,275 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "PieChartType": {
+      "enum": [
+        "pie",
+        "donut"
+      ],
+      "type": "string",
+      "description": "Select the pie chart display style."
+    },
+    "PieChartLabels": {
+      "enum": [
+        "name",
+        "value",
+        "percent"
+      ],
+      "type": "string",
+      "description": "Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value."
+    },
+    "PieChartLegendValues": {
+      "enum": [
+        "value",
+        "percent"
+      ],
+      "type": "string",
+      "description": "Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value."
+    },
+    "PieChartLegendOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "values",
+        "displayMode",
+        "placement",
+        "showLegend",
+        "calcs"
+      ],
+      "properties": {
+        "values": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PieChartLegendValues"
+          }
+        },
+        "displayMode": {
+          "$ref": "#/definitions/LegendDisplayMode"
+        },
+        "placement": {
+          "$ref": "#/definitions/LegendPlacement"
+        },
+        "showLegend": {
+          "type": "boolean"
+        },
+        "asTable": {
+          "type": "boolean"
+        },
+        "isVisible": {
+          "type": "boolean"
+        },
+        "sortBy": {
+          "type": "string"
+        },
+        "sortDesc": {
+          "type": "boolean"
+        },
+        "width": {
+          "type": "number"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "pieType",
+        "tooltip",
+        "reduceOptions",
+        "legend",
+        "orientation"
+      ],
+      "properties": {
+        "pieType": {
+          "$ref": "#/definitions/PieChartType"
+        },
+        "displayLabels": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PieChartLabels"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "tooltip": {
+          "$ref": "#/definitions/VizTooltipOptions"
+        },
+        "reduceOptions": {
+          "$ref": "#/definitions/ReduceDataOptions"
+        },
+        "text": {
+          "$ref": "#/definitions/VizTextDisplayOptions"
+        },
+        "legend": {
+          "$ref": "#/definitions/PieChartLegendOptions"
+        },
+        "orientation": {
+          "$ref": "#/definitions/VizOrientation"
+        }
+      }
+    },
+    "FieldConfig": {
+      "$ref": "#/definitions/HideableFieldConfig"
+    },
+    "LegendDisplayMode": {
+      "enum": [
+        "list",
+        "table",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility"
+    },
+    "LegendPlacement": {
+      "enum": [
+        "bottom",
+        "right"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "VizTooltipOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mode",
+        "sort"
+      ],
+      "properties": {
+        "mode": {
+          "$ref": "#/definitions/TooltipDisplayMode"
+        },
+        "sort": {
+          "$ref": "#/definitions/SortOrder"
+        },
+        "maxWidth": {
+          "type": "number"
+        },
+        "maxHeight": {
+          "type": "number"
+        },
+        "hideZeros": {
+          "type": "boolean"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "ReduceDataOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "calcs"
+      ],
+      "properties": {
+        "values": {
+          "type": "boolean",
+          "description": "If true show each row value"
+        },
+        "limit": {
+          "type": "number",
+          "description": "if showing all values limit"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "When !values, pick one value for the whole field"
+        },
+        "fields": {
+          "type": "string",
+          "description": "Which fields to show.  By default this is only numeric fields"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizTextDisplayOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "titleSize": {
+          "type": "number",
+          "description": "Explicit title text size"
+        },
+        "valueSize": {
+          "type": "number",
+          "description": "Explicit value text size"
+        },
+        "percentSize": {
+          "type": "number",
+          "description": "Explicit percent text size"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizOrientation": {
+      "enum": [
+        "auto",
+        "vertical",
+        "horizontal"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "HideableFieldConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "hideFrom": {
+          "$ref": "#/definitions/HideSeriesConfig"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "TooltipDisplayMode": {
+      "enum": [
+        "single",
+        "multi",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "SortOrder": {
+      "enum": [
+        "asc",
+        "desc",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "HideSeriesConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "tooltip",
+        "legend",
+        "viz"
+      ],
+      "properties": {
+        "tooltip": {
+          "type": "boolean"
+        },
+        "legend": {
+          "type": "boolean"
+        },
+        "viz": {
+          "type": "boolean"
+        }
+      },
+      "description": "TODO docs"
+    }
+  }
+}

package/src/spec/schemas/statetimeline.jsonschema.json

@@ -0,0 +1,324 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "showValue",
+        "rowHeight",
+        "legend",
+        "tooltip"
+      ],
+      "properties": {
+        "showValue": {
+          "$ref": "#/definitions/VisibilityMode",
+          "description": "Show timeline values on chart",
+          "default": "auto"
+        },
+        "rowHeight": {
+          "type": "number",
+          "maximum": 1,
+          "description": "Controls the row height",
+          "default": 0.9
+        },
+        "mergeValues": {
+          "type": "boolean",
+          "description": "Merge equal consecutive values",
+          "default": true
+        },
+        "alignValue": {
+          "$ref": "#/definitions/TimelineValueAlignment",
+          "description": "Controls value alignment on the timelines",
+          "default": "left"
+        },
+        "legend": {
+          "$ref": "#/definitions/VizLegendOptions"
+        },
+        "tooltip": {
+          "$ref": "#/definitions/VizTooltipOptions"
+        },
+        "timezone": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TimeZone"
+          }
+        },
+        "perPage": {
+          "type": "number",
+          "minimum": 1,
+          "description": "Enables pagination when \u003e 0",
+          "default": 20
+        }
+      }
+    },
+    "FieldConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "lineWidth": {
+          "type": "integer",
+          "maximum": 10,
+          "default": 0
+        },
+        "axisPlacement": {
+          "$ref": "#/definitions/AxisPlacement"
+        },
+        "axisColorMode": {
+          "$ref": "#/definitions/AxisColorMode"
+        },
+        "axisLabel": {
+          "type": "string"
+        },
+        "axisWidth": {
+          "type": "number"
+        },
+        "axisSoftMin": {
+          "type": "number"
+        },
+        "axisSoftMax": {
+          "type": "number"
+        },
+        "axisGridShow": {
+          "type": "boolean"
+        },
+        "scaleDistribution": {
+          "$ref": "#/definitions/ScaleDistributionConfig"
+        },
+        "axisCenteredZero": {
+          "type": "boolean"
+        },
+        "hideFrom": {
+          "$ref": "#/definitions/HideSeriesConfig"
+        },
+        "fillOpacity": {
+          "type": "integer",
+          "maximum": 100,
+          "default": 70
+        },
+        "axisBorderShow": {
+          "type": "boolean"
+        },
+        "spanNulls": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "integer"
+            }
+          ]
+        },
+        "insertNulls": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "integer"
+            }
+          ]
+        }
+      }
+    },
+    "VisibilityMode": {
+      "enum": [
+        "auto",
+        "never",
+        "always"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "TimelineValueAlignment": {
+      "enum": [
+        "center",
+        "left",
+        "right"
+      ],
+      "type": "string",
+      "description": "Controls the value alignment in the TimelineChart component"
+    },
+    "VizLegendOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "displayMode",
+        "placement",
+        "showLegend",
+        "calcs"
+      ],
+      "properties": {
+        "displayMode": {
+          "$ref": "#/definitions/LegendDisplayMode",
+          "default": "list"
+        },
+        "placement": {
+          "$ref": "#/definitions/LegendPlacement",
+          "default": "bottom"
+        },
+        "showLegend": {
+          "type": "boolean"
+        },
+        "asTable": {
+          "type": "boolean"
+        },
+        "isVisible": {
+          "type": "boolean"
+        },
+        "sortBy": {
+          "type": "string"
+        },
+        "sortDesc": {
+          "type": "boolean"
+        },
+        "width": {
+          "type": "number"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizTooltipOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mode",
+        "sort"
+      ],
+      "properties": {
+        "mode": {
+          "$ref": "#/definitions/TooltipDisplayMode"
+        },
+        "sort": {
+          "$ref": "#/definitions/SortOrder"
+        },
+        "maxWidth": {
+          "type": "number"
+        },
+        "maxHeight": {
+          "type": "number"
+        },
+        "hideZeros": {
+          "type": "boolean"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "TimeZone": {
+      "type": "string",
+      "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database"
+    },
+    "AxisPlacement": {
+      "enum": [
+        "auto",
+        "top",
+        "right",
+        "bottom",
+        "left",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "AxisColorMode": {
+      "enum": [
+        "text",
+        "series"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "ScaleDistributionConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "$ref": "#/definitions/ScaleDistribution"
+        },
+        "log": {
+          "type": "number"
+        },
+        "linearThreshold": {
+          "type": "number"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "HideSeriesConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "tooltip",
+        "legend",
+        "viz"
+      ],
+      "properties": {
+        "tooltip": {
+          "type": "boolean"
+        },
+        "legend": {
+          "type": "boolean"
+        },
+        "viz": {
+          "type": "boolean"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "LegendDisplayMode": {
+      "enum": [
+        "list",
+        "table",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility"
+    },
+    "LegendPlacement": {
+      "enum": [
+        "bottom",
+        "right"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "TooltipDisplayMode": {
+      "enum": [
+        "single",
+        "multi",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "SortOrder": {
+      "enum": [
+        "asc",
+        "desc",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "ScaleDistribution": {
+      "enum": [
+        "linear",
+        "log",
+        "ordinal",
+        "symlog"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    }
+  }
+}