New-UDGrid
SYNOPSIS
Creates a grid in the dashboard.
SYNTAX
New-UDGrid [[-Id] <String>] [[-Title] <String>] [[-Headers] <String[]>] [[-Properties] <String[]>]
[[-DefaultSortColumn] <String>] [-DefaultSortDescending] [[-BackgroundColor] <DashboardColor>]
[[-FontColor] <DashboardColor>] [[-Links] <Hashtable[]>] [-ServerSideProcessing] [[-DateTimeFormat] <String>]
[[-PageSize] <Int32>] [-NoPaging] [[-FilterText] <String>] [-NoFilter] [-Endpoint] <Object>
[[-ArgumentList] <Object[]>] [-AutoRefresh] [[-RefreshInterval] <Int32>] [-NoExport] [<CommonParameters>]
DESCRIPTION
Creates a grid in the dashboard with data supplied by a PowerShell endpoint.
EXAMPLES
Basic Grid
New-UDGrid -Title "Random Numbers" -Endpoint {
@(
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
) | Out-UDGridData
}
Custom Headers
New-UDGrid -Title "Process Information" -Headers @("Name", "Process Id", "Start Time", "Responding") -Properties @("Name", "Id", "StartTime", "Responding") -Endpoint {
@(
[PSCustomObject]@{ Name = "chrome"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
[PSCustomObject]@{ Name = "notepad"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
[PSCustomObject]@{ Name = "devenv"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
[PSCustomObject]@{ Name = "code"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
[PSCustomObject]@{ Name = "calc"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
[PSCustomObject]@{ Name = "minesweeper"; Id = 1223; StartTime = "12:12PM"; Responding = $true}
) | Out-UDGridData
}
Auto refresh
New-UDGrid -Title "Random Numbers" -Endpoint {
@(
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
[PSCustomObject]@{ X = Get-Random; Y = Get-Random; Z = Get-Random}
) | Out-UDGridData
} -AutoRefresh
Auto refreshing grid
Custom Cells
New-UDGrid -Title "Process Information" -Headers @("Name", "Process Id", "Start Time", "Responding") -Properties @("Name", "Id", "StartTime", "Responding") -Endpoint {
@(
[PSCustomObject]@{ Name = "chrome"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
[PSCustomObject]@{ Name = "notepad"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
[PSCustomObject]@{ Name = "devenv"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
[PSCustomObject]@{ Name = "code"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
[PSCustomObject]@{ Name = "calc"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
[PSCustomObject]@{ Name = "minesweeper"; Id = 1223; StartTime = "12:12PM"; Responding = New-UDIcon -Icon check}
) | Out-UDGridData
}
PARAMETERS
-ArgumentList
Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.
Type: System.Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AutoRefresh
Enables auto refresh for this control.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-BackgroundColor
The background color of the grid.
Type: UniversalDashboard.Models.DashboardColor
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DateTimeFormat
The DateTime format to use in the Grid. This is a MomentJS DateTime format.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultSortColumn
Specifies the column index of the default sort column. This index begins with zero.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultSortDescending
Specifies whether to sort descending or ascending by default.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Endpoint
The endpoint that returns the grid data.
Type: System.Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterText
Text to override the "Filter" placeholder text.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FontColor
The font color of the grid.
Type: UniversalDashboard.Models.DashboardColor
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Headers
The headers to use for the grid columns. The count of headers should match the count of properties.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The id of the grid. This is the HTML markup ID.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Links
Links to display on the bottom of the grid. Use New-UDLink to generate a link.
Type: System.Collections.Hashtable[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoExport
Removes the export button from the grid.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-NoFilter
Removes the filter text box from the grid.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-NoPaging
Disables paging for this grid.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
The number of items to display per page.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Properties
The properties to select from objects for data in the row. The number of properties should match the number of headers.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RefreshInterval
The number of seconds between refreshes. The default is 5.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerSideProcessing
Turns on server side processing for the grid. This disables client-side filtering, sort and paging.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Title
The title of the section for this grid.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.