New-UDSparkline

Synopsis

Small charts for displaying data.

Syntax

New-UDSparkline [-Id <String>] -Data <Int32[]> [-Limit <Int32>] [-Width <Int32>] [-Height <Int32>] [-Margin <Int32>] [-Color <DashboardColor>] [-Type <Object>] [-Min <Int32>] [-Max <Int32>] [<CommonParameters>]

New-UDSparkline [-Id <String>] -Data <Int32[]> [-Width <Int32>] [-Height <Int32>] [-PlotType <Object>] [-ShowTooltip] [-ShowHighlight] [-Area] [<CommonParameters>]

Description

Small charts for displaying data.

Parameters

-Id

The ID of this component. The default value is a random GUID.

Required?                    false
Position?                    named
Default value                [Guid]::NewGuid().ToString()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Data <Int32[]>

The data to display in the sparkline. Usually, a list of numbers.

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

-Limit

The number of data points to display.

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

-Width

The width of the sparkline.

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

-Height

The height of the sparkline.

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

-Margin

The margin of the sparkline.

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

-Color

The color of the sparkline.

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

-Type

The type of sparkline to display. Valid values are bars, lines, and both.

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

-PlotType

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

-Min

The minimum value.

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

-Max

The maximum value.

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

-ShowTooltip

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

-ShowHighlight

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

-Area

Required?                    false
Position?                    named
Default value                False
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.

Outputs

Examples

Example 1: Basic sparkline

$Data = 1..10 | ForEach-Object { Get-Random -Max 1000 }
New-UDSparkline -Data $Data -Max 1000 -Height 100 -Width 500

A basic sparkline.

Example 2: Lines

$Data = 1..10 | ForEach-Object { Get-Random -Max 1000 }
New-UDSparkline -Data $Data -Type 'lines' -Max 1000 -Height 100 -Width 500

A sparkline with lines.

Example 3: Both

$Data = 1..10 | ForEach-Object { Get-Random -Max 1000 }
New-UDSparkline -Data $Data -Type 'both' -Max 1000 -Height 100 -Width 500

A sparkline with both lines and bars.