iframe 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

• setIframeUrl

setIframeUrl

Iframe URL

Set a static URL, bind the URL to an existing text workbook variable by exact name, or clear it with null. Variable bindings update the URL dynamically without changing the variable value.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "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
        }
      ]
    },
    {
      "type": "null"
    }
  ],
  "title": "Set iframe URL schema"
}