New-OfficeExcelDashboard

Aliases: ExcelDashboard

Namespace PSWriteOffice

Aliases

ExcelDashboard

Inputs

System.Object

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/NewOfficeExcelDashboardCommand.cs:18 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Create a dashboard table and chart.

PS>


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

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

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.

Syntax

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

Parameter set: Context

Parameters

ChartColumn Nullable`1 optionalposition: namedpipeline: False: Top-left chart column.
ChartPreset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4: Dashboard chart preset.; Possible values: Comparison, Trend, Contribution, CompactComparison
ChartRow Nullable`1 optionalposition: namedpipeline: False: Top-left chart row.
ChartTitle String optionalposition: namedpipeline: False: 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 optionalposition: namedpipeline: False: Disable AutoFilter dropdowns on the generated table.
NoAutoFit SwitchParameter optionalposition: namedpipeline: False: Disable auto-fit for generated table columns.
NoChart SwitchParameter optionalposition: namedpipeline: False: Do not create a chart.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit dashboard build metadata.
Subtitle String optionalposition: namedpipeline: False: Dashboard subtitle.
TableColumn Int32 optionalposition: namedpipeline: False: Top-left column for the generated table.
TableName String optionalposition: namedpipeline: False: Name for the generated table.
TableRow Int32 optionalposition: namedpipeline: False: Top-left row for the generated table.
TableStyle String optionalposition: namedpipeline: False: Built-in table style.
Title String optionalposition: namedpipeline: False: Dashboard title.

Outputs

System.Management.Automation.PSObject

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

Parameter set: Path

Parameters

ChartColumn Nullable`1 optionalposition: namedpipeline: False: Top-left chart column.
ChartPreset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4: Dashboard chart preset.; Possible values: Comparison, Trend, Contribution, CompactComparison
ChartRow Nullable`1 optionalposition: namedpipeline: False: Top-left chart row.
ChartTitle String optionalposition: namedpipeline: False: Chart title. Defaults to Title when omitted.
InputObject Object requiredposition: 0pipeline: True (ByValue)aliases: Data, DataTable: Rows to render in the dashboard table.
InputPath String requiredposition: namedpipeline: Falsealiases: FilePath, Path: Workbook path to update.
NoAutoFilter SwitchParameter optionalposition: namedpipeline: False: Disable AutoFilter dropdowns on the generated table.
NoAutoFit SwitchParameter optionalposition: namedpipeline: False: Disable auto-fit for generated table columns.
NoChart SwitchParameter optionalposition: namedpipeline: False: Do not create a chart.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit dashboard build metadata.
Sheet String optionalposition: namedpipeline: Falsealiases: SheetName, Worksheet: Worksheet name when using Path or Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Path or Document.
Subtitle String optionalposition: namedpipeline: False: Dashboard subtitle.
TableColumn Int32 optionalposition: namedpipeline: False: Top-left column for the generated table.
TableName String optionalposition: namedpipeline: False: Name for the generated table.
TableRow Int32 optionalposition: namedpipeline: False: Top-left row for the generated table.
TableStyle String optionalposition: namedpipeline: False: Built-in table style.
Title String optionalposition: namedpipeline: False: Dashboard title.

Outputs

System.Management.Automation.PSObject

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

Parameter set: Document

Parameters

ChartColumn Nullable`1 optionalposition: namedpipeline: False: Top-left chart column.
ChartPreset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4: Dashboard chart preset.; Possible values: Comparison, Trend, Contribution, CompactComparison
ChartRow Nullable`1 optionalposition: namedpipeline: False: Top-left chart row.
ChartTitle String optionalposition: namedpipeline: False: Chart title. Defaults to Title when omitted.
Document ExcelDocument requiredposition: namedpipeline: False: Workbook to update outside the DSL context.
InputObject Object requiredposition: 0pipeline: True (ByValue)aliases: Data, DataTable: Rows to render in the dashboard table.
NoAutoFilter SwitchParameter optionalposition: namedpipeline: False: Disable AutoFilter dropdowns on the generated table.
NoAutoFit SwitchParameter optionalposition: namedpipeline: False: Disable auto-fit for generated table columns.
NoChart SwitchParameter optionalposition: namedpipeline: False: Do not create a chart.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit dashboard build metadata.
Sheet String optionalposition: namedpipeline: Falsealiases: SheetName, Worksheet: Worksheet name when using Path or Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Path or Document.
Subtitle String optionalposition: namedpipeline: False: Dashboard subtitle.
TableColumn Int32 optionalposition: namedpipeline: False: Top-left column for the generated table.
TableName String optionalposition: namedpipeline: False: Name for the generated table.
TableRow Int32 optionalposition: namedpipeline: False: Top-left row for the generated table.
TableStyle String optionalposition: namedpipeline: False: Built-in table style.
Title String optionalposition: namedpipeline: False: Dashboard title.

Outputs

System.Management.Automation.PSObject