PowerPoint Reports

Some examples require external input files. Before you start, please follow the link in the Example Scripts section to download the zip file with model and result files.

Example 01 - Creating a PPTX report with a single screenshot

After initializing the report session and presentation, a slide is defined.

Two image objects are created. The first one is generated by using the CaptureImageTool. The second one is created via the reporting APIs. Specifically, by setting the second image source to "graphic", the image is captured from the grpahics directly in the specified resolution.

The update() method is used to capture all the images from the graphics. The crop attribute can be used to crop the images.

Finally, the images are added to the slide and the presentation is exported.

import hw
import hm
import os

import report.hwxpptxtypes as reporting

# Initializing report session
rep_ses = reporting.ReportSession()

# Creating report, setting resolution and template
pres = reporting.Presentation()
pres.resolution = "HD"
pres.template = f"{hm.altair_home}/hwx/scripts/python/report/io/presentation/templates/pptTemplate.pptx"

# Capturing using capture tool
capture = hw.CaptureImageTool()
capture.type = "jpg"
capture.width = 1920
capture.height = 1080

imgList = list()
imgPath = f'{hw.appinfo("CURRENTWORKINGDIR")}/image01.jpg'
imgList.append(imgPath)
capture.file = imgPath
capture.capture()

slide = reporting.Slide(
    "Report Demo | Images",
    presentation=pres,
)
slide.layout("Two Images with Captions")

# Defining two image one using a file and other from graphics

image1 = reporting.Image()
image1.path = imgPath
image1.caption = "Image from CaptureImageTool"

image2 = reporting.Image()
image2.source = "graphic" # By default it captures from page=1, window=1
image2.crop = True # The exported image is cropped.
image2.caption = "Image catpured using Report APIs"

slide.add(image1, "pic1")
slide.add(image2, "pic2")

# Forcing the capture of all images in the current presentation in which,
# the source is "graphic".
pres.update()

errObj, filepath = pres.savePPTX(
    f'{hw.appinfo("CURRENTWORKINGDIR")}/report_test.pptx',
    open=True,
    mode="write",
    newname="true",
)

# If status=0 then presention successfully published
if errObj.status == 0:
    print("Presentation is published at", filepath)

for img in imgList:
    os.remove(img)

Figure 1. Slide with Images captured directly from graphics area

Example 02 - Creating a PPTX report with a table/equation/image

After initializing the report session and presentation, a slide is created and its layour is defined.

A table, a text, and an image object are defined. The table content is generated from a CSV file and the image is defined via a byte stream from a file.

After all objects are added to the slide, the presentation is exported.

import hw
import hm
import os
import numpy as np

import report.hwxpptxtypes as reporting

session = hw.Session()
datadir = rf"{hm.altair_home}\demos\report\data"

# Initializing report session
rep_ses = reporting.ReportSession()

# Defining presentation and setting the template
pres = reporting.Presentation()
pres.template = f"{hm.altair_home}/hwx/scripts/python/report/io/presentation/templates/pptTemplate.pptx"

# Defining slide and slide layout
slide1 = reporting.Slide(
    "Report Demo | Table | Equation | Binary Image",
    presentation=pres,
)
slide1.layout("One Table with Text and Image")

# Create a Table, remove row 8 and column 2
tab1 = reporting.Table("Table1")
tab1.csvFile = os.path.join(datadir, "model_mass.csv")
tab1.caption = "Entire Model Mass Statistics Summary."
tab1.removeRow(8)
tab1.removeColumn(2)
# Merge two cells
cell1 = tab1.cell(0, 0)
cell2 = tab1.cell(1, 1)
tab1.mergeCells(cell1, cell2)


# Create a text with equations
text1 = reporting.Text()
text1.text = r"expr($\frac{d(x^5)}{dx} = 5 x^4$)"

# Create an image from binary stream
img_bin_path = os.path.join(datadir, "element_coordinate_system.png")
with open(img_bin_path, "rb") as f:
    img_bin = f.read()
img1 = reporting.Image()
img1.binarydata = np.frombuffer(img_bin, dtype=np.ubyte)

# Add content to slide
slide1.add(text1, "Text_1")
slide1.add(tab1, "Table_1")
slide1.add(img1, "Image_1")

# Export in the working directory with default name
errObj, filepath = pres.savePPTX(open=True)

# If status=0 then presention successfully published
if errObj.status == 0:
    print("Presentation is published at", filepath)

Figure 2. Slide with Table, Equation (Text) and Image

Example 03 - Creating a PPTX report with a video captured from the graphics

After initializing the report session and presentation, two slides are defined.

For the video definition, an image object is used with source="graphic" and format="mp4".

After the video is added to the first slide, a paragraph is defined using a text object and added to the second slide.

Finally, the presentation is exported.

Note

The example requires a model and results to be loaded in the HyperView client prior to executing the code.

import hw
import hm

import report.hwxpptxtypes as reporting

session = hw.Session()
datadir = rf"{hm.altair_home}\demos\report\data"

# Initializing report session
rep_ses = reporting.ReportSession()

# Defining presentation and setting the template
pres = reporting.Presentation()
pres.template = f"{hm.altair_home}/hwx/scripts/python/report/io/presentation/templates/pptTemplate.pptx"

# Defining slide
slide1 = reporting.Slide(
    "Report Demo | Video",
    presentation=pres,
)

# Create an mp4 video captured from graphics
img1 = reporting.Image()
img1.source = "graphic"
img1.format = "mp4"

slide1.add(img1, "Image_1")

# Defining slide
slide2 = reporting.Slide(
    "Report Demo | Paragraph",
    presentation=pres,
)

# Create a text with equations
text1 = reporting.Text()
text1.text = "Content_1"

pg_1 = text1.getParagraph()
text_run1 = pg_1.getRun()
text_run1.underline = True # Underline
text_run1.italicFont = True # Bold
text_run1.lineBreak = True # Break after line
text_run1.fontColor = [255, 0, 0] # red color in text
text_run1.fontSize = 15 # Change font size
text_run1.fontName = "Calibri" # Change font
pg_1.bulletType =  reporting.MsBulletType.BulletUnnumbered
pg_1.bulletStyle=reporting.PpBulletCharStyle.filledRoundCircle

# Adding another text using paragraph
pg_2 = reporting.Paragraph(parent=text1) # Alt: text1.addParagraph()
text_run2 = pg_2.getRun()
text_run2.runText = "Content_2"
text_run2.fontSize = 12
pg_2.bulletType =  reporting.MsBulletType.BulletUnnumbered
pg_2.bulletStyle = reporting.PpBulletCharStyle.filledRoundCircle

# Add content to slide
slide2.add(text1, "Text_1")

# Forcing the capture of all images in the current presentation in which,
# the source is "graphic".
pres.update()

# Export in the working directory with default name
errObj, filepath = pres.savePPTX(open=True)

# If status=0 then presention successfully published
if errObj.status == 0:
    print("Presentation is published at", filepath)

Figure 2. Slides with Video and paragraph