shapes

Everything on a slide is a shape object. There are several different types of shapes (table shape, chart shape). Each shape type comes with its own set of unique properties. Below are parameters which can be used on any type of shape.

To access a shape, you must connect to it using the shape's name.

Parameter
Type
Input
Description

name

String

[required] Name of shape to update/manipulate. Find shape names here.

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",
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   },
  {
    "name": "string",
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   } 
]

_______________________________________________________________________________________________________

Settings Object

The settings object contain a list format/styling parameters.

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 (default value if ‘unit’ field is not specified)

[optional] Set unit of measurement for shape width, height, left, top

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"
}

Last updated