Configuration options#
Several properties control the export of the PPTX Layout template as a Powerpoint report.
Supported placeholder parameters#
ADR uses placeholder names to decide what to insert in the placeholder and how to display the content. Placeholder parameters must be separated by “&”, just like in a URL.
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 ADR's 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 or HTML 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 PPT slide). |
html_header |
HTML headers will use the template’s headers usually set using the custom HTML header option of the template editor or the set_HTML() method of the Python API. In order to use them as the slide title, each slide must be represented as a template child and the header must be set on them. (i.e. 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 will be rendered accordingly. |
toc |
Allows a placeholder to be considered for insertion of table of contents. The content will be a list of all slide titles available in the pptx with links back to the corresponding slides. |
toc_link |
Allows a placeholder to be considered to insert a link back to the table of contents. Link text may be pre-inserted or through a query string. Eg: “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 support for indexing in a list of items for a placeholder using the "sequence" param. Eg: "Nexus:query= A|i_date|gt|2022-02-03T17:35:00.000Z;&sequence=0" will choose the first item in the list of items passed into a PPTX Slide template. |
PPTX Layout Template#
Property |
Value |
|---|---|
input_pptx |
The input PowerPoint template file to begin with. This should contain a bunch of empty slides with placeholders that are expected to be filled with items. |
use_all_slides |
Property to enable the use of only specific slides from the input pptx file. Can be ‘1’ or ‘0’. Default is ‘1’. If set to ‘0’, it must contain one or more child PPTX Slide Layout templates. |
output_pptx |
The name of the output PowerPoint file to download as. Can be any string. Default is “<name-of-template>_<random_id>.pptx”. |
PPTX Slide Layout Template#
Property |
Value |
|---|---|
source_slide |
The index position of the slide that must be picked, from the input pptx. For example, in order to pick the 8th 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 1st slide from the input pptx, the second child uses the 2nd slide and so on. |
exclude_from_toc |
Property to enable the exclusion of 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 bottom/corner/left/right/top. Can be set on the plot item or slide template. 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. 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. |