New-UDDashboard

Synopsis

Creates a new dashboard.

Syntax

New-UDDashboard [-Title <String>] [-Pages <DashboardPage[]>] [-Theme <Hashtable>] [-Scripts <String[]>] [-Stylesheets <String[]>] [-Logo <String>] [-DefaultTheme <String>] [-DisableThemeToggle] [-HeaderPosition <String>] [-HeaderColor <DashboardColor>] [-HeaderBackgroundColor <DashboardColor>] [-NavigationLayout <String>] [-Navigation <Hashtable[]>] [-HideUserName] [-HideNavigation] [-LoadNavigation <Endpoint>] [-HeaderContent <Endpoint>] [-PageNotFound <Endpoint>] [-NotAuthorized <Endpoint>] [-SessionTimeoutModal <ScriptBlock>] [-Menu <Endpoint>] [<CommonParameters>]

New-UDDashboard [-Title <String>] -Content <Endpoint> [-Theme <Hashtable>] [-Scripts <String[]>] [-Stylesheets <String[]>] [-Logo <String>] [-DefaultTheme <String>] [-DisableThemeToggle] [-HeaderPosition <String>] [-HeaderColor <DashboardColor>] [-HeaderBackgroundColor <DashboardColor>] [-NavigationLayout <String>] [-Navigation <Hashtable[]>] [-HideUserName] [-HideNavigation] [-LoadNavigation <Endpoint>] [-HeaderContent <Endpoint>] [-PageNotFound <Endpoint>] [-NotAuthorized <Endpoint>] [-SessionTimeoutModal <ScriptBlock>] [-Menu <Endpoint>] [<CommonParameters>]

Description

Creates a new dashboard. This component is the root element for all dashboards. You can define content, pages, themes and more.

Parameters

-Title

The title of the dashboard.

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

-Content

The content for this dashboard. When using content, it creates a dashboard with a single page.

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

-Pages <DashboardPage[]>

Pages for this dashboard. Use New-UDPage to define a page and pass an array of pages to this parameter.

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

-Theme

The theme for this dashboard. You can define a theme with New-UDTheme.

Required?                    false
Position?                    named
Default value                (Get-UDTheme -Name $UDDefaultTheme)
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Scripts <String[]>

JavaScript files to run when this dashboard is loaded. These JavaScript files can be absolute and hosted in a third-party CDN or you can host them yourself with New-PSUPublishedFolder.

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

-Stylesheets <String[]>

CSS files to run when this dashboard is loaded. These CSS files can be absolute and hosted in a third-party CDN or you can host them yourself with New-PSUPublishedFolder.

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

-Logo

A logo to display in the navigation bar. You can use New-PSUPublishedFolder to host this logo file.

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

-DefaultTheme

The default theme to show when the page is loaded. The default is to use the light theme.

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

-DisableThemeToggle

Disables the toggle for the theme.

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

-HeaderPosition

Position of the header within the dashboard.

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

-HeaderColor

The color of the header. This will override the theme colors.

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

-HeaderBackgroundColor

The background color of the header. This will override the theme colors.

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

-NavigationLayout

The layout of the navigation. Valid values are 'Temporary' and 'Permanent'.

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

-Navigation <Hashtable[]>

The navigation for the dashboard. This is an array of navigation items.

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

-HideUserName

Obsolete. This parameter was intended for testing purposes.

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

-HideNavigation

Obsolete. This parameter was intended for testing purposes.

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

-LoadNavigation

An endpoint to load navigation items. This endpoint should return an array of navigation items.

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

-HeaderContent

An endpoint to load content into the header.

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

-PageNotFound

An endpoint to load content when a page is not found.

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

-NotAuthorized

An endpoint to load content when a user is not authorized.

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

-SessionTimeoutModal

A script block that will be executed when the session times out.

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

-Menu

An endpoint to load a menu into the dashboard.

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

Outputs

Examples

Example 1

New-UDDashboard -Title 'My Dashboard' -Content {
    New-UDTypography -Text 'Hello, world!'
}

Creates a new dashboard with a single page.

Example 2

$Pages = @(
    New-UDPage -Name 'HomePage' -Content {
        New-UDTypography -Text 'Home Page'
    }
    New-UDPage -Name 'Page2' -Content {
        New-UDTypography -Text 'Page2'
    }
)

New-UDDashboard -Title 'My Dashboard' -Pages $Pages

Creates a new dashboard with multiple pages.