@astrato-io/visualizations 0.0.0-stage → 0.6.4

package/docs/operations/histogram.md

@@ -0,0 +1,1870 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# `histogram` operations
+
+Reference for `@astrato-io/visualizations@0.6.4`.
+
+[All visualization types](./index.md)
+
+Use each schema below for the request’s `payload`, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
+
+## Available operations
+
+- [`addDimension`](#adddimension)
+- [`addMeasureAxisBand`](#addmeasureaxisband)
+- [`duplicateDimension`](#duplicatedimension)
+- [`removeDimension`](#removedimension)
+- [`removeMeasureAxisBand`](#removemeasureaxisband)
+- [`setAnimationEnabled`](#setanimationenabled)
+- [`setAxisLabelColor`](#setaxislabelcolor)
+- [`setAxisLineColor`](#setaxislinecolor)
+- [`setAxisRangeMax`](#setaxisrangemax)
+- [`setAxisRangeMin`](#setaxisrangemin)
+- [`setAxisRangeOption`](#setaxisrangeoption)
+- [`setAxisStartsAtZero`](#setaxisstartsatzero)
+- [`setAxisTickColor`](#setaxistickcolor)
+- [`setAxisTitle`](#setaxistitle)
+- [`setAxisTitleColor`](#setaxistitlecolor)
+- [`setColoringType`](#setcoloringtype)
+- [`setDimensionFormatString`](#setdimensionformatstring)
+- [`setDimensionFormatType`](#setdimensionformattype)
+- [`setDimensionTemporalGrouping`](#setdimensiontemporalgrouping)
+- [`setEnableContinuousAxis`](#setenablecontinuousaxis)
+- [`setInvertAxis`](#setinvertaxis)
+- [`setLabelOverlap`](#setlabeloverlap)
+- [`setLegendEnabled`](#setlegendenabled)
+- [`setLegendItemLabelFill`](#setlegenditemlabelfill)
+- [`setLegendItemLabelFontSize`](#setlegenditemlabelfontsize)
+- [`setLegendItemLabelLimitCharacters`](#setlegenditemlabellimitcharacters)
+- [`setLegendItemLabelMaxGlyphCount`](#setlegenditemlabelmaxglyphcount)
+- [`setLegendPosition`](#setlegendposition)
+- [`setLegendTitle`](#setlegendtitle)
+- [`setMeasureAxisBands`](#setmeasureaxisbands)
+- [`setMeasureCurrency`](#setmeasurecurrency)
+- [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
+- [`setMeasureFormatString`](#setmeasureformatstring)
+- [`setMeasureFormatType`](#setmeasureformattype)
+- [`setMeasureNegativeType`](#setmeasurenegativetype)
+- [`setOrientation`](#setorientation)
+- [`setShowAxisLabels`](#setshowaxislabels)
+- [`setShowAxisLine`](#setshowaxisline)
+- [`setShowAxisTicks`](#setshowaxisticks)
+- [`setShowAxisTitle`](#setshowaxistitle)
+- [`setShowAxisTooltip`](#setshowaxistooltip)
+- [`setSortingDirection`](#setsortingdirection)
+- [`setSortingEnabled`](#setsortingenabled)
+- [`setStaticFilterGroup`](#setstaticfiltergroup)
+- [`toggleDimension`](#toggledimension)
+- [`toggleDimensionByName`](#toggledimensionbyname)
+- [`updateDimension`](#updatedimension)
+
+## `addDimension`
+
+Add dimension
+
+Add a new dimension to the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Add dimension schema",
+  "type": "object",
+  "properties": {
+    "key": {
+      "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
+      "type": "string"
+    }
+  },
+  "required": ["key"],
+  "additionalProperties": false
+}
+```
+
+## `addMeasureAxisBand`
+
+Add measure axis band
+
+Add a shaded band on the primary measure axis between two measure values
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Add measure axis band schema",
+  "type": "object",
+  "properties": {
+    "start": {
+      "description": "Measure axis value where the band starts",
+      "type": "number"
+    },
+    "end": {
+      "description": "Measure axis value where the band ends",
+      "type": "number"
+    },
+    "color": {
+      "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    "label": {
+      "description": "Text drawn inside the band",
+      "type": "string"
+    }
+  },
+  "required": ["start", "end"],
+  "additionalProperties": false
+}
+```
+
+## `duplicateDimension`
+
+Duplicate dimension
+
+Create a copy of an existing dimension
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Duplicate dimension schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be duplicated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be duplicated",
+      "type": "string"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `removeDimension`
+
+Remove dimension
+
+Remove a dimension from the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Remove dimension schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be removed",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be removed",
+      "type": "string"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `removeMeasureAxisBand`
+
+Remove measure axis band
+
+Remove one shaded band from the primary measure axis by its position
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Remove measure axis band schema",
+  "type": "object",
+  "properties": {
+    "index": {
+      "description": "Zero-based position of the band to remove",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": ["index"],
+  "additionalProperties": false
+}
+```
+
+## `setAnimationEnabled`
+
+Animations
+
+Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set animation enabled schema",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "description": "Whether the chart animates when it first renders and when its data changes",
+      "type": "boolean"
+    }
+  },
+  "required": ["enabled"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisLabelColor`
+
+Axis label color
+
+Change the color of axis value labels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis label color schema",
+  "type": "object",
+  "properties": {
+    "labelColor": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisLineColor`
+
+Axis line color
+
+Change the color of axis lines
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis line color schema",
+  "type": "object",
+  "properties": {
+    "lineColor": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisRangeMax`
+
+Axis range maximum
+
+Set the maximum of a measure axis. Applies only when the axis range option is minmax or max, e.g. to give several charts the same scale.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis range max schema",
+  "type": "object",
+  "properties": {
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure"]
+    },
+    "maxValue": {
+      "type": "number"
+    }
+  },
+  "required": ["axisName", "maxValue"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisRangeMin`
+
+Axis range minimum
+
+Set the minimum of a measure axis. Applies only when the axis range option is minmax or min, e.g. to give several charts the same scale.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis range min schema",
+  "type": "object",
+  "properties": {
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure"]
+    },
+    "minValue": {
+      "type": "number"
+    }
+  },
+  "required": ["axisName", "minValue"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisRangeOption`
+
+Axis range
+
+Choose how a measure axis range is set: auto fits the data, minmax fixes both ends, min or max fixes one end. Fixed ends take their values from setAxisRangeMin and setAxisRangeMax.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis range option schema",
+  "type": "object",
+  "properties": {
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure"]
+    },
+    "axisRangeOption": {
+      "type": "string",
+      "enum": ["auto", "minmax", "max", "min"]
+    }
+  },
+  "required": ["axisName", "axisRangeOption"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisStartsAtZero`
+
+Axis starts at zero
+
+Make an auto-ranged measure axis always include zero. Applies only when the axis range option is auto.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis starts at zero schema",
+  "type": "object",
+  "properties": {
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure"]
+    },
+    "startsAtZero": {
+      "type": "boolean"
+    }
+  },
+  "required": ["axisName", "startsAtZero"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisTickColor`
+
+Axis tick color
+
+Change the color of axis tick marks
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis tick color schema",
+  "type": "object",
+  "properties": {
+    "tickColor": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisTitle`
+
+Axis title
+
+Set a custom title for an axis
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis title schema",
+  "type": "object",
+  "properties": {
+    "axisTitle": {
+      "type": "string"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setAxisTitleColor`
+
+Axis title color
+
+Change the color of axis titles
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis title color schema",
+  "type": "object",
+  "properties": {
+    "titleColor": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setColoringType`
+
+Coloring type
+
+Set how colors are applied to the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Coloring type schema",
+  "type": "string",
+  "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"]
+}
+```
+
+## `setDimensionFormatString`
+
+Dimension format string
+
+Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Dimension format string schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "formatString": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "variable"
+            },
+            "variableName": {
+              "type": "string"
+            }
+          },
+          "required": ["type", "variableName"],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setDimensionFormatType`
+
+Dimension format type
+
+Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Dimension format type schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "formatType": {
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "custom",
+            "inherit",
+            "none",
+            "defaultNumber",
+            "defaultMoney",
+            "numberNoDecimal",
+            "number1Decimal",
+            "number2Decimal",
+            "abbreviationAuto",
+            "abbreviationNoDecimal",
+            "abbreviation1Decimal",
+            "abbreviation2Decimal",
+            "percentageNoDecimal",
+            "percentage1Decimal",
+            "percentage2Decimal",
+            "money0Decimal",
+            "money2Decimal",
+            "durationDays",
+            "durationHours",
+            "durationMinutes",
+            "durationSeconds"
+          ]
+        },
+        {
+          "type": "string",
+          "enum": [
+            "defaultDate",
+            "defaultDatetime",
+            "defaultTime",
+            "ddmmyyyy",
+            "ddmmyyyy2",
+            "ddmmyyyy3",
+            "yyyymmdd",
+            "mmddyyyy",
+            "mmddyyyy2",
+            "ddmmmmyyyy",
+            "ddmmmyyyy",
+            "ddmmmyy",
+            "mmmmddyyyy",
+            "yyyy",
+            "yy",
+            "mmmyyyy",
+            "yyyymmm",
+            "yyyymmmm",
+            "mmyyyy",
+            "yyyymm",
+            "mmmmyyyy",
+            "yyyywn",
+            "wnyyyy",
+            "yywn",
+            "yyyyq",
+            "qyyyy",
+            "yyyymmddhhmmss",
+            "yyyymmddhmmss",
+            "yyyymmddhhmm",
+            "yyyymmddhh",
+            "yyyymmddhmm",
+            "yyyymmddh",
+            "ddmmmyyyyhhmmss",
+            "ddmmmyyyyhmmss",
+            "ddmmmyyyyhhmm",
+            "ddmmmyyyyhmm",
+            "ddmmmyyyyh",
+            "hhmmss",
+            "hhmm",
+            "hmm",
+            "h",
+            "hh",
+            "hmmss",
+            "month",
+            "month2",
+            "monthn",
+            "month3",
+            "quarter",
+            "quarter2",
+            "week1",
+            "week2",
+            "week3",
+            "day",
+            "dayOfWeek",
+            "hhn",
+            "hn"
+          ]
+        }
+      ]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
+  "additionalProperties": false
+}
+```
+
+## `setDimensionTemporalGrouping`
+
+Dimension temporal grouping
+
+Set the temporal grouping of a date dimension. Use mode "level" with dateLevel for year-aware buckets such as month-over-time, mode "part" with datePart for date parts such as month-of-year, or mode "none" to clear temporal grouping.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Dimension temporal grouping schema",
+  "anyOf": [
+    {
+      "type": "object",
+      "properties": {
+        "dataItemInternalKey": {
+          "description": "Internal key of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "dataItemUniqueSignature": {
+          "description": "Unique signature of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "const": "none"
+        }
+      },
+      "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "dataItemInternalKey": {
+          "description": "Internal key of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "dataItemUniqueSignature": {
+          "description": "Unique signature of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "const": "level"
+        },
+        "dateLevel": {
+          "type": "string",
+          "enum": [
+            "year",
+            "year-end",
+            "quarter",
+            "quarter-end",
+            "month",
+            "month-end",
+            "week",
+            "week-end",
+            "day",
+            "hour",
+            "minute",
+            "second"
+          ]
+        }
+      },
+      "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "dataItemInternalKey": {
+          "description": "Internal key of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "dataItemUniqueSignature": {
+          "description": "Unique signature of the data item of the dimension to be updated",
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "const": "part"
+        },
+        "datePart": {
+          "type": "string",
+          "enum": [
+            "year",
+            "month",
+            "day",
+            "dayofweekiso",
+            "dayofyear",
+            "weekiso",
+            "quarter",
+            "yearofweekiso",
+            "hour",
+            "minute",
+            "second"
+          ]
+        }
+      },
+      "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
+      "additionalProperties": false
+    }
+  ]
+}
+```
+
+## `setEnableContinuousAxis`
+
+Enable continuous axis
+
+Use continuous scale for numeric or date values on axis
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Enable continuous axis schema",
+  "type": "object",
+  "properties": {
+    "continuousAxis": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+## `setInvertAxis`
+
+Invert axis
+
+Reverse the direction of an axis. axisName defaults to the dimension axis; pass a measure axis to flip its value scale, e.g. to put rank 1 at the top.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Invert axis schema",
+  "type": "object",
+  "properties": {
+    "invertAxis": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["dimension", "primaryMeasure"]
+    }
+  },
+  "required": ["invertAxis"],
+  "additionalProperties": false
+}
+```
+
+## `setLabelOverlap`
+
+Axis label overlap
+
+Control how axis labels behave when they overlap
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Label overlap schema",
+  "type": "object",
+  "properties": {
+    "labelOverlap": {
+      "type": "string",
+      "enum": ["auto", "show-last"]
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+## `setLegendEnabled`
+
+Legend enabled
+
+Show or hide the chart legend
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Enable legend",
+  "title": "Legend enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setLegendItemLabelFill`
+
+Legend label color
+
+Change the color of legend text labels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Legend item label font color (hexadecimal color code)",
+  "title": "Legend item label fill schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setLegendItemLabelFontSize`
+
+Legend label font size
+
+Adjust the font size of legend labels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Legend item label font size schema",
+  "type": "number"
+}
+```
+
+## `setLegendItemLabelLimitCharacters`
+
+Enable legend label characters limit
+
+Enable or disable character limit for legend labels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Limit characters by maxGlyphCount",
+  "title": "Legend item label limit characters schema",
+  "type": "boolean"
+}
+```
+
+## `setLegendItemLabelMaxGlyphCount`
+
+Legend label characters limit
+
+Set the maximum number of characters shown in legend labels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Maximum number of glyphs in the legend item label",
+  "title": "Legend item label max glyph count schema",
+  "anyOf": [
+    {
+      "type": "number"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setLegendPosition`
+
+Legend position
+
+Change where the legend appears on the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Legend position",
+  "title": "Legend position schema",
+  "type": "string",
+  "enum": ["left", "right", "top", "bottom"]
+}
+```
+
+## `setLegendTitle`
+
+Legend title
+
+Set a custom title for the legend
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Legend title text",
+  "title": "Legend title schema",
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setMeasureAxisBands`
+
+Measure axis bands
+
+Replace all shaded bands on the primary measure axis. Each band fills the plot between two measure values
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set measure axis bands schema",
+  "type": "object",
+  "properties": {
+    "bands": {
+      "description": "Bands to draw, in order; an empty array removes all bands",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "start": {
+            "description": "Measure axis value where the band starts",
+            "type": "number"
+          },
+          "end": {
+            "description": "Measure axis value where the band ends",
+            "type": "number"
+          },
+          "color": {
+            "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
+            "type": "string",
+            "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+          },
+          "label": {
+            "description": "Text drawn inside the band",
+            "type": "string"
+          }
+        },
+        "required": ["start", "end"],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": ["bands"],
+  "additionalProperties": false
+}
+```
+
+## `setMeasureCurrency`
+
+Measure currency
+
+Set the currency symbol used by a measure formatter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Measure currency schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "currency": {
+      "type": "string"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setMeasureCurrencyIsPrefix`
+
+Measure currency is prefix
+
+Set whether measure currency symbol is prefixed
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Measure currency is prefix schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "currencyIsPrefix": {
+      "type": "boolean"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setMeasureFormatString`
+
+Measure format string
+
+Set the custom format string for a measure
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Measure format string schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "formatString": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "variable"
+            },
+            "variableName": {
+              "type": "string"
+            }
+          },
+          "required": ["type", "variableName"],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setMeasureFormatType`
+
+Measure format type
+
+Set the format type used by a measure
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Measure format type schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "formatType": {
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "custom",
+            "inherit",
+            "none",
+            "defaultNumber",
+            "defaultMoney",
+            "numberNoDecimal",
+            "number1Decimal",
+            "number2Decimal",
+            "abbreviationAuto",
+            "abbreviationNoDecimal",
+            "abbreviation1Decimal",
+            "abbreviation2Decimal",
+            "percentageNoDecimal",
+            "percentage1Decimal",
+            "percentage2Decimal",
+            "money0Decimal",
+            "money2Decimal",
+            "durationDays",
+            "durationHours",
+            "durationMinutes",
+            "durationSeconds"
+          ]
+        },
+        {
+          "type": "string",
+          "enum": [
+            "defaultDate",
+            "defaultDatetime",
+            "defaultTime",
+            "ddmmyyyy",
+            "ddmmyyyy2",
+            "ddmmyyyy3",
+            "yyyymmdd",
+            "mmddyyyy",
+            "mmddyyyy2",
+            "ddmmmmyyyy",
+            "ddmmmyyyy",
+            "ddmmmyy",
+            "mmmmddyyyy",
+            "yyyy",
+            "yy",
+            "mmmyyyy",
+            "yyyymmm",
+            "yyyymmmm",
+            "mmyyyy",
+            "yyyymm",
+            "mmmmyyyy",
+            "yyyywn",
+            "wnyyyy",
+            "yywn",
+            "yyyyq",
+            "qyyyy",
+            "yyyymmddhhmmss",
+            "yyyymmddhmmss",
+            "yyyymmddhhmm",
+            "yyyymmddhh",
+            "yyyymmddhmm",
+            "yyyymmddh",
+            "ddmmmyyyyhhmmss",
+            "ddmmmyyyyhmmss",
+            "ddmmmyyyyhhmm",
+            "ddmmmyyyyhmm",
+            "ddmmmyyyyh",
+            "hhmmss",
+            "hhmm",
+            "hmm",
+            "h",
+            "hh",
+            "hmmss",
+            "month",
+            "month2",
+            "monthn",
+            "month3",
+            "quarter",
+            "quarter2",
+            "week1",
+            "week2",
+            "week3",
+            "day",
+            "dayOfWeek",
+            "hhn",
+            "hn"
+          ]
+        }
+      ]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
+  "additionalProperties": false
+}
+```
+
+## `setMeasureNegativeType`
+
+Measure negative type
+
+Set how negative values are displayed for a measure formatter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Measure negative type schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be updated",
+      "type": "string"
+    },
+    "negativeType": {
+      "type": "string",
+      "enum": ["symbol", "parenthesis"]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setOrientation`
+
+Orientation
+
+Set the orientation of the histogram chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Histogram chart orientation schema",
+  "type": "string",
+  "enum": ["horizontal", "vertical"]
+}
+```
+
+## `setShowAxisLabels`
+
+Show axis labels
+
+Show or hide value labels on chart axes
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis labels schema",
+  "type": "object",
+  "properties": {
+    "showLabels": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setShowAxisLine`
+
+Show axis line
+
+Show or hide the axis lines on the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis line schema",
+  "type": "object",
+  "properties": {
+    "showAxisLine": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setShowAxisTicks`
+
+Show axis ticks
+
+Show or hide tick marks on chart axes
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis ticks schema",
+  "type": "object",
+  "properties": {
+    "showAxisTicks": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setShowAxisTitle`
+
+Show axis title
+
+Show or hide axis titles on the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Axis title schema",
+  "type": "object",
+  "properties": {
+    "showAxisName": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setShowAxisTooltip`
+
+Show axis tooltip
+
+Show or hide tooltips when hovering over axis values
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Show axis tooltip schema",
+  "type": "object",
+  "properties": {
+    "showAxisTooltip": {
+      "type": "boolean"
+    },
+    "axisName": {
+      "type": "string",
+      "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
+    }
+  },
+  "required": ["axisName"],
+  "additionalProperties": false
+}
+```
+
+## `setSortingDirection`
+
+Sorting direction
+
+Set sorting direction for all matching sortable items by name
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Sorting direction by name schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": ["ascending", "descending"]
+    }
+  },
+  "required": ["name", "sortDirection"],
+  "additionalProperties": false
+}
+```
+
+## `setSortingEnabled`
+
+Sorting enabled
+
+Enable or disable sorting for all matching sortable items by name
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Sorting enabled by name schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "enabled": {
+      "type": "boolean"
+    }
+  },
+  "required": ["name"],
+  "additionalProperties": false
+}
+```
+
+## `setStaticFilterGroup`
+
+Set static filter group
+
+Replace all static filters with a nested AND/OR filter group.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Replace all static filters with this nested AND/OR filter group.",
+  "title": "Set static filter group schema",
+  "$ref": "#/$defs/__schema0",
+  "$defs": {
+    "__schema0": {
+      "type": "object",
+      "properties": {
+        "operator": {
+          "type": "string",
+          "enum": ["and", "or"]
+        },
+        "filters": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "fieldKey": {
+                    "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
+                    "type": "string"
+                  },
+                  "operator": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "equals",
+                          "doesNotEqual",
+                          "greaterThan",
+                          "lessThan",
+                          "greaterThanOrEqualTo",
+                          "lessThanOrEqualTo",
+                          "isBetween",
+                          "isNotBetween",
+                          "isNull",
+                          "notNull",
+                          "contains",
+                          "excludes",
+                          "like",
+                          "notLike",
+                          "startsWith",
+                          "endsWith",
+                          "predefined_date_range",
+                          "previous",
+                          "current",
+                          "before",
+                          "after",
+                          "inList",
+                          "excludedFromList",
+                          "divider"
+                        ]
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "ytd",
+                          "mtd",
+                          "qtd",
+                          "wtd",
+                          "pytd",
+                          "pmtd",
+                          "pqtd",
+                          "pwtd",
+                          "l12m",
+                          "l90d",
+                          "l30d",
+                          "l7d",
+                          "cy",
+                          "cq",
+                          "cm",
+                          "py",
+                          "pm",
+                          "pq",
+                          "pw",
+                          "today",
+                          "yesterday",
+                          "mindate",
+                          "maxdate"
+                        ]
+                      }
+                    ]
+                  },
+                  "values": {
+                    "type": "object",
+                    "properties": {
+                      "value": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "const": "variable"
+                              },
+                              "variableName": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["type", "variableName"],
+                            "additionalProperties": false
+                          }
+                        ]
+                      },
+                      "valueFrom": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "const": "variable"
+                              },
+                              "variableName": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["type", "variableName"],
+                            "additionalProperties": false
+                          }
+                        ]
+                      },
+                      "valueTo": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "const": "variable"
+                              },
+                              "variableName": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["type", "variableName"],
+                            "additionalProperties": false
+                          }
+                        ]
+                      },
+                      "secondValue": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "const": "variable"
+                              },
+                              "variableName": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["type", "variableName"],
+                            "additionalProperties": false
+                          }
+                        ]
+                      }
+                    },
+                    "additionalProperties": false
+                  },
+                  "dateFilter": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "ytd",
+                          "mtd",
+                          "qtd",
+                          "wtd",
+                          "pytd",
+                          "pmtd",
+                          "pqtd",
+                          "pwtd",
+                          "l12m",
+                          "l90d",
+                          "l30d",
+                          "l7d",
+                          "cy",
+                          "cq",
+                          "cm",
+                          "py",
+                          "pm",
+                          "pq",
+                          "pw",
+                          "today",
+                          "yesterday",
+                          "mindate",
+                          "maxdate"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "required": ["fieldKey", "operator", "values"],
+                "additionalProperties": false
+              },
+              {
+                "$ref": "#/$defs/__schema0"
+              }
+            ]
+          }
+        }
+      },
+      "required": ["operator", "filters"],
+      "additionalProperties": false
+    }
+  }
+}
+```
+
+## `toggleDimension`
+
+Toggle dimension
+
+Enable or disable a dimension in the chart
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Toggle dimension schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be toggled",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be toggled",
+      "type": "string"
+    },
+    "enabled": {
+      "description": "Whether the dimension should be enabled or disabled",
+      "type": "boolean"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
+  "additionalProperties": false
+}
+```
+
+## `toggleDimensionByName`
+
+Toggle dimension by name
+
+Enable, disable, or toggle a dimension by its name
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Toggle dimension by name schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "operation": {
+      "type": "string",
+      "enum": ["enable", "disable", "toggle"]
+    }
+  },
+  "required": ["name", "operation"],
+  "additionalProperties": false
+}
+```
+
+## `updateDimension`
+
+Update dimension
+
+Modify properties of an existing dimension
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Update dimension schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the dimension to be updated",
+      "type": "string"
+    },
+    "changes": {
+      "type": "object",
+      "properties": {
+        "customLabel": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            },
+            "value": {
+              "type": "string"
+            }
+          },
+          "required": ["enabled"],
+          "additionalProperties": false
+        },
+        "showNullValues": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
+  "additionalProperties": false
+}
+```