@intentius/chant-lexicon-grafana 0.96.0

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

@@ -0,0 +1,751 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "frameIndex",
+        "showHeader"
+      ],
+      "properties": {
+        "frameIndex": {
+          "type": "number",
+          "description": "Represents the index of the selected frame",
+          "default": 0
+        },
+        "showHeader": {
+          "type": "boolean",
+          "description": "Controls whether the panel should show the header",
+          "default": true
+        },
+        "showTypeIcons": {
+          "type": "boolean",
+          "description": "Controls whether the header should show icons for the column types",
+          "default": false
+        },
+        "sortBy": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TableSortByFieldState"
+          },
+          "description": "Used to control row sorting"
+        },
+        "footer": {
+          "$ref": "#/definitions/TableFooterOptions",
+          "description": "Controls footer options",
+          "default": {
+            "countRows": false,
+            "reducer": null,
+            "show": false
+          }
+        },
+        "cellHeight": {
+          "$ref": "#/definitions/TableCellHeight",
+          "description": "Controls the height of the rows",
+          "default": "sm"
+        }
+      }
+    },
+    "FieldConfig": {
+      "$ref": "#/definitions/TableFieldOptions"
+    },
+    "TableSortByFieldState": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "displayName"
+      ],
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "description": "Sets the display name of the field to sort by"
+        },
+        "desc": {
+          "type": "boolean",
+          "description": "Flag used to indicate descending sort order"
+        }
+      },
+      "description": "Sort by field state"
+    },
+    "TableFooterOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "show",
+        "reducer"
+      ],
+      "properties": {
+        "show": {
+          "type": "boolean"
+        },
+        "reducer": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "actually 1 value"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "enablePagination": {
+          "type": "boolean"
+        },
+        "countRows": {
+          "type": "boolean"
+        }
+      },
+      "description": "Footer options"
+    },
+    "TableCellHeight": {
+      "enum": [
+        "sm",
+        "md",
+        "lg",
+        "auto"
+      ],
+      "type": "string",
+      "description": "Height of a table cell"
+    },
+    "TableFieldOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "align",
+        "inspect"
+      ],
+      "properties": {
+        "width": {
+          "type": "number"
+        },
+        "minWidth": {
+          "type": "number"
+        },
+        "align": {
+          "$ref": "#/definitions/FieldTextAlignment",
+          "default": "auto"
+        },
+        "displayMode": {
+          "$ref": "#/definitions/TableCellDisplayMode",
+          "description": "This field is deprecated in favor of using cellOptions"
+        },
+        "cellOptions": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/TableCellOptions"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "hidden": {
+          "type": "boolean",
+          "description": "?? default is missing or false ??"
+        },
+        "inspect": {
+          "type": "boolean",
+          "default": false
+        },
+        "filterable": {
+          "type": "boolean"
+        },
+        "hideHeader": {
+          "type": "boolean",
+          "description": "Hides any header for a column, useful for columns that show some static content or buttons."
+        }
+      },
+      "description": "Field options for each field within a table (e.g 10, \"The String\", 64.20, etc.)\nGenerally defines alignment, filtering capabilties, display options, etc."
+    },
+    "FieldTextAlignment": {
+      "enum": [
+        "auto",
+        "left",
+        "right",
+        "center"
+      ],
+      "type": "string",
+      "description": "TODO -- should not be table specific!\nTODO docs"
+    },
+    "TableCellDisplayMode": {
+      "enum": [
+        "auto",
+        "color-text",
+        "color-background",
+        "color-background-solid",
+        "gradient-gauge",
+        "lcd-gauge",
+        "json-view",
+        "basic",
+        "image",
+        "gauge",
+        "sparkline",
+        "data-links",
+        "custom",
+        "actions"
+      ],
+      "type": "string",
+      "description": "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions"
+    },
+    "TableCellOptions": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/TableAutoCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableSparklineCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableBarGaugeCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableColoredBackgroundCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableColorTextCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableImageCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableDataLinksCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableActionsCellOptions"
+        },
+        {
+          "$ref": "#/definitions/TableJsonViewCellOptions"
+        }
+      ],
+      "description": "Table cell options. Each cell has a display mode\nand other potential options for that display."
+    },
+    "TableAutoCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "auto"
+        },
+        "wrapText": {
+          "type": "boolean"
+        }
+      },
+      "description": "Auto mode table cell options"
+    },
+    "TableSparklineCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "sparkline"
+        },
+        "drawStyle": {
+          "$ref": "#/definitions/GraphDrawStyle"
+        },
+        "gradientMode": {
+          "$ref": "#/definitions/GraphGradientMode"
+        },
+        "thresholdsStyle": {
+          "$ref": "#/definitions/GraphThresholdsStyleConfig"
+        },
+        "transform": {
+          "$ref": "#/definitions/GraphTransform"
+        },
+        "lineColor": {
+          "type": "string"
+        },
+        "lineWidth": {
+          "type": "number"
+        },
+        "lineInterpolation": {
+          "$ref": "#/definitions/LineInterpolation"
+        },
+        "lineStyle": {
+          "$ref": "#/definitions/LineStyle"
+        },
+        "fillColor": {
+          "type": "string"
+        },
+        "fillOpacity": {
+          "type": "number"
+        },
+        "showPoints": {
+          "$ref": "#/definitions/VisibilityMode"
+        },
+        "pointSize": {
+          "type": "number"
+        },
+        "pointColor": {
+          "type": "string"
+        },
+        "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"
+        },
+        "barAlignment": {
+          "$ref": "#/definitions/BarAlignment"
+        },
+        "barWidthFactor": {
+          "type": "number"
+        },
+        "stacking": {
+          "$ref": "#/definitions/StackingConfig"
+        },
+        "hideFrom": {
+          "$ref": "#/definitions/HideSeriesConfig"
+        },
+        "hideValue": {
+          "type": "boolean"
+        },
+        "insertNulls": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ]
+        },
+        "spanNulls": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected.  For timeseries, this is milliseconds"
+        },
+        "fillBelowTo": {
+          "type": "string"
+        },
+        "pointSymbol": {
+          "type": "string"
+        },
+        "axisBorderShow": {
+          "type": "boolean"
+        },
+        "barMaxWidth": {
+          "type": "number"
+        }
+      },
+      "description": "Sparkline cell options"
+    },
+    "TableBarGaugeCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "gauge"
+        },
+        "mode": {
+          "$ref": "#/definitions/BarGaugeDisplayMode"
+        },
+        "valueDisplayMode": {
+          "$ref": "#/definitions/BarGaugeValueMode"
+        }
+      },
+      "description": "Gauge cell options"
+    },
+    "TableColoredBackgroundCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "color-background"
+        },
+        "mode": {
+          "$ref": "#/definitions/TableCellBackgroundDisplayMode"
+        },
+        "applyToRow": {
+          "type": "boolean"
+        },
+        "wrapText": {
+          "type": "boolean"
+        }
+      },
+      "description": "Colored background cell options"
+    },
+    "TableColorTextCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "color-text"
+        },
+        "wrapText": {
+          "type": "boolean"
+        }
+      },
+      "description": "Colored text cell options"
+    },
+    "TableImageCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "image"
+        },
+        "alt": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "description": "Json view cell options"
+    },
+    "TableDataLinksCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "data-links"
+        }
+      },
+      "description": "Show data links in the cell"
+    },
+    "TableActionsCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "actions"
+        }
+      },
+      "description": "Show actions in the cell"
+    },
+    "TableJsonViewCellOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/TableCellDisplayMode"
+            }
+          ],
+          "default": "json-view"
+        }
+      },
+      "description": "Json view cell options"
+    },
+    "GraphDrawStyle": {
+      "enum": [
+        "line",
+        "bars",
+        "points"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "GraphGradientMode": {
+      "enum": [
+        "none",
+        "opacity",
+        "hue",
+        "scheme"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "GraphThresholdsStyleConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mode"
+      ],
+      "properties": {
+        "mode": {
+          "$ref": "#/definitions/GraphThresholdsStyleMode"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "GraphTransform": {
+      "enum": [
+        "constant",
+        "negative-Y"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "LineInterpolation": {
+      "enum": [
+        "linear",
+        "smooth",
+        "stepBefore",
+        "stepAfter"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "LineStyle": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "fill": {
+          "enum": [
+            "solid",
+            "dash",
+            "dot",
+            "square"
+          ],
+          "type": "string"
+        },
+        "dash": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VisibilityMode": {
+      "enum": [
+        "auto",
+        "never",
+        "always"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "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"
+    },
+    "BarAlignment": {
+      "enum": [
+        -1,
+        0,
+        1
+      ],
+      "type": "integer",
+      "description": "TODO docs"
+    },
+    "StackingConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "mode": {
+          "$ref": "#/definitions/StackingMode"
+        },
+        "group": {
+          "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"
+    },
+    "BarGaugeDisplayMode": {
+      "enum": [
+        "basic",
+        "lcd",
+        "gradient"
+      ],
+      "type": "string",
+      "description": "Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI"
+    },
+    "BarGaugeValueMode": {
+      "enum": [
+        "color",
+        "text",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "Allows for the table cell gauge display type to set the gauge mode."
+    },
+    "TableCellBackgroundDisplayMode": {
+      "enum": [
+        "basic",
+        "gradient"
+      ],
+      "type": "string",
+      "description": "Display mode to the \"Colored Background\" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient."
+    },
+    "GraphThresholdsStyleMode": {
+      "enum": [
+        "off",
+        "line",
+        "dashed",
+        "area",
+        "line+area",
+        "dashed+area",
+        "series"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "ScaleDistribution": {
+      "enum": [
+        "linear",
+        "log",
+        "ordinal",
+        "symlog"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "StackingMode": {
+      "enum": [
+        "none",
+        "normal",
+        "percent"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    }
+  }
+}