picture

A picture shape is used to display images.

ParameterTypeInputDescription

name

String

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

filename

String

[optional] Name of picture file to use OR downloadable URL link (as a string).

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

_______________________________________________________________________________________________________

Settings Object

The settings object contain a list format/styling parameters.

ParameterTypeInputDescription

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

JSON payload

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

Last updated