AsBuiltReport.Chart

❗ THIS ASBUILTREPORT MODULE IS CURRENTLY IN DEVELOPMENT AND MIGHT NOT YET BE FUNCTIONAL ❗

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.

🔰 Getting Started

The following simple list of instructions will get you started with the AsBuiltReport.Chart module.

💾 Supported Versions

PowerShell

This report is compatible with the following PowerShell versions;

Windows PowerShell 5.1	PowerShell 7
✅	✅

🗺️ Language Support

The AsBuiltReport Chart supports the following languages;

• English (US) (Default)

🔧 System Requirements

PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a AsBuiltReport Chart.

• AsBuiltReport.Core Module

🔐 Required Privileges

Local user privilege

📦 Module Installation

PowerShell

# Install
install-module AsBuiltReport.Chart -Force

# Update
update-module AsBuiltReport.Chart -Force

💻 Examples

Here are some examples to get you going.

Pie Chart

# 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

Bar Chart

# 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

Stacked Bar Chart

# Generate a Stacked Bar Chart with the title 'Test', values of 1 and 2 for the first category and 3 and 4 for the second category, labels 'A' and 'B', legend categories 'Value1' and 'Value2', 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

📘 Example Index

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

❌ Known Issues

• No known issues at this time.