@astrato-io/visualizations 0.0.0-stage → 0.6.4

package/docs/operations/filter.md

@@ -0,0 +1,1507 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# `filter` 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
+
+- [`addFilterDimension`](#addfilterdimension)
+- [`addFilterMeasure`](#addfiltermeasure)
+- [`changeFilterMeasureAggregation`](#changefiltermeasureaggregation)
+- [`removeFilterDimension`](#removefilterdimension)
+- [`removeFilterMeasure`](#removefiltermeasure)
+- [`setDimensionFormatString`](#setdimensionformatstring)
+- [`setDimensionFormatType`](#setdimensionformattype)
+- [`setDimensionTemporalGrouping`](#setdimensiontemporalgrouping)
+- [`setFilterBackgroundColor`](#setfilterbackgroundcolor)
+- [`setFilterBorderColor`](#setfilterbordercolor)
+- [`setFilterBorderEnabled`](#setfilterborderenabled)
+- [`setFilterBorderRadius`](#setfilterborderradius)
+- [`setFilterBorderStyle`](#setfilterborderstyle)
+- [`setFilterBorderWidth`](#setfilterborderwidth)
+- [`setFilterFontStyle`](#setfilterfontstyle)
+- [`setFilterMeasureValueLabel`](#setfiltermeasurevaluelabel)
+- [`setFilterMode`](#setfiltermode)
+- [`setFilterProgressBarColor`](#setfilterprogressbarcolor)
+- [`setFilterQuickSelect`](#setfilterquickselect)
+- [`setFilterResponsive`](#setfilterresponsive)
+- [`setFilterSearchable`](#setfiltersearchable)
+- [`setFilterShowMeasureLabel`](#setfiltershowmeasurelabel)
+- [`setFilterShowProgressBar`](#setfiltershowprogressbar)
+- [`setFilterSource`](#setfiltersource)
+- [`setMeasureCurrency`](#setmeasurecurrency)
+- [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
+- [`setMeasureDefinedParameter`](#setmeasuredefinedparameter)
+- [`setMeasureFormatString`](#setmeasureformatstring)
+- [`setMeasureFormatType`](#setmeasureformattype)
+- [`setMeasureNegativeType`](#setmeasurenegativetype)
+- [`setSortingDirection`](#setsortingdirection)
+- [`setSortingEnabled`](#setsortingenabled)
+- [`setStaticFilterGroup`](#setstaticfiltergroup)
+
+## `addFilterDimension`
+
+Add filter dimension
+
+Add one primary dimension to the filter. Only the filter-dimension role is supported; filter-image dimensions are not supported.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Add filter dimension schema",
+  "type": "object",
+  "properties": {
+    "key": {
+      "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
+      "type": "string"
+    },
+    "role": {
+      "type": "string",
+      "enum": ["filter-dimension"]
+    }
+  },
+  "required": ["key"],
+  "additionalProperties": false
+}
+```
+
+## `addFilterMeasure`
+
+Add filter measure
+
+Add a measure to display additional values in the filter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Add filter measure schema",
+  "anyOf": [
+    {
+      "type": "object",
+      "properties": {
+        "sourceKind": {
+          "description": "Raw database field from available data `fields`.",
+          "type": "string",
+          "const": "field"
+        },
+        "key": {
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
+          "type": "string"
+        },
+        "aggregation": {
+          "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
+          "type": "string"
+        }
+      },
+      "required": ["sourceKind", "key", "aggregation"],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "sourceKind": {
+          "description": "Predefined/user-defined measure from available data `measures`.",
+          "type": "string",
+          "const": "measure"
+        },
+        "key": {
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
+          "type": "string"
+        }
+      },
+      "required": ["sourceKind", "key"],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "sourceKind": {
+          "description": "Predefined calculation from available data `measures`.",
+          "type": "string",
+          "const": "calculation"
+        },
+        "key": {
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
+          "type": "string"
+        }
+      },
+      "required": ["sourceKind", "key"],
+      "additionalProperties": false
+    }
+  ]
+}
+```
+
+## `changeFilterMeasureAggregation`
+
+Filter measure aggregation
+
+Change how a filter measure is aggregated
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Change filter measure aggregation 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"
+    },
+    "aggregation": {
+      "description": "Aggregation function to be used for the measure",
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
+  "additionalProperties": false
+}
+```
+
+## `removeFilterDimension`
+
+Remove filter dimension
+
+Remove a primary dimension from the filter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Remove filter 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
+}
+```
+
+## `removeFilterMeasure`
+
+Remove filter measure
+
+Remove a measure from the filter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Remove filter measure schema",
+  "type": "object",
+  "properties": {
+    "dataItemInternalKey": {
+      "description": "Internal key of the data item of the measure to be removed",
+      "type": "string"
+    },
+    "dataItemUniqueSignature": {
+      "description": "Unique signature of the data item of the measure to be removed",
+      "type": "string"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `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
+    }
+  ]
+}
+```
+
+## `setFilterBackgroundColor`
+
+Background color
+
+Set the filter background color
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Background color (hex, with optional alpha)",
+  "title": "Filter background color schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setFilterBorderColor`
+
+Border color
+
+Set the filter border color
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Border color",
+  "title": "Filter border color schema",
+  "type": "string",
+  "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+}
+```
+
+## `setFilterBorderEnabled`
+
+Border enabled
+
+Enable or disable the filter border
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Whether border is enabled",
+  "title": "Filter border enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterBorderRadius`
+
+Border radius
+
+Set the filter border radius in pixels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Border radius in pixels",
+  "title": "Filter border radius schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 100
+}
+```
+
+## `setFilterBorderStyle`
+
+Border style
+
+Set the filter border style
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Border style - line, dashed, dotted",
+  "title": "Filter border style schema",
+  "type": "string",
+  "enum": ["line", "dashed", "dotted"]
+}
+```
+
+## `setFilterBorderWidth`
+
+Border width
+
+Set the filter border width in pixels
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Border width in pixels",
+  "title": "Filter border width schema",
+  "type": "number",
+  "minimum": 1,
+  "maximum": 20
+}
+```
+
+## `setFilterFontStyle`
+
+Filter font style
+
+Update filter font family, size, color, or style
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Filter font style schema",
+  "type": "object",
+  "properties": {
+    "weight": {
+      "description": "Font weight",
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "bold": {
+      "description": "Bold font. Should take precedence over weight",
+      "type": "boolean"
+    },
+    "italic": {
+      "type": "boolean"
+    },
+    "underlined": {
+      "type": "boolean"
+    },
+    "strikethrough": {
+      "type": "boolean"
+    },
+    "fontFamily": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "fontSize": {
+      "type": "number"
+    },
+    "fontColor": {
+      "description": "Font color (hex, with optional alpha)",
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+## `setFilterMeasureValueLabel`
+
+Filter measure value label
+
+Set the label shown for a measure value in the filter
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Filter measure value label 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"
+    },
+    "filterValueLabel": {
+      "type": "string"
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
+  "additionalProperties": false
+}
+```
+
+## `setFilterMode`
+
+Filter mode
+
+Set the filter display mode. Supported modes are dropdown and listbox.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Filter mode schema",
+  "type": "string",
+  "enum": ["dropdown", "listbox"]
+}
+```
+
+## `setFilterProgressBarColor`
+
+Progress bar color
+
+Set the filter progress bar color
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Progress bar color (hex, with optional alpha)",
+  "title": "Filter progress bar color schema",
+  "type": "string",
+  "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+}
+```
+
+## `setFilterQuickSelect`
+
+Quick select
+
+Enable or disable immediate filtering when a value is selected
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Enable quick select filtering",
+  "title": "Filter quick select schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterResponsive`
+
+Responsive
+
+Enable or disable responsive filter sizing
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Whether filter is responsive",
+  "title": "Filter responsive schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterSearchable`
+
+Searchable
+
+Enable or disable search in the filter values
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Enable search functionality",
+  "title": "Filter searchable schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterShowMeasureLabel`
+
+Show measure label
+
+Show or hide the measure label in the filter title
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Show measure label in title",
+  "title": "Filter show measure label schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterShowProgressBar`
+
+Show progress bar
+
+Show or hide progress bars for measure values
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Show progress bar for measures",
+  "title": "Filter show progress bar schema",
+  "type": "boolean"
+}
+```
+
+## `setFilterSource`
+
+Filter source
+
+Set the filter source
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Filter source - manual or engine",
+  "title": "Filter source schema",
+  "type": "string",
+  "enum": ["manual", "engine"]
+}
+```
+
+## `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
+}
+```
+
+## `setMeasureDefinedParameter`
+
+Measure defined parameter
+
+Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set measure defined parameter 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"
+    },
+    "collectionKey": {
+      "description": "Measure collection to update. Defaults to primary measures.",
+      "type": "string",
+      "enum": ["measures", "supportingMeasures"]
+    },
+    "parameterName": {
+      "description": "Exact name of a Defined parameter exposed by the measure",
+      "type": "string",
+      "minLength": 1
+    },
+    "value": {
+      "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "default"
+            }
+          },
+          "required": ["type"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "static"
+            },
+            "value": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                }
+              ]
+            }
+          },
+          "required": ["type", "value"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "variable"
+            },
+            "variableName": {
+              "description": "Exact name of an existing compatible workbook variable",
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "required": ["type", "variableName"],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
+  "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
+}
+```
+
+## `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
+    }
+  }
+}
+```