Slide Settings

This page describes how to set your slide settings in the request data.

In the slide settings section you provide any information and data related to the slide itself. For example: id, question, base and layout.

Slide settings fields

Name	Type	Required	Description
id	String	false	A unique slide ID
table_text	String	true	The table name. This will be replaced by the {table_name} tag in any placeholder on your pptx template.
question_text	String	true	The question text. This will be replaced by the {question} tag in any placeholder on your pptx template.
base_text	String	false	If provided, it will be inserted into the placeholder with the “{base}” placeholder tag. If not provided, generic base will be used, example: Base: {cross break name} = {corresponding value}
layout	Object	true	Indicates which layout should be used. For more info about layout read the concepts section.
charts	Array	true	Defines the charts to be rendered in the chart placeholders from your .pptx template.
custom_obj	Object	false	This parameter can be used to pass in any internal params you need. Max size: 300 bytes.

If you want to provide more than 1 chart per slide you'll need to purchase the multichart feature.

Layout

Name	Type	Required	Description
slide_master_index	Integer	true	Layout master index identifies which master slide layout should be used.
slide_layout_index	Integer/String	true	Layout master index identifies which slide layout should be used. You can also pass the name of the layout instead as it appears in power point.

Concepts

Example in JSON

{
	"body": [{
		"slide": {
			"id": "desired-unique-id",
			"table_text": "Colors",
			"question_text": "What is your favourite color?",
			"base_text": "Base Colors",
			"layout": {
				"slide_master_index": 0,
				"slide_layout_index": 1
			}
		},
		"charts": [],
		"custom_obj": {}
	}]
}

If the provided .pptx template layout only has 1 chart placeholder and in the request you are sending more than 1 chart object for that slide, then only the first chart object from the request will be rendered.