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

Code to create a PPTX report

import hw
import hm
import os

import report.hwxpptxtypes as reporting

rep_ses = reporting.ReportSession(name="Report Demo")
pres = reporting.Presentation()
pres.resolution = "HD"
pres.template = os.path.join(
    hm.altair_home, "mv/scripts/tcl/report/templates/pptTemplate.pptx"
)

capture = hw.CaptureImageTool()
capture.type = "jpg"
capture.width = 1920
capture.height = 1080

imgList = list()
imgPath = "C:/Temp/image01.jpg"
imgList.append(imgPath)
capture.file = imgPath
capture.capture()

slide = reporting.Slide(
    "Report Demo | Images",
    presentation=pres,
)
slide.layout("One Image with Caption")

image = reporting.Image()
image.path = imgPath
slide.add(image, "pic1")

pres.savePPTX(
    "C:/Temp/report_test.pptx",
    open=True,
    mode="write",
)

for img in imgList:
    os.remove(img)

rep_ses.reset()

Figure 1. Slide with Image captured directly from graphics area

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

Code to create a pptx with table and equation

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"

rep_ses = reporting.ReportSession()

pres = reporting.Presentation()
pres.template = os.path.join(
    hm.altair_home, "mv/scripts/tcl/report/templates/pptTemplate.pptx"
)

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")

pres.savePPTX(open=True)

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