@astrato-io/visualizations 0.0.0-stage → 0.6.4

package/docs/operations/iframe.md

@@ -0,0 +1,56 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# `iframe` 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
+
+- [`setIframeUrl`](#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**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set iframe URL schema",
+  "anyOf": [
+    {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "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
+        }
+      ]
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```

package/docs/operations/image.md

@@ -0,0 +1,177 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# `image` 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
+
+- [`setImageBlur`](#setimageblur)
+- [`setImageFit`](#setimagefit)
+- [`setImageOpacity`](#setimageopacity)
+- [`setImageSaturation`](#setimagesaturation)
+- [`setImageShadow`](#setimageshadow)
+- [`setImageSource`](#setimagesource)
+
+## `setImageBlur`
+
+Image blur
+
+Set image blur from 0 to 10
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image blur schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 10
+}
+```
+
+## `setImageFit`
+
+Image fit
+
+Set how the image fits inside the object
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image fit schema",
+  "type": "string",
+  "enum": ["contain", "cover", "fill", "none"]
+}
+```
+
+## `setImageOpacity`
+
+Image opacity
+
+Set image opacity from 0 to 1
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image opacity schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 1
+}
+```
+
+## `setImageSaturation`
+
+Image saturation
+
+Set image saturation from 0 to 1
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image saturation schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 1
+}
+```
+
+## `setImageShadow`
+
+Image shadow
+
+Show or hide the image shadow
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image shadow schema",
+  "type": "boolean"
+}
+```
+
+## `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**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Set image source schema",
+  "anyOf": [
+    {
+      "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": {
+          "description": "Exact name of an existing text workbook variable",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["sourceKind", "variableName"],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "sourceKind": {
+          "type": "string",
+          "const": "none"
+        }
+      },
+      "required": ["sourceKind"],
+      "additionalProperties": false
+    }
+  ]
+}
+```

package/docs/operations/index.md

@@ -0,0 +1,46 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# Visualization operations reference
+
+Reference for `@astrato-io/visualizations@0.6.4`.
+
+Read the page for your visualization type to find every operation exposed by its standalone metadata, including its description and complete JSON payload schema. These files are included in the installed package under `docs/operations/`; you can read them without importing JavaScript or loading a chart.
+
+## Using operations
+
+An operation request contains `name` and `payload`, with an optional `id` for identifying its result. The schemas on these pages describe only `payload`. Validate your payload against the schema before applying the operation. The operation API does not automatically validate every payload against these schemas.
+
+Use `applyRuntimeOperations` to modify a runtime-owned instance. See [Applying operations](../../README.md#applying-operations-to-a-runtime-instance) for the call shape, field metadata requirements and result handling.
+
+This reference describes the standalone operation catalog, rather than the smaller Astrato Actions menu. Availability for a particular chart can depend on its current configuration and data. Use the reference bundled with your installed package when comparing different releases.
+
+## Visualization types
+
+| Type                                                    | Family | Operations |
+| ------------------------------------------------------- | ------ | ---------- |
+| [`astrato-app-filter-bar`](./astrato-app-filter-bar.md) | filter | 8          |
+| [`bar`](./bar.md)                                       | chart  | 153        |
+| [`combo`](./combo.md)                                   | chart  | 129        |
+| [`date-picker`](./date-picker.md)                       | filter | 16         |
+| [`distribution-gauge`](./distribution-gauge.md)         | chart  | 50         |
+| [`dot`](./dot.md)                                       | chart  | 107        |
+| [`filter`](./filter.md)                                 | filter | 33         |
+| [`gauge`](./gauge.md)                                   | chart  | 60         |
+| [`heatMap`](./heatMap.md)                               | chart  | 118        |
+| [`histogram`](./histogram.md)                           | chart  | 47         |
+| [`iframe`](./iframe.md)                                 | object | 1          |
+| [`image`](./image.md)                                   | object | 6          |
+| [`line`](./line.md)                                     | chart  | 143        |
+| [`number`](./number.md)                                 | object | 72         |
+| [`pie`](./pie.md)                                       | chart  | 120        |
+| [`radar`](./radar.md)                                   | chart  | 81         |
+| [`sankey`](./sankey.md)                                 | chart  | 49         |
+| [`scatter`](./scatter.md)                               | chart  | 122        |
+| [`shape`](./shape.md)                                   | object | 14         |
+| [`simpleTextObject`](./simpleTextObject.md)             | object | 35         |
+| [`slider`](./slider.md)                                 | filter | 7          |
+| [`table`](./table.md)                                   | chart  | 232        |
+| [`tree`](./tree.md)                                     | chart  | 59         |
+| [`treemap`](./treemap.md)                               | chart  | 68         |
+| [`waterfall`](./waterfall.md)                           | chart  | 56         |
+| [`word-cloud`](./word-cloud.md)                         | chart  | 44         |