New-UDChartJSDataset

Synopsis

Creates a new ChartJS dataset.

Syntax

New-UDChartJSDataset [[-Data] <Object>] [[-DataProperty] <String>] [[-Label] <String>] [[-BackgroundColor] <DashboardColor[]>] [[-BorderColor] <DashboardColor[]>] [[-BorderWidth] <Int32>] [[-HoverBackgroundColor] <DashboardColor[]>] [[-HoverBorderColor] <DashboardColor[]>] [[-HoverBorderWidth] <Int32>] [[-XAxisId] <String>] [[-YAxisId] <String>] [[-AdditionalOptions] <Hashtable>] [<CommonParameters>]

Description

Creates a new ChartJS dataset. This cmdlet is used to create a new dataset for New-UDChartJS.

Parameters

-Data

The data for the dataset. The format of the data depends on the type of chart you are creating.

Required?                    false
Position?                    1
Default value                @()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-DataProperty

The property of the data object to use as the data for the dataset.

Required?                    false
Position?                    2
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Label

The label for the dataset.

Required?                    false
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-BackgroundColor <DashboardColor[]>

The background color for the dataset.

Required?                    false
Position?                    4
Default value                @("#807B210C")
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-BorderColor <DashboardColor[]>

The border color for the dataset.

Required?                    false
Position?                    5
Default value                @("#FF7B210C")
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-BorderWidth

The border width for the dataset.

Required?                    false
Position?                    6
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-HoverBackgroundColor <DashboardColor[]>

The hover background color for the dataset.

Required?                    false
Position?                    7
Default value                @("#807B210C")
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-HoverBorderColor <DashboardColor[]>

The hover border color for the dataset.

Required?                    false
Position?                    8
Default value                @("#FF7B210C")
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-HoverBorderWidth

The hover border width for the dataset.

Required?                    false
Position?                    9
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-XAxisId

The ID of the X axis to use for the dataset.

Required?                    false
Position?                    10
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-YAxisId

The ID of the Y axis to use for the dataset.

Required?                    false
Position?                    11
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-AdditionalOptions

A hashtable of additional options to apply to the dataset. See the ChartJS documentation for more information.

Required?                    false
Position?                    12
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Create multiple datasets

$Data = Get-Process | Sort-Object -Property CPU -Descending | Select-Object -First 10

$CPUDataset = New-UDChartJSDataset -DataProperty CPU -Label CPU -BackgroundColor '#126f8c'
$MemoryDataset = New-UDChartJSDataset -DataProperty HandleCount -Label 'Handle Count' -BackgroundColor '#8da322'
$Options = @{
    Type = 'bar'
    Data = $Data
    Dataset = @($CPUDataset, $MemoryDataset)
    LabelProperty = 'ProcessName'
}
New-UDChartJS @Options

Creates CPU and handle-count datasets and displays them in a bar chart.