slider operations

Reference for @astrato-io/visualizations@0.6.5.

All visualization types

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

• addSliderDimension
• setMeasureDefinedParameter
• setSliderLayout
• setSliderManualRangeEnabled
• setSliderQuickSelect
• setSliderRange
• setSliderStep

addSliderDimension

Slider field

Add the numeric or date field controlled by the slider

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
    }
  },
  "required": ["key"],
  "additionalProperties": false,
  "title": "Add slider dimension schema"
}

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dataItemInternalKey": {
      "type": "string",
      "description": "Internal key of the data item of the measure to be updated"
    },
    "dataItemUniqueSignature": {
      "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.",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "parameterName": {
      "type": "string",
      "minLength": 1,
      "description": "Exact name of a Defined parameter exposed by the measure"
    },
    "value": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "default"
            }
          },
          "required": ["type"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "static"
            },
            "value": {
              "type": ["string", "number", "boolean"]
            }
          },
          "required": ["type", "value"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string",
              "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,
  "title": "Set measure defined parameter schema"
}

setSliderLayout

Layout

Set the slider layout mode

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
  "enum": ["auto", "single", "multi"],
  "title": "Slider layout schema"
}

setSliderManualRangeEnabled

Manual range

Use explicit minimum and maximum slider values instead of data-derived bounds

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "Slider manual range schema"
}

setSliderQuickSelect

Quick select

Apply slider selections immediately

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "Slider quick select schema"
}

setSliderRange

Range

Set the minimum and maximum slider values

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "min": {
      "type": "number",
      "description": "Minimum value of the slider range"
    },
    "max": {
      "type": "number",
      "description": "Maximum value of the slider range"
    }
  },
  "required": ["min", "max"],
  "additionalProperties": false,
  "title": "Slider range schema"
}

setSliderStep

Step

Set the interval between slider values

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number",
  "title": "Slider step schema"
}