@astrato-io/visualizations 0.0.0-stage → 0.6.4

package/docs/operations/simpleTextObject.md

@@ -0,0 +1,706 @@
+<!-- Generated from operation manifests. Do not edit this file manually. -->
+
+# `simpleTextObject` 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
+
+- [`setRichTextMaxLines`](#setrichtextmaxlines)
+- [`setRichTextResponsiveEnabled`](#setrichtextresponsiveenabled)
+- [`setTextBackgroundBlur`](#settextbackgroundblur)
+- [`setTextBackgroundColor`](#settextbackgroundcolor)
+- [`setTextBackgroundImage`](#settextbackgroundimage)
+- [`setTextBackgroundImageFit`](#settextbackgroundimagefit)
+- [`setTextBackgroundImageOpacity`](#settextbackgroundimageopacity)
+- [`setTextBackgroundType`](#settextbackgroundtype)
+- [`setTextBorderColor`](#settextbordercolor)
+- [`setTextBorderEnabled`](#settextborderenabled)
+- [`setTextBorderRadius`](#settextborderradius)
+- [`setTextBorderStyle`](#settextborderstyle)
+- [`setTextBorderWidth`](#settextborderwidth)
+- [`setTextColor`](#settextcolor)
+- [`setTextContent`](#settextcontent)
+- [`setTextContentVariable`](#settextcontentvariable)
+- [`setTextFontFamily`](#settextfontfamily)
+- [`setTextFontSize`](#settextfontsize)
+- [`setTextFontStyle`](#settextfontstyle)
+- [`setTextFontWeight`](#settextfontweight)
+- [`setTextHorizontalAlign`](#settexthorizontalalign)
+- [`setTextLetterSpacing`](#settextletterspacing)
+- [`setTextLineSpacing`](#settextlinespacing)
+- [`setTextLinkEnabled`](#settextlinkenabled)
+- [`setTextLinkUrl`](#settextlinkurl)
+- [`setTextMaxLines`](#settextmaxlines)
+- [`setTextObjectShadow`](#settextobjectshadow)
+- [`setTextPadding`](#settextpadding)
+- [`setTextParagraphMargin`](#settextparagraphmargin)
+- [`setTextRepresentation`](#settextrepresentation)
+- [`setTextResponsiveEnabled`](#settextresponsiveenabled)
+- [`setTextScaling`](#settextscaling)
+- [`setTextShadow`](#settextshadow)
+- [`setTextVerticalAlign`](#settextverticalalign)
+- [`setTextWordWrap`](#settextwordwrap)
+
+## `setRichTextMaxLines`
+
+Rich text max lines
+
+Set the maximum visible Rich text lines when responsive overflow is disabled.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Rich text max lines schema",
+  "type": "number",
+  "minimum": 0
+}
+```
+
+## `setRichTextResponsiveEnabled`
+
+Responsive rich text
+
+Enable responsive Rich text overflow. When disabled, Rich text uses ellipsis and max lines.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Responsive rich text enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setTextBackgroundBlur`
+
+Background blur
+
+Set background blur in pixels.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text background blur schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 10
+}
+```
+
+## `setTextBackgroundColor`
+
+Background color
+
+Set the background color. Use null for transparent background.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text background color schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setTextBackgroundImage`
+
+Background image
+
+Set the background image URL.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text background image schema",
+  "type": "string"
+}
+```
+
+## `setTextBackgroundImageFit`
+
+Background image fit
+
+Set how the background image fits inside the text object.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text background image fit schema",
+  "type": "string",
+  "enum": ["contain", "cover", "fill", "none"]
+}
+```
+
+## `setTextBackgroundImageOpacity`
+
+Background image opacity
+
+Set background image opacity from 0 to 1.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Background image opacity from 0 to 1, where 0 is transparent and 1 is fully opaque",
+  "title": "Text background image opacity schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 100
+}
+```
+
+## `setTextBackgroundType`
+
+Background type
+
+Set the text object background type to color or image.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text background type schema",
+  "type": "string",
+  "enum": ["image", "color"]
+}
+```
+
+## `setTextBorderColor`
+
+Border color
+
+Set the border color.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text border color schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setTextBorderEnabled`
+
+Border enabled
+
+Enable or disable the text object border.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text border enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setTextBorderRadius`
+
+Border radius
+
+Set the border radius in pixels.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text border radius schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 100
+}
+```
+
+## `setTextBorderStyle`
+
+Border style
+
+Set the border style to line or dashed.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Border style. Dotted is not exposed because the text object currently renders dotted as dashed.",
+  "title": "Text border style schema",
+  "type": "string",
+  "enum": ["line", "dashed"]
+}
+```
+
+## `setTextBorderWidth`
+
+Border width
+
+Set the border width in pixels.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text border width schema",
+  "type": "number",
+  "minimum": 1,
+  "maximum": 20
+}
+```
+
+## `setTextColor`
+
+Text color
+
+Set the text color. Use null to return to inherited or theme color.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text color schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setTextContent`
+
+Text content
+
+Set text content and optionally choose whether it is rendered as plain text, HTML, or Markdown. This switches the object to text content mode.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text content schema",
+  "type": "object",
+  "properties": {
+    "textContent": {
+      "description": "Text content to display",
+      "type": "string"
+    },
+    "representation": {
+      "description": "How to render the text content: plain text, HTML, or Markdown",
+      "type": "string",
+      "enum": ["text", "html", "markdown"]
+    }
+  },
+  "required": ["textContent"],
+  "additionalProperties": false
+}
+```
+
+## `setTextContentVariable`
+
+Bind text content to variable
+
+Bind the displayed text to an existing workbook variable by its exact name and switch to variable content mode. The text updates when the variable value changes. Boolean variables are not supported. This does not change the variable's value. Use null to clear the binding without changing the content mode; use setTextContent to return to static text.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text content variable name schema",
+  "anyOf": [
+    {
+      "type": "string",
+      "minLength": 1
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setTextFontFamily`
+
+Font family
+
+Set the text font family. Use null to return to the theme default.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text font family schema",
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}
+```
+
+## `setTextFontSize`
+
+Font size
+
+Set the text font size.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text font size schema",
+  "type": "number",
+  "minimum": 1,
+  "maximum": 999
+}
+```
+
+## `setTextFontStyle`
+
+Font style
+
+Set text font style flags such as bold, italic, underline, strikethrough, and weight.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text font style schema",
+  "type": "object",
+  "properties": {
+    "bold": {
+      "type": "boolean"
+    },
+    "weight": {
+      "type": "number"
+    },
+    "italic": {
+      "type": "boolean"
+    },
+    "underlined": {
+      "type": "boolean"
+    },
+    "strikethrough": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+## `setTextFontWeight`
+
+Font weight
+
+Set the text font weight.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text font weight schema",
+  "type": "number"
+}
+```
+
+## `setTextHorizontalAlign`
+
+Horizontal align
+
+Set horizontal text alignment.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text horizontal align schema",
+  "type": "string",
+  "enum": ["left", "center", "justify", "right"]
+}
+```
+
+## `setTextLetterSpacing`
+
+Letter spacing
+
+Set text letter spacing in pixels.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text letter spacing schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 10
+}
+```
+
+## `setTextLineSpacing`
+
+Line spacing
+
+Set text line spacing.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text line spacing schema",
+  "type": "number",
+  "minimum": 1,
+  "maximum": 3
+}
+```
+
+## `setTextLinkEnabled`
+
+Link enabled
+
+Enable or disable link behavior for plain text content.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text link enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setTextLinkUrl`
+
+Link URL
+
+Set the URL used when link behavior is enabled.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text link URL schema",
+  "type": "string"
+}
+```
+
+## `setTextMaxLines`
+
+Max lines
+
+Set the maximum visible lines when responsive text is disabled.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text max lines schema",
+  "type": "number",
+  "minimum": 0
+}
+```
+
+## `setTextObjectShadow`
+
+Object shadow
+
+Enable or disable object shadow.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text object shadow schema",
+  "type": "boolean"
+}
+```
+
+## `setTextPadding`
+
+Text padding
+
+Set text padding inside the object.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text padding schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 100
+}
+```
+
+## `setTextParagraphMargin`
+
+Paragraph margin
+
+Set paragraph margin for Markdown text.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text paragraph margin schema",
+  "type": "number",
+  "minimum": 0,
+  "maximum": 32
+}
+```
+
+## `setTextRepresentation`
+
+Text representation
+
+Set whether text content is rendered as plain text, HTML, or Markdown.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text representation schema",
+  "type": "string",
+  "enum": ["text", "html", "markdown"]
+}
+```
+
+## `setTextResponsiveEnabled`
+
+Responsive text
+
+Enable responsive text. When disabled, text uses ellipsis and max lines. When enabled, text can scale with workbook or fit the object.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Responsive text enabled schema",
+  "type": "boolean"
+}
+```
+
+## `setTextScaling`
+
+Text scaling
+
+Set responsive text scaling mode.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text scaling schema",
+  "type": "string",
+  "enum": ["none", "viewportWidth", "fitToObject"]
+}
+```
+
+## `setTextShadow`
+
+Text shadow
+
+Enable or disable text shadow.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text shadow schema",
+  "type": "boolean"
+}
+```
+
+## `setTextVerticalAlign`
+
+Vertical align
+
+Set vertical text alignment inside the object.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text vertical align schema",
+  "type": "string",
+  "enum": ["auto", "top", "middle", "bottom"]
+}
+```
+
+## `setTextWordWrap`
+
+Word wrap
+
+Enable or disable text word wrapping.
+
+**Payload schema**
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Text word wrap schema",
+  "type": "boolean"
+}
+```