image 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

• setImageBlur
• setImageFit
• setImageOpacity
• setImageSaturation
• setImageShadow
• setImageSource

setImageBlur

Image blur

Set image blur from 0 to 10

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number",
  "minimum": 0,
  "maximum": 10,
  "title": "Set image blur schema"
}

setImageFit

Image fit

Set how the image fits inside the object

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
  "enum": ["contain", "cover", "fill", "none"],
  "title": "Set image fit schema"
}

setImageOpacity

Image opacity

Set image opacity from 0 to 1

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number",
  "minimum": 0,
  "maximum": 1,
  "title": "Set image opacity schema"
}

setImageSaturation

Image saturation

Set image saturation from 0 to 1

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number",
  "minimum": 0,
  "maximum": 1,
  "title": "Set image saturation schema"
}

setImageShadow

Image shadow

Show or hide the image shadow

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "Set image shadow schema"
}

setImageSource

Image source

Set or clear the image source. Use sourceKind “variable” with the exact name of an existing text workbook variable to display its URL dynamically. This does not change the variable value.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "sourceKind": {
          "type": "string",
          "const": "url"
        },
        "imageUrl": {
          "type": "string"
        }
      },
      "required": ["sourceKind", "imageUrl"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "sourceKind": {
          "type": "string",
          "const": "mediaItem"
        },
        "mediaItemId": {
          "type": "string"
        }
      },
      "required": ["sourceKind", "mediaItemId"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "sourceKind": {
          "type": "string",
          "const": "variable"
        },
        "variableName": {
          "type": "string",
          "minLength": 1,
          "description": "Exact name of an existing text workbook variable"
        }
      },
      "required": ["sourceKind", "variableName"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "sourceKind": {
          "type": "string",
          "const": "none"
        }
      },
      "required": ["sourceKind"],
      "additionalProperties": false
    }
  ],
  "title": "Set image source schema"
}