PowerPoint Properties and Configuration Options

Several properties control the export of the PPTX Layout template as a PowerPoint report.

Supported Placeholder Parameters

Ansys Dynamic Reporting uses placeholder names to decide what to insert in the placeholder and how to display the content. Placeholder parameters must be separated by the ampersand (&) character.

For example, Nexus:query=A|i_date|gt|2022-02-03T17:35:00.000Z;A|i_name|eq|table;&rows=12&cols=6

Parameters	Function
`query`	A query expression following the Ansys Dynamic Reporting filtering syntax used to specify the item to insert in the placeholder.
`rows`	Number of rows per slide to be set for a table item. Must be of the form `rows=n` where `n` is the number of rows.
`cols`	Number of columns per slide to be set for a table item. Must be of the form `cols=n` where `n` is the number of columns.
`lines`	Number of lines per slide to be set for a string item. Must be of the form `lines=n` where `n` is the number of lines. A string item containing multiple lines separated by a new line character is split into several lines and each line is used as a paragraph (bullet point in the slide).
`html_header`	Uses the template’s headers set in the custom HTML header option of the Template Editor, or the `set_HTML()` method of the Python API. To use them as the slide title, each slide must be represented as a template child and the header must be set on them. Only works if `use_all_slides` is set to 0, and templates are created for the selected slides.
`comments`	Uses template comments that are saved using the Python API while creating the template. Comments can be plain text or HTML and are rendered accordingly.
`toc`	Allows a placeholder to be used to insert a table of contents. The content is a list of all slide titles available in the PPTX with links back to the corresponding slides.
`toc_link`	Allows a placeholder to be used to insert a link back to the table of contents. Link text may be pre-inserted or through a query string, for example `Nexus:toc_link&query=A\|i_date\|gt\|2022-02-03 T17:35:00.000Z;A\|i_name\|eq\|toc_link_text`. Default is the string `Table of contents`.
`breadcrumbs`	Allows a placeholder to be used to insert breadcrumbs showing the hierarchy chain of the current template, as organized when the template was initially created.
`sequence`	Allows a placeholder to be used to index in a list of items. For example, `Nexus:query= \|\| \| A\|i_date\|gt\|2022-02-03T17:35:00.000Z;&sequence=0` selects the first item in the list of items passed into a PPTX Slide template.
`excel`	Allows use of embedded Microsoft Excel if the number of columns in a table exceeds the specified limit set by `cols`. Can be `1` (on) or `0` (off). Default is `0`.
`force_excel`	Forces the use of embedded Microsoft Excel for a table in the slide at all times. Can be `1` (on) or `0` (off). Default is `0`.

PPTX Layout Template

A PPTX Layout template needs three properties to function correctly. In addition to these properties, these templates can also have their own filter queries set on them to filter the number of items being used inside themselves and their children.

Property Description

Property	Description
`input_pptx`	The value of the `input_pptx` property can either be the name of a file item or a query using the filter syntax used throughout Ansys Dynamic Reporting. If a filter query is used, it must begin with `query=`. Some valid examples for the property are: `myfile.pptx` `A\|i_name\|eq\|input.pptx` `Nexus:query=A\|i_date\|gt\|2022-02-03T17:35:00.000Z;A\|i_name\|eq\|my_pptx_item;`
`output_pptx`	The name of the output PowerPoint file to download as. Can be any string. Default is `<name-of-template>_<random_id>.pptx`.
`use_all_slides`	This property is optional. Enables the use of only specific slides from the input .pptx file. Can be `1` or `0`. Default is `1`. If set to `0`, the parent layout template must contain one or more child PPTX Slide Layout templates and have the `source_slide` property set to the index position of the slide that must be picked, from the input .pptx file. For example: If you would like the output to only contain slide 7 and 8 from the input *.pptx file: Create the parent PPTX Layout template. Set `use_all_slides` to 0 on the parent PPTX Layout. Create a child PPTX Slide Layout and set `source_slide` to 7. Create a child PPTX Slide Layout and set `source_slide` to 8. The source slides chosen by the child slide layouts must be numerically ordered. For example, 5 for the first child, 8 for the second child, 12 for the third child and so on.

input_pptx

The value of the input_pptx property can either be the name of a file item or a query using the filter syntax used throughout Ansys Dynamic Reporting. If a filter query is used, it must begin with query=. Some valid examples for the property are:

myfile.pptx
A|i_name|eq|input.pptx
Nexus:query=A|i_date|gt|2022-02-03T17:35:00.000Z;A|i_name|eq|my_pptx_item;

output_pptx The name of the output PowerPoint file to download as. Can be any string. Default is <name-of-template>_<random_id>.pptx.

use_all_slides

This property is optional.

Enables the use of only specific slides from the input *.pptx file. Can be 1 or 0. Default is 1.

If set to 0, the parent layout template must contain one or more child PPTX Slide Layout templates and have the source_slide property set to the index position of the slide that must be picked, from the input *.pptx file.

For example: If you would like the output to only contain slide 7 and 8 from the input *.pptx file:

Create the parent PPTX Layout template.
Set use_all_slides to 0 on the parent PPTX Layout.
Create a child PPTX Slide Layout and set source_slide to 7.
Create a child PPTX Slide Layout and set source_slide to 8.
The source slides chosen by the child slide layouts must be numerically ordered. For example, 5 for the first child, 8 for the second child, 12 for the third child and so on.

PPTX Slide Layout Template

PPTX Slide Layout Templates can also have their own filter queries set on them to filter the number of items being using inside themselves.

Property Description

Property	Description
`source_slide`	The index position of the slide that must be picked, from the input *.pptx file. For example, to pick the eighth slide for a PPTX Slide Layout template, set this property to 8. The default is its own index position in the list of its parent’s children. For example, the first child uses the first slide from the input file, the second child uses the second slide and so on.
`exclude_from_toc`	Excludes a specific slide from the table of contents, if there is a table of contents slide. Can be `1` or `0`. Default is `0`.

source_slide

The index position of the slide that must be picked, from the input *.pptx file.

For example, to pick the eighth slide for a PPTX Slide Layout template, set this property to 8. The default is its own index position in the list of its parent’s children. For example, the first child uses the first slide from the input file, the second child uses the second slide and so on.

exclude_from_toc Excludes a specific slide from the table of contents, if there is a table of contents slide. Can be 1 or 0. Default is 0.

Common Properties

Property	Value
`pptx_log_base`	Setting to enable logarithmic values on the value axis (Y axis) only. Can be set on the plot item or slide template. Can be any integer value that works as the logarithmic base. By default, it is disabled.
`pptx_legend_position`	Setting to set plot legend position. Can be set on the plot item or slide template. Values are: `bottom` `corner` `left` `right` `top` Default is `corner`.
`pptx_legend_overlap`	Setting to allow overlapping legends with plots in PowerPoint. Can be `1` or `0`. Default is `0`. Can be set on the plot item or slide template.
`show_legend`	Table item specific setting to show/hide plot legend. Can be `1` or `0`. Default is `1`.
`xtitle`	Table item specific setting to show plot title along the X axis.
`ytitle`	Table item specific setting to show plot title along the Y axis.
`plot_title`	Table item specific setting to show the main plot title.