table

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

Parameter	Type	Input	Description
name	String		[required] Name of shape to update/manipulate. Find shape names here.
data_cells	Object		[optional] 2-dimensional array of cell values. See data cell object.
settings	Object		[optional] An array of settings object.
is_hidden	Boolean	true; false	[optional] Hide shape
remove	Boolean	true; false	[optional] Delete shape

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.

Parameter	Type	Input	Description
text_content	Object		[optional] An array of text objects. See here for more information.
cell_properties	Object		[optional] A cell styling 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

Parameter	Type	Input	Description
font_type	String	MS supported font names	[optional] Font type
font_size	Integer	1 to 4000	[optional] Font size
font_bold	Boolean	true; false	[optional] Bold
font_italic	Boolean	true; false	[optional] Italic
font_color	String	Color name, RGB(0,0,0), Hex	[optional] Set text color
font_bg_color	String	Color name, RGB(0,0,0), Hex	[optional] Set text background color
text_indent	Integer	0 to 142.24	[optional] Set text indent
text_align	String	left, center, right, justified, dist	[optional] Set text alignment
font_underline	String	single; double; heavy; dotted heavydotted; dashed; heavydashed; heavylongdashed; dotdash; heavydotdash; heavydotdotdash; wavy; heavywavy; doublewavy;	[optional] Various text underline
text_line_spacing	Integer	1 to 1584	[optional] Spacing between text lines
new_line	Boolean	true; false	[required] Create new line within text box

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

Parameters	Type	Input	Description
bg_color	String	Color name, RGB(0,0,0), Hex	[optional] Cell background color

_______________________________________________________________________________________________________

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.

Parameter	Type	Input	Description
width	Integer, Float	0 to 5963.92	[optional] Set shape width
height	Integer, Float	0 to 5963.92	[optional] Set shape height
left	Integer, Float	-5963.92 to 5963.92	[optional] Set left position
top	Integer, Float	-5963.92 to 5963.92	[optional] Set top position
unit	String	cm, pt, points	[optional] Set unit of measurement for shape width, height, left, top. Defaults to points if not specifcied.
fill_color	String	Color name, RGB(0,0,0), Hex	[optional] Set shape background color

JSON payload

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