textbox

Hierarchy: presentation > slides > shapes

A textbox is a type of shape which is used to display text.

Parameter	Type	Input	Description
name	String		[required] Name of shape to update/manipulate. Find shape names here.
text	String or Object		[optional] Text to display in the textbox. - String: A simple way to display plain text in the textbox. - Object: Use for advanced formatting by defining text chunks. See the text object structure.
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",
    "text": "string",
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   },
  {
    "name": "string",
    "text": [],
    "settings": [],
    "is_hidden": boolean,
    "remove": boolean
   } 
]

---

`text` Object

An array of text objects, where each object represents a part of the text with its own text content and optional properties.

Parameter	Type	Input	Description
text_run	String		[required] Text chunk
text_properties	Object		[optional] A text styling object. List of font styling parameters to override existing styles for the given chunk of text.

JSON Payload

"text": [
  {
    "text_run": "This is part 1 of my sentence.",
    "text_properties": {}
  },
  {
    "text_run": "This is part 2 of my sentence.",
    "text_properties": {}
  }
]

---

`text_properties` Object

Text format properties.

Parameter	Type	Input	Description
font_type	String	MS supported font names	[optional] Font name
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
bullet	boolean	true; false	[optional] Enable bullet point
bullet_font_name	String	MS supported font names	[optional] Set bullet font type
bullet_character_code	Int	0-50000	[optional] Set bullet symbol
bullet_color	String	Color name, RGB(0,0,0), Hex	[optional] Set bullet color
bullet_indent_level	Int	0-100	[optional] Set bullet indent
bullet_size	Int	0-5000	[optional] Set bullet size relative to text
bullet_type	String	"Symbol" or "Number"	[optional] Use symbols or numbers
new_line	Boolean	true; false	[optional] Create new line within text box

"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",	
    "bullet": boolean,
    "bullet_font_name": "string",
    "bullet_character_code": numeric,
    "bullet_color": "string",
    "bullet_indent_level": numeric,
    "bullet_size": numeric,
    "bullet_type": "string",
    "new_line": boolean
  }

---

`settings` Object

These settings are applied at shape level.

Parameter	Type	Input	Description
height	Integer, Float	0 to 5963.92	[optional] Set shape height
width	Integer, Float	0 to 5963.92	optional] Set shape width
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.(default value if ‘unit’ field is not specified)
fill_color	String	Color name, RGB(0,0,0), Hex	[optional] Set shape background color
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	[optional] Create new line within text box

JSON payload

"settings": {
  "height": numeric,
  "width": numeric,
  "top": numeric,
  "left": numeric,
  "unit": "string",
  "fill_color": "0,0,0",
  "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
}