table
Last updated
Last updated
Like the textbox shape, the table
shape is used to display simple text or numerical data.
Parameter | Type | Input | Description |
---|---|---|---|
JSON payload
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
JSON payload
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
Parameter | Type | Input | Description |
---|---|---|---|
Parameter | Type | Input | Description |
---|---|---|---|
Parameters | Type | Input | Description |
---|---|---|---|
Parameter | Type | Input | Description |
---|---|---|---|
name
String
[required] The 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
text_content
Object
[optional] An array of text objects. See here for more information.
cell_properties
Object
[optional] A cell styling object
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
[optional] Set text color
font_bg_color
String
[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
bg_color
String
[optional] Cell background color
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
[optional] Set shape background color