PowerPoint Generator API
  • PowerPoint Generator API
  • Getting started
    • Quick start
  • API reference
    • token/create
    • generator/create
  • Knowledge base
    • Key concepts
    • Templating your presentation
    • Building your JSON payload
    • Finding shape names
  • JSON/ PPTX Reference
    • presentation
    • slides
    • shapes
      • textbox
      • chart
      • picture
      • table
    • tags
    • Deprecated
  • Examples
    • Presentation
      • Naming output presentation
      • Using multiple templates
    • Slide
      • Change shape size and position
      • Change shape background color
      • Hide or remove shape
      • Replacing tags
    • Textboxes
      • Add text
      • Set font type and size
      • Set font color and font background color
      • Set bold, italic & underline
      • Set text alignment
      • Set text indentation
      • Set text line spacing
      • Using bullet-points
    • Chart
      • Change font settings
      • Insert data
      • Adjust chart legend
      • Appending to data labels
    • Pictures
    • Table
      • Populate simple table
      • Using `text_runs` in Table cells
      • Handling merged cells
      • Update a specific cells in existing table
    • Tags
Powered by GitBook
On this page

Was this helpful?

  1. JSON/ PPTX Reference

shapes

Hierarchy: presentation > slides > 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

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

RGB(0,0,0),

[optional] Set shape background color

JSON payload

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

Last updated 1 year ago

Was this helpful?

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

[optional] An array of

,

here
settings object
Color name
Hex