Cmdlet

New-OfficeExcelDashboard

Aliases: ExcelDashboard

Module PSWriteOffice

Aliases

ExcelDashboard

Inputs

System.Object

Outputs

System.Management.Automation.PSObject

Source

NewOfficeExcelDashboardCommand.cs:21 Edit on GitHub

Builds a worksheet dashboard from tabular data using OfficeIMO dashboard defaults.

Syntax

New-OfficeExcelDashboard [-ChartColumn <Int32>] [-ChartPreset <Comparison|Trend|Contribution|CompactComparison>] [-ChartRow <Int32>] [-ChartTitle <String>] [-InputObject] <Object> [-NoAutoFilter] [-NoAutoFit] [-NoChart] [-PassThru] [-Subtitle <String>] [-TableColumn <Int32>] [-TableName <String>] [-TableRow <Int32>] [-TableStyle <ExcelTableStyle>] [-Title <String>] [<CommonParameters>]

Parameter set: Context

New-OfficeExcelDashboard [-ChartColumn <Int32>] [-ChartPreset <Comparison|Trend|Contribution|CompactComparison>] [-ChartRow <Int32>] [-ChartTitle <String>] [-InputObject] <Object> [-NoAutoFilter] [-NoAutoFit] [-NoChart] [-PassThru] -Path <String> [-Sheet <String>] [-SheetIndex <Int32>] [-Subtitle <String>] [-TableColumn <Int32>] [-TableName <String>] [-TableRow <Int32>] [-TableStyle <ExcelTableStyle>] [-Title <String>] [<CommonParameters>]

Parameter set: Path

New-OfficeExcelDashboard [-ChartColumn <Int32>] [-ChartPreset <Comparison|Trend|Contribution|CompactComparison>] [-ChartRow <Int32>] [-ChartTitle <String>] -Document <ExcelDocument> [-InputObject] <Object> [-NoAutoFilter] [-NoAutoFit] [-NoChart] [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [-Subtitle <String>] [-TableColumn <Int32>] [-TableName <String>] [-TableRow <Int32>] [-TableStyle <ExcelTableStyle>] [-Title <String>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Create a dashboard table and chart.

$rows | New-OfficeExcelDashboard -Title 'Sales Dashboard' -TableName Sales -ChartPreset CompactComparison

Writes a table and chart into the current Excel DSL worksheet.

Parameters

-ChartColumn Int32 optional: Top-left chart column.
-ChartPreset ExcelDashboardChartPreset optional: Dashboard chart preset.; Possible values: Comparison, Trend, Contribution, CompactComparison
-ChartRow Int32 optional: Top-left chart row.
-ChartTitle String optional: Chart title. Defaults to Title when omitted.
-InputObject Object requiredposition: 0pipeline: True (ByValue)aliases: Data, DataTable: Rows to render in the dashboard table.
-NoAutoFilter SwitchParameter optional: Disable AutoFilter dropdowns on the generated table.
-NoAutoFit SwitchParameter optional: Disable auto-fit for generated table columns.
-NoChart SwitchParameter optional: Do not create a chart.
-PassThru SwitchParameter optional: Emit dashboard build metadata.
-Subtitle String optional: Dashboard subtitle.
-TableColumn Int32 optional: Top-left column for the generated table.
-TableName String optional: Name for the generated table.
-TableRow Int32 optional: Top-left row for the generated table.
-TableStyle ExcelTableStyle optional: Built-in table style.; Possible values: TableStyleLight1, TableStyleLight2, TableStyleLight3, TableStyleLight4, TableStyleLight5, TableStyleLight6, TableStyleLight7, TableStyleLight8, TableStyleLight9, TableStyleLight10, TableStyleLight11, TableStyleLight12, TableStyleLight13, TableStyleLight14, TableStyleLight15, TableStyleLight16, TableStyleLight17, TableStyleLight18, TableStyleLight19, TableStyleLight20, TableStyleLight21, TableStyleMedium1, TableStyleMedium2, TableStyleMedium3, TableStyleMedium4, TableStyleMedium5, TableStyleMedium6, TableStyleMedium7, TableStyleMedium8, TableStyleMedium9, TableStyleMedium10, TableStyleMedium11, TableStyleMedium12, TableStyleMedium13, TableStyleMedium14, TableStyleMedium15, TableStyleMedium16, TableStyleMedium17, TableStyleMedium18, TableStyleMedium19, TableStyleMedium20, TableStyleMedium21, TableStyleMedium22, TableStyleMedium23, TableStyleMedium24, TableStyleMedium25, TableStyleMedium26, TableStyleMedium27, TableStyleMedium28, TableStyleDark1, TableStyleDark2, TableStyleDark3, TableStyleDark4, TableStyleDark5, TableStyleDark6, TableStyleDark7, TableStyleDark8, TableStyleDark9, TableStyleDark10, TableStyleDark11
-Title String optional: Dashboard title.
-Path String requiredaliases: FilePath, InputPathsets: Path: Workbook path to update.
-Sheet String optionalaliases: SheetName, Worksheetsets: Path, Document: Worksheet name when using Path or Document.
-SheetIndex Int32 optionalsets: Path, Document: Worksheet index (0-based) when using Path or Document.
-Document ExcelDocument requiredsets: Document: Workbook to update outside the DSL context.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.