AsBuiltReport.Chart is a PowerShell module which provides a set of cmdlets for generating charts and visualizations in As Built Reports. This module is designed to work seamlessly with the AsBuiltReport.Core module, allowing users to create visually appealing and informative reports with ease.
The following simple list of instructions will get you started with the AsBuiltReport.Chart module.
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
The AsBuiltReport Chart supports the following languages;
- English (US) (Default)
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating an AsBuiltReport Chart.
Local user privilege
# Installinstall-module AsBuiltReport.Chart -Force
# Updateupdate-module AsBuiltReport.Chart -ForceHere are some examples to get you going.
# Generate a Pie Chart with the title 'Test', values of 1 and 2, labels 'A' and 'B', and export the chart in PNG format. Enable the legend and set the width to 600 pixels, height to 400 pixels, title font size to 20, and label font size to 16.New-PieChart-Title 'Test'-Values @(1,2) -Labels @('A','B') -Format 'png'-EnableLegend -Width 600-Height 400-TitleFontSize 20-LabelFontSize 16
# Generate a Donut Chart with the title 'Test', values of 1 and 2, labels 'A' and 'B', and export the chart in PNG format. Enable the legend and set the width to 600 pixels, height to 400 pixels, title font size to 20, and label font size to 16.New-DonutChart-Title 'Test'-Values @(1,2) -Labels @('A','B') -Format 'png'-EnableLegend -Width 600-Height 400-TitleFontSize 20-LabelFontSize 16
# Generate a Bar Chart with the title 'Test', values of 1 and 2, labels 'A' and 'B', and export the chart in PNG format. Enable the legend and set the width to 600 pixels, height to 400 pixels, title font size to 20, and label font size to 16.New-BarChart-Title 'Test'-Values @(1,2) -Labels @('A','B') -Format 'png'-EnableLegend -Width 600-Height 400-TitleFontSize 20-LabelFontSize 16-AxesMarginsTop 1
# Generate a Stacked Bar Chart with the title 'Test', values @(1,2) for bar 'A' and @(3,4) for bar 'B' (one inner -Values array per bar matching -Labels), legend categories 'Value1' and 'Value2' for the stacked segments, and export the chart in PNG format. Enable the legend, set the legend orientation to horizontal, align the legend to the upper center, set the width to 600 pixels, height to 400 pixels, title font size to 20, label font size to 16, and axes margins top to 1.New-StackedBarChart-Title 'Test'-Values @(@(1,2),@(3,4)) -Labels @('A','B') -LegendCategories @('Value1','Value2') -Format 'png'-EnableLegend -LegendOrientation Horizontal -LegendAlignment UpperCenter -Width 600-Height 400-TitleFontSize 20-LabelFontSize 16-AxesMarginsTop 1
# Generate a Single Stacked Bar Chart with the title 'Test', values @(18, 15, 10, 5, 8) for bar 'A' and @(18, 15, 10, 5, 8) for bar 'B' (one inner -Values array per bar matching -Labels), legend categories 'Value1' and 'Value2' for the stacked segments, and export the chart in PNG format. Enable the legend, set the legend orientation to horizontal, align the legend to the upper center, set the width to 600 pixels, height to 400 pixels, title font size to 20, label font size to 16, and axes margins top to 1.New-SingleStackedBarChart-Title 'Test'-Values @(18,15,10,5,8) -Label 'Workload Type'-LegendCategories @('Category 1','Category 2','Category 3','Category 4','Category 5') -Width 600-Height 200-Format png -AreaOrientation Horizontal -EnableLegend -LegendOrientation Horizontal -LegendAlignment UpperCenter -TitleFontBold -TitleFontSize 20
# Generate a Radar Chart with the title 'Test', values of 1 and 2, labels 'A' and 'B', and export the chart in PNG format. Enable the legend and set the width to 600 pixels, height to 400 pixels, title font size to 20, and label font size to 16.New-RadarChart-Title 'Test'-Values @(@(1,2,5,8),@(3,5,4,2)) -LegendLabels @('A','B') -Format 'png'-EnableLegend -LegendOrientation Horizontal -LegendAlignment UpperCenter -Filename RadarChart -Width 600-Height 400-SpokeLabels @("Wins","Poles","Podiums","Points") -TitleFontSize 20
All examples in the latest release of AsBuiltReport.Chart can be found in the table below.
| Name | Description |
|---|---|
| Example1 | Basic Pie Chart |
| Example2 | Pie Chart with Legend, Custom Colors and Border |
| Example3 | Basic Bar Chart |
| Example4 | Bar Chart with Advanced Options |
| Example5 | Basic Stacked Bar Chart |
| Example6 | Stacked Bar Chart with Advanced Options |
| Example7 | Basic Signal Chart (Line Chart) |
| Example8 | Signal Chart with DateTime X-Axis (Time-Series Data) |
| Example9 | Signal Chart with Multiple Lines |
| Example10 | Basic Single Stacked Bar Chart |
| Example11 | Single Stacked Bar Chart with Advanced Options |
| Example12 | Basic Donut Chart |
| Example13 | Donut Chart with Legend, Custom Colors and Border |
| Example14 | Basic Radar Chart with Legend |
| Example15 | Radar Chart with Legend, Custom Colors and Border |
All chart types support an optional watermark that overlays semi-transparent text in the center of the chart. The watermark is disabled by default and is activated only when the -EnableWatermark switch is supplied.
| Parameter | Type | Default | Description |
|---|---|---|---|
EnableWatermark | Switch | (off) | Enables the watermark overlay. |
WatermarkText | String | Confidential | Text to display as the watermark. |
WatermarkFontName | String | Arial | Font family for the watermark text. |
WatermarkFontSize | Int | 24 | Font size (points) for the watermark text. |
WatermarkColor | BasicColors | Gray | Color of the watermark text. |
WatermarkOpacity | Double | 0.3 | Opacity (0.0–1.0) of the watermark. Lower values are more transparent. |
# Pie chart with default watermark (gray "Confidential" at 30% opacity)New-PieChart-Title 'Sales'-Values @(10,20,30) -Labels @('A','B','C') -Format 'png'-EnableWatermark
# Bar chart with a custom watermark text, color, and opacityNew-BarChart-Title 'Revenue'-Values @(100,200,150) -Labels @('Q1','Q2','Q3') -Format 'png'`-EnableWatermark -WatermarkText 'CONFIDENTIAL'-WatermarkColor Red -WatermarkOpacity 0.2# Stacked bar chart with a larger watermark fontNew-StackedBarChart-Title 'Budget'-Values @(@(1,2),@(3,4)) -Labels @('A','B') -LegendCategories @('X','Y') -Format 'png'`-EnableWatermark -WatermarkFontSize 36-WatermarkText 'DRAFT'# Signal chart with a custom font and opacityNew-SignalChart-Title 'Throughput'-Values @(,[double[]]@(1,2,3,4,5)) -Format 'png'`-EnableWatermark -WatermarkFontName 'Arial'-WatermarkOpacity 0.5- No known issues at this time.