@astrato-io/visualizations 0.6.4 → 0.6.5

package/docs/operations/filter.md

@@ -2,7 +2,7 @@
 
 # `filter` operations
 
-Reference for `@astrato-io/visualizations@0.6.4`.
+Reference for `@astrato-io/visualizations@0.6.5`.
 
 [All visualization types](./index.md)
 
@@ -55,12 +55,11 @@ Add one primary dimension to the filter. Only the filter-dimension role is suppo
 ```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"
+      "type": "string",
+      "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
     },
     "role": {
       "type": "string",
@@ -68,7 +67,8 @@ Add one primary dimension to the filter. Only the filter-dimension role is suppo
     }
   },
   "required": ["key"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Add filter dimension schema"
 }
 ```
 
@@ -83,23 +83,22 @@ Add a measure to display additional values in the filter
 ```json
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Add filter measure schema",
-  "anyOf": [
+  "oneOf": [
     {
       "type": "object",
       "properties": {
         "sourceKind": {
-          "description": "Raw database field from available data `fields`.",
           "type": "string",
-          "const": "field"
+          "const": "field",
+          "description": "Raw database field from available data `fields`."
         },
         "key": {
-          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
-          "type": "string"
+          "type": "string",
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
         },
         "aggregation": {
-          "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
-          "type": "string"
+          "type": "string",
+          "description": "Required for raw database fields. Use one of the aggregation names returned for that field."
         }
       },
       "required": ["sourceKind", "key", "aggregation"],
@@ -109,13 +108,13 @@ Add a measure to display additional values in the filter
       "type": "object",
       "properties": {
         "sourceKind": {
-          "description": "Predefined/user-defined measure from available data `measures`.",
           "type": "string",
-          "const": "measure"
+          "const": "measure",
+          "description": "Predefined/user-defined measure from available data `measures`."
         },
         "key": {
-          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
-          "type": "string"
+          "type": "string",
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
         }
       },
       "required": ["sourceKind", "key"],
@@ -125,19 +124,20 @@ Add a measure to display additional values in the filter
       "type": "object",
       "properties": {
         "sourceKind": {
-          "description": "Predefined calculation from available data `measures`.",
           "type": "string",
-          "const": "calculation"
+          "const": "calculation",
+          "description": "Predefined calculation from available data `measures`."
         },
         "key": {
-          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
-          "type": "string"
+          "type": "string",
+          "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
         }
       },
       "required": ["sourceKind", "key"],
       "additionalProperties": false
     }
-  ]
+  ],
+  "title": "Add filter measure schema"
 }
 ```
 
@@ -152,25 +152,25 @@ Change how a filter measure is aggregated
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "aggregation": {
-      "description": "Aggregation function to be used for the measure",
       "type": "string",
-      "minLength": 1
+      "minLength": 1,
+      "description": "Aggregation function to be used for the measure"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Change filter measure aggregation schema"
 }
 ```
 
@@ -185,20 +185,20 @@ Remove a primary dimension from the filter
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the dimension to be removed"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the dimension to be removed",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the dimension to be removed"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Remove filter dimension schema"
 }
 ```
 
@@ -213,20 +213,20 @@ Remove a measure from the filter
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be removed"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be removed",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be removed"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Remove filter measure schema"
 }
 ```
 
@@ -241,16 +241,15 @@ Set the custom display format string for a dimension. This changes label formatt
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the dimension to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the dimension to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the dimension to be updated"
     },
     "formatString": {
       "anyOf": [
@@ -275,7 +274,8 @@ Set the custom display format string for a dimension. This changes label formatt
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Dimension format string schema"
 }
 ```
 
@@ -290,16 +290,15 @@ Set the display format type used by a dimension. This changes label formatting o
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the dimension to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the dimension to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the dimension to be updated"
     },
     "formatType": {
       "anyOf": [
@@ -394,7 +393,8 @@ Set the display format type used by a dimension. This changes label formatting o
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Dimension format type schema"
 }
 ```
 
@@ -409,18 +409,17 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
 ```json
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Dimension temporal grouping schema",
-  "anyOf": [
+  "oneOf": [
     {
       "type": "object",
       "properties": {
         "dataItemInternalKey": {
-          "description": "Internal key of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Internal key of the data item of the dimension to be updated"
         },
         "dataItemUniqueSignature": {
-          "description": "Unique signature of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Unique signature of the data item of the dimension to be updated"
         },
         "mode": {
           "type": "string",
@@ -434,12 +433,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
       "type": "object",
       "properties": {
         "dataItemInternalKey": {
-          "description": "Internal key of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Internal key of the data item of the dimension to be updated"
         },
         "dataItemUniqueSignature": {
-          "description": "Unique signature of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Unique signature of the data item of the dimension to be updated"
         },
         "mode": {
           "type": "string",
@@ -470,12 +469,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
       "type": "object",
       "properties": {
         "dataItemInternalKey": {
-          "description": "Internal key of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Internal key of the data item of the dimension to be updated"
         },
         "dataItemUniqueSignature": {
-          "description": "Unique signature of the data item of the dimension to be updated",
-          "type": "string"
+          "type": "string",
+          "description": "Unique signature of the data item of the dimension to be updated"
         },
         "mode": {
           "type": "string",
@@ -501,7 +500,8 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
       "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
       "additionalProperties": false
     }
-  ]
+  ],
+  "title": "Dimension temporal grouping schema"
 }
 ```
 
@@ -516,8 +516,6 @@ Set the filter background color
 ```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",
@@ -526,7 +524,9 @@ Set the filter background color
     {
       "type": "null"
     }
-  ]
+  ],
+  "description": "Background color (hex, with optional alpha)",
+  "title": "Filter background color schema"
 }
 ```
 
@@ -632,19 +632,11 @@ Update filter font family, size, color, or style
 ```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"
-        }
-      ]
+      "type": ["number", "null"]
     },
     "bold": {
       "description": "Bold font. Should take precedence over weight",
@@ -660,20 +652,12 @@ Update filter font family, size, color, or style
       "type": "boolean"
     },
     "fontFamily": {
-      "anyOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "null"
-        }
-      ]
+      "type": ["string", "null"]
     },
     "fontSize": {
       "type": "number"
     },
     "fontColor": {
-      "description": "Font color (hex, with optional alpha)",
       "anyOf": [
         {
           "type": "string",
@@ -682,10 +666,12 @@ Update filter font family, size, color, or style
         {
           "type": "null"
         }
-      ]
+      ],
+      "description": "Font color (hex, with optional alpha)"
     }
   },
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Filter font style schema"
 }
 ```
 
@@ -700,23 +686,23 @@ Set the label shown for a measure value in the filter
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "filterValueLabel": {
       "type": "string"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Filter measure value label schema"
 }
 ```
 
@@ -731,9 +717,9 @@ Set the filter display mode. Supported modes are dropdown and listbox.
 ```json
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Filter mode schema",
   "type": "string",
-  "enum": ["dropdown", "listbox"]
+  "enum": ["dropdown", "listbox"],
+  "title": "Filter mode schema"
 }
 ```
 
@@ -851,10 +837,10 @@ Set the filter source
 ```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"]
+  "enum": ["manual", "engine"],
+  "description": "Filter source - manual or engine",
+  "title": "Filter source schema"
 }
 ```
 
@@ -869,23 +855,23 @@ Set the currency symbol used by a measure formatter
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "currency": {
       "type": "string"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Measure currency schema"
 }
 ```
 
@@ -900,23 +886,23 @@ Set whether measure currency symbol is prefixed
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "currencyIsPrefix": {
       "type": "boolean"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Measure currency is prefix schema"
 }
 ```
 
@@ -931,16 +917,15 @@ Configure a Defined parameter of a custom measure using its default, a static va
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "collectionKey": {
       "description": "Measure collection to update. Defaults to primary measures.",
@@ -948,13 +933,12 @@ Configure a Defined parameter of a custom measure using its default, a static va
       "enum": ["measures", "supportingMeasures"]
     },
     "parameterName": {
-      "description": "Exact name of a Defined parameter exposed by the measure",
       "type": "string",
-      "minLength": 1
+      "minLength": 1,
+      "description": "Exact name of a Defined parameter exposed by the measure"
     },
     "value": {
-      "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
-      "anyOf": [
+      "oneOf": [
         {
           "type": "object",
           "properties": {
@@ -974,17 +958,7 @@ Configure a Defined parameter of a custom measure using its default, a static va
               "const": "static"
             },
             "value": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "number"
-                },
-                {
-                  "type": "boolean"
-                }
-              ]
+              "type": ["string", "number", "boolean"]
             }
           },
           "required": ["type", "value"],
@@ -998,19 +972,21 @@ Configure a Defined parameter of a custom measure using its default, a static va
               "const": "variable"
             },
             "variableName": {
-              "description": "Exact name of an existing compatible workbook variable",
               "type": "string",
-              "minLength": 1
+              "minLength": 1,
+              "description": "Exact name of an existing compatible workbook variable"
             }
           },
           "required": ["type", "variableName"],
           "additionalProperties": false
         }
-      ]
+      ],
+      "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable"
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Set measure defined parameter schema"
 }
 ```
 
@@ -1025,16 +1001,15 @@ Set the custom format string for a measure
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "formatString": {
       "anyOf": [
@@ -1059,7 +1034,8 @@ Set the custom format string for a measure
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Measure format string schema"
 }
 ```
 
@@ -1074,16 +1050,15 @@ Set the format type used by a measure
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "formatType": {
       "anyOf": [
@@ -1178,7 +1153,8 @@ Set the format type used by a measure
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Measure format type schema"
 }
 ```
 
@@ -1193,16 +1169,15 @@ Set how negative values are displayed for a measure formatter
 ```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"
+      "type": "string",
+      "description": "Internal key of the data item of the measure to be updated"
     },
     "dataItemUniqueSignature": {
-      "description": "Unique signature of the data item of the measure to be updated",
-      "type": "string"
+      "type": "string",
+      "description": "Unique signature of the data item of the measure to be updated"
     },
     "negativeType": {
       "type": "string",
@@ -1210,7 +1185,8 @@ Set how negative values are displayed for a measure formatter
     }
   },
   "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Measure negative type schema"
 }
 ```
 
@@ -1225,7 +1201,6 @@ Set sorting direction for all matching sortable items by name
 ```json
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Sorting direction by name schema",
   "type": "object",
   "properties": {
     "name": {
@@ -1238,7 +1213,8 @@ Set sorting direction for all matching sortable items by name
     }
   },
   "required": ["name", "sortDirection"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Sorting direction by name schema"
 }
 ```
 
@@ -1253,7 +1229,6 @@ Enable or disable sorting for all matching sortable items by name
 ```json
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Sorting enabled by name schema",
   "type": "object",
   "properties": {
     "name": {
@@ -1265,7 +1240,8 @@ Enable or disable sorting for all matching sortable items by name
     }
   },
   "required": ["name"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "title": "Sorting enabled by name schema"
 }
 ```
 
@@ -1299,8 +1275,8 @@ Replace all static filters with a nested AND/OR filter group.
                 "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"
+                    "type": "string",
+                    "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
                   },
                   "operator": {
                     "anyOf": [