For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-UDDynamic

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.

-Content

The content of this dynamic region.

-AutoRefresh

Whether this dynamic region should refresh on an interval.

-AutoRefreshInterval

The amount of seconds between refreshes for this dynamic region.

-LoadingComponent

A component to display while this dynamic region is loading.

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 dynamic region

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

Example 2: Auto refresh

A dynamic region that refreshes every 3 seconds

Example 3

Example 4: Loading component

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

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

Last updated

Was this helpful?