New-UDDynamic

Defines a new dynamic region in a dashboard.

Synopsis

Defines a new dynamic region in a dashboard.

Syntax

New-UDDynamic [-Id <String>] [-ArgumentList <Object[]>] [-Content] <Endpoint> [-AutoRefresh] [-AutoRefreshInterval <Int32>] [-LoadingComponent <ScriptBlock>] [<CommonParameters>]

Description

Defines a new dynamic region in a dashboard. Dynamic regions are used for loading data when the page is loaded or for loading data dynamically through user interaction or auto-reloading.

Parameters

-Id

The ID of this component.

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

-ArgumentList <Object[]>

Arguments to pass to this dynamic endpoint.

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

-Content

The content of this dynamic region.

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

    -AutoRefresh [<SwitchParameter>]
        Whether this dynamic region should refresh on an interval.

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

-AutoRefreshInterval

The amount of seconds between refreshes for this dynamic region.

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

-LoadingComponent

A component to display while this dynamic region is loading.

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

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDDynamic -Content {
PS >    New-UDTypography -Text (Get-Date) -Id 'text1'
PS > } -Id 'dynamic1'

Basic dynamic region|A simple dynamic region that executes when the user loads the page.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDDynamic -Content {
PS >    New-UDTypography -Text (Get-Date) -Id 'text2'
PS > } -AutoRefresh -AutoRefreshInterval 3 -Id 'dynamic2'

Auto refresh|A dynamic region that refreshes every 3 seconds




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDDynamic -Content {
PS >    New-UDTypography -Text (Get-Date) -Id 'text3'
PS > } -Id 'dynamic3'
PS > New-UDButton -Text 'Refresh' -OnClick {
PS >    Sync-UDElement -Id 'dynamic3'
PS > }

Sync-UDElement|A dynamic region that is updated when a button is clicked.




-------------------------- EXAMPLE 4 --------------------------

PS >New-UDDynamic -Content {
PS >    Start-Sleep 5
PS >    New-UDTypography -Text (Get-Date) -Id 'text5'
PS > } -Id 'dynamic4' -LoadingComponent {
PS >    New-UDTypography -Text 'Loading...' -Id 'text4'
PS > }
PS > New-UDButton -Text 'Refresh' -OnClick {
PS >    Sync-UDElement -Id 'dynamic4'
PS > }

Loading component|A dynamic region that displays a loading component while the dynamic region is loading.


[Component("Dynamic Region", "BoltLightning", "Creates a dynamic region.")]