New-UDTimeline

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

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 Timeline

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

A basic timeline.

Example 2: Alternate Timeline

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

An alternating timeline.

Example 3: Timeline with Icons

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

A timeline with icons.

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