New-UDTimeline

The timeline displays a list of events in chronological order.

Synopsis

The timeline displays a list of events in chronological order.

Syntax

New-UDTimeline [[-Id] <String>] [[-Children] <ScriptBlock>] [[-Position] <String>] [[-Sx] <Hashtable>] [<CommonParameters>]

Description

The timeline displays a list of events in chronological order.

Parameters

-Id

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

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

-Children

The content of this timeline.

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

-Position

The position of the timeline. Valid values are right, left, and alternate.

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

-Sx

Required?                    false
Position?                    4
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-UDTimeline -Children {
PS >     New-UDTimelineItem -Content {
PS >         'Breakfast'
PS >     } -OppositeContent {
PS >         '7:45 AM'
PS >     }
PS >     New-UDTimelineItem -Content {
PS >         'Welcome Message'
PS >     } -OppositeContent {
PS >         '9:00 AM'
PS >     }
PS >     New-UDTimelineItem -Content {
PS >         'State of the Shell'
PS >     } -OppositeContent {
PS >         '9:30 AM'
PS >    }
PS >     New-UDTimelineItem -Content {
PS >         'General Session'
PS >     } -OppositeContent {
PS >         '11:00 AM'
PS >     }
PS > } -Id 'timeline1'

Basic Timeline|A basic timeline.




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

PS >New-UDTimeline -Children {
PS >     New-UDTimelineItem -Content {
PS >         'Breakfast'
PS >     } -OppositeContent {
PS >         '7:45 AM'
PS >     }
PS >     New-UDTimelineItem -Content {
PS >         'Welcome Message'
PS >     } -OppositeContent {
PS >         '9:00 AM'
PS >     }
PS >     New-UDTimelineItem -Content {
PS >         'State of the Shell'
PS >     } -OppositeContent {
PS >         '9:30 AM'
PS >     }
PS >     New-UDTimelineItem -Content {
PS >         'General Session'
PS >     } -OppositeContent {
PS >         '11:00 AM'
PS >     }
PS > } -Position alternate -Id 'timeline2'

Alternate Timeline|An alternating timeline.




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

PS >New-UDTimeline -Children {
PS >     New-UDTimelineItem -Content {
PS >         'Breakfast'
PS >     } -OppositeContent {
PS >         '7:45 AM'
PS >     } -Icon (New-UDIcon -Icon 'CheckCircle' -Color 'success')
PS >     New-UDTimelineItem -Content {
PS >         'Welcome Message'
PS >     } -OppositeContent {
PS >         '9:00 AM'
PS >     } -Icon (New-UDIcon -Icon 'CheckCircle' -Color 'success')
PS >     New-UDTimelineItem -Content {
PS >         'State of the Shell'
PS >     } -OppositeContent {
PS >         '9:30 AM'
PS >     } -Icon (New-UDIcon -Icon 'CheckCircle' -Color 'success')
PS >     New-UDTimelineItem -Content {
PS >         'General Session'
PS >     } -OppositeContent {
PS >         '11:00 AM'
PS >     } -Icon (New-UDIcon -Icon 'CheckCircle' -Color 'success')
PS > } -Id 'timeline3'

Timeline with Icons|A timeline with icons.

[Component("Timeline", "Timeline", "Creates a new card.")]