table

Like the textbox shape, the table shape is used to display simple text or numerical data.

JSON payload

"shapes": [
  {
    "name": "string",
    "data_cells": [],
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   },
  {
    "name": "string",
    "data_cells": [],
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   } 
]

data_cells object

The data_cells object is used to populate a table shape. It is a 2-dimensions array of cell values. Each cell value can be a simple string or a text object.

JSON payload

"data_cells": [
  [
    "Cell A1",
    "Cell B1",
    "Cell C1"
  ],
  [
    "Cell A2",
    {
      "text_content": [
        {
          "text_run": "Cell",
          "text_properties": {}
        },
        {
          "text_run": " B2",
          "text_properties": {}
        }
      ],
      "cell_properties": {}
    },
    "Cell C2"
  ],
  [
    "Cell A3",
    "Cell B3",
    "Cell C3"
  ]
]

text_properties

JSON payload

"data_cells": [
  [
    "Cell A1",
    {
      "text_runs": [
        {
          "text_run": "Cell B1",
          "text_properties": {
            "font_type": "string",
            "font_size": numeric,
            "font_bold": boolean,
            "font_italic": boolean,
            "font_color": "string",
            "font_bg_color": "string",
            "text_align": "string",
            "text_indent": numeric,
            "text_line_spacing": numeric,
            "font_underline": "string",	
            "new_line": boolean
          }
        }
      ],
      "cell_properties": {}
    },
    "Cell C1"
  ],
  [
    "Cell A2",
    "Cell B2",
    "Cell C2"
  ],
  [
    "Cell A3",
    "Cell B3",
    "Cell C3"
  ]
]

cell_properties


Settings Object

The settings object contain a list format/styling parameters.

Parameters below are available across all shapes, regardless of type.

Some shape types (i.e. Charts, Tables, Textboxes) have specific attributes, see shape specific settings pages to learn more.

JSON payload

"settings": {
  "height": numeric,
  "width": numeric,
  "top": numeric,
  "left": numeric,
  "unit": "string"
  "fill_color": "0,0,0"
}

Last updated