New-UDDataGrid

Synopsis

Affiche des données dans une grille de type tableau.

Syntaxe

New-UDDataGrid [[-Id] <String>] [[-Columns] <Hashtable[]>] [[-LoadRows] <Endpoint>] [[-Height] <String>] [[-AutoHeight] <Boolean>] [-AutoPageSize] [-CheckboxSelection] [-CheckboxSelectionVisibleOnly] [[-ColumnBuffer] <Int32>] [[-ColumnThreshold] <Int32>] [[-Density] <String>] [[-PageSize] <Int32>] [[-RowsPerPageOptions] <Int32[]>] [-ShowPagination] [[-OnSelectionChange] <Endpoint>] [[-Language] <String>] [[-LoadDetailContent] <Endpoint>] [[-DetailHeight] <String>] [[-OnEdit] <Endpoint>] [[-OnExport] <Endpoint>] [-ShowQuickFilter] [[-DefaultSortColumn] <String>] [[-DefaultSortDirection] <String>] [-DisableRowSelectionOnClick] [-HideExport] [[-RowHeight] <Int32>] [[-IdentityColumn] <String>] [-StripedRows] [-HeaderFilters] [-AutoSizeColumns] [[-ExportOptions] <String[]>] [<CommonParameters>]

Description

Affiche des données dans une grille de type tableau. Prend en charge le tri, la pagination et le filtrage de grands ensembles de données.

Paramètres

-Id

L'ID de cette grille de données.

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

-Columns <Hashtable[]>

Un tableau de colonnes à afficher dans ce tableau.

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

-LoadRows

Le bloc de script qui charge les données pour cette grille.

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

-Height

La hauteur statique de cette grille de données.

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

-AutoHeight

Indique s'il faut calculer la hauteur de cette grille de données.

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

-AutoPageSize

Détermine automatiquement la taille de la page.

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

-CheckboxSelection

Sélection par case à cocher pour les lignes.

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

-CheckboxSelectionVisibleOnly

Description du paramètre

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

-ColumnBuffer

Description du paramètre

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

-ColumnThreshold

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

-Density

La densité visible du tableau.

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

-PageSize

La taille de page par défaut.

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

-RowsPerPageOptions <Int32[]>

Un tableau de tailles de page.

Required?                    false
Position?                    10
Default value                @(5, 10, 25)
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ShowPagination

Indique s'il faut afficher la pagination.

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

-OnSelectionChange

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

-Language

La langue à utiliser pour le texte dans la grille de données.

Required?                    false
Position?                    12
Default value                en-US
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-LoadDetailContent

Un bloc de script qui est appelé lorsque les lignes sont développées. $EventData contiendra les données de la ligne.

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

-DetailHeight

La hauteur statique du volet de détails.

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

-OnEdit

Un bloc de script qui est appelé lorsque la ligne est modifiée. $EventData inclura les données modifiées. Retournez un objet pour mettre à jour la ligne de la grille de données.

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

-OnExport

Un bloc de script qui est appelé lorsque les données sont exportées.

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

-ShowQuickFilter

Affiche une boîte de filtre rapide (recherche).

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

-DefaultSortColumn

La colonne de tri par défaut.

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

-DefaultSortDirection

La direction de tri par défaut.

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

-DisableRowSelectionOnClick

Désactive la sélection de ligne au clic.

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

-HideExport

Masque le bouton d'exportation.

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

-RowHeight

La hauteur des lignes.

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

-IdentityColumn

La colonne d'identité de la grille de données.

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

-StripedRows

Indique s'il faut utiliser des couleurs de lignes alternées.

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

-HeaderFilters

Indique s'il faut afficher les filtres dans les en-têtes de colonnes.

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

-AutoSizeColumns

Dimensionne automatiquement les colonnes.

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

-ExportOptions <String[]>

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

Paramètres communs

Cette applet de commande prend en charge les paramètres communs : Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable et OutVariable. Pour plus d'informations, consultez about_CommonParameters.

Sorties

Exemples

Exemple 1 : Grille de données de base

New-UDDataGrid -LoadRows {
    $Data = @(
        @{ Name = 'Adam'; Number = Get-Random}
        @{ Name = 'Tom'; Number = Get-Random}
        @{ Name = 'Sarah'; Number = Get-Random}
    )
    @{
        rows = $Data
        rowCount = $Data.Length
    }
} -Columns @(
    New-UDDataGridColumn -Field 'Name'
    New-UDDataGridColumn -Field 'Number'
) -Id 'dataGrid1'

Crée une grille de données de base avec des colonnes.

Exemple 2

New-UDDataGrid -LoadRows {
    $Data = 1..1000 | ForEach-Object {
        @{ Name = "User$($_)"; Number = Get-Random }
    }
    Out-UDDataGridData -Data $Data -Total $Data.Length -Context $EventData
} -Columns @(
    New-UDDataGridColumn -Field 'Name'
    New-UDDataGridColumn -Field 'Number'
) -Pagination -Id 'dataGrid2'

Out-UDDataGridData|Adds support for filtering, sorting, and paging.

Exemple 3 : Rendu

New-UDDataGrid -LoadRows {
    $Data = 1..100 | % {
        @{ Name = 'Adam'; Number = Get-Random}
    }
    Out-UDDataGridData -Data $Data -Total $Data.Length -Context $EventData

} -Columns @(
    New-UDDataGridColumn -Field 'Name' -Render {
        New-UDAlert -Text $EventData.Name -Dense
    }
    New-UDDataGridColumn -Field 'Number'
) -Pagination -Id 'dataGrid3'

Ajoute la prise en charge du rendu personnalisé des colonnes.

Exemple 4 : Contenu détaillé

New-UDDataGrid -LoadRows {
    $Data = @(
        @{ Name = 'Adam'; Number = Get-Random }
        @{ Name = 'Tom'; Number = Get-Random }
        @{ Name = 'Sarah'; Number = Get-Random }
    )
    @{
        rows     = $Data
        rowCount = $Data.Length
    }
} -Columns @(
    New-UDDataGridColumn -Field 'Name'
    New-UDDataGridColumn -Field 'Number'
) -LoadDetailContent {
    New-UDAlert -Text $EventData.row.Name
} -Id 'dataGrid4'

Ajoute la prise en charge du contenu détaillé.

Exemple 5 : Modification

$Cache:Data = @(
    @{ Name = 'Adam'; number = Get-Random }
    @{ Name = 'Tom'; number = Get-Random }
    @{ Name = 'Sarah'; number = Get-Random }
)
New-UDDataGrid -LoadRows {
    $Cache:Data| Out-UDDataGridData -Context $EventData -TotalRows $Cache:Data.Length
} -Columns @(
    New-UDDataGridColumn -Field name -Render {
        New-UDButton -Text $EventData.number
    }
    New-UDDataGridColumn -Field number -Editable
) -AutoHeight $true -OnEdit {
    $Cache:Data | Where-Object { $_.Name -eq $EventData.NewRow.Name } | ForEach-Object {
        $_.Number = $EventData.NewRow.Number
    }
} -Id 'datagrid5'

Ajoute la prise en charge de la modification des lignes.

Exemple 6

New-UDDataGrid -LoadRows {
    $Data = @(
        @{ Name = 'Adam'; number = Get-Random }
        @{ Name = 'Tom'; number = Get-Random }
        @{ Name = 'Sarah'; number = Get-Random }
    )
    @{
        rows     = $Data
        rowCount = $Data.Length
    }
} -Columns @(
    New-UDDataGridColumn -Field 'Name' -HeaderName 'A Name' -Flex 1 -HeaderAlign 'center' -Align 'center' -DisableColumnMenu
    New-UDDataGridColumn -Field 'Number' -HeaderName 'A Number' -Flex 1 -HeaderAlign 'right' -Align 'right' -DisableColumnMenu
) -Id 'dataGrid6'

Options de colonne|

Exemple 7 : Sélection

New-UDDataGrid -LoadRows {
    $Data = @(
        @{ Id = 1; Name = 'Adam'; number = Get-Random }
        @{ Id = 2; Name = 'Tom'; number = Get-Random }
        @{ Id = 3; Name = 'Sarah'; number = Get-Random }
    )
    @{
        rows     = $Data
        rowCount = $Data.Length
    }
} -Columns @(
    New-UDDataGridColumn -Field 'Name' -HeaderName 'A Name' -Flex 1 -HeaderAlign 'center' -Align 'center' -DisableColumnMenu
    New-UDDataGridColumn -Field 'Number' -HeaderName 'A Number' -Flex 1 -HeaderAlign 'right' -Align 'right' -DisableColumnMenu
) -Id 'dataGrid7' -CheckboxSelection -CheckboxSelectionVisibleOnly -DisableRowSelectionOnClick

Ajoute la prise en charge de la sélection de lignes.