AsBuiltReport.Chart/Examples/Example15.ps1 at dev · AsBuiltReport/AsBuiltReport.Chart · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<#
    .SYNOPSIS
    Example 15 - Advanced Radar Chart

    .DESCRIPTION
    This example demonstrates how to create a Advanced Radar Chart using the AsBuiltReport.Chart module.
    The chart displays a security posture assessment for two data centers across multiple categories.
#>

[CmdletBinding()]
param (
    [System.IO.DirectoryInfo] $Path = (Get-Location).Path,
    [string] $Format = 'png'
)

<#
    Starting with PowerShell v3, modules are auto-imported when needed. Importing the module here
    ensures clarity and avoids ambiguity.
#>

# Import-Module AsBuiltReport.Chart -Force -Verbose:$false

<#
    Since the chart output is a file, specify the output folder path using $OutputFolderPath.
#>

$OutputFolderPath = Resolve-Path $Path

<#
    Define the data to be displayed in the chart.
    In a real-world scenario these values would come from your infrastructure query.
#>

$ChartTitle = 'Security Posture Assessment'
$Values = @(@(1, 2, 5, 8), @(3, 5, 4, 2))
$Labels = @('USA DataCenter', 'UK DataCenter')
$Spokes = @('Network Security', 'Endpoint Security', 'Identity Management', 'Data Protection')

<#
    The New-RadarChart cmdlet generates the Radar Chart image.

    -Title              : Sets the chart title displayed at the top of the image.
    -Values             : Array of numeric values, one per axis.
    -LegendLabels       : Array of label strings corresponding to each value.
    -SpokeLabels        : Array of label strings for each spoke on the radar chart.
    -SpokesLength       : Length of the spokes (axes) in the radar chart.
    -Format             : Output file format (e.g. png, jpg, svg).
    -OutputFolderPath   : Directory where the generated chart file will be saved.
    -Width              : Width of the chart image in pixels.
    -Height             : Height of the chart image in pixels.
    -ColorPalette       : Predefined color palette (e.g. Category20, Pastel).
    -Filename           : Name of the output file (without extension).
#>

New-RadarChart `
    -Title $ChartTitle `
    -Values $Values `
    -LegendLabels $Labels `
    -SpokeLabels $Spokes `
    -SpokesLength 9 `
    -Format $Format `
    -EnableLegend `
    -OutputFolderPath $OutputFolderPath `
    -Width 600 `
    -Height 400 `
    -ColorPalette Aurora `
    -Filename 'Example15-RadarChart'