Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Add-OfficeExcelDashboardChart

Aliases: ExcelDashboardChart
Namespace PSWriteOffice
Aliases
ExcelDashboardChart
Inputs
OfficeIMO.Excel.ExcelDocument
Source
Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelDashboardChartCommand.cs:17 Edit on GitHub

Adds a dashboard-ready chart using an OfficeIMO chart preset.

Remarks

Adds a dashboard-ready chart using an OfficeIMO chart preset.

Examples

Authored help example

Add a compact comparison chart.

PS>


ExcelSheet 'Dashboard' { Add-OfficeExcelDashboardChart -Range A1:B12 -Preset CompactComparison -Row 1 -Column 5 -Title 'Revenue' }

Creates a styled chart from the range using reusable OfficeIMO dashboard chart defaults.

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

Add-OfficeExcelDashboardChart [-ChartType <ColumnClustered>] [-ColorStyleId <Int32>] -Column <Int32> [-HasHeaders <Boolean>] [-HeightPixels <Int32>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Range <String> -Row <Int32> [-StyleId <Int32>] [-Title <String>] [-WidthPixels <Int32>] [<CommonParameters>]
#
Parameter set: ContextRange

Parameters

ChartType ExcelChartType optionalposition: namedpipeline: Falsevalues: 35
Optional chart type override.
Possible values: ColumnClustered, ColumnStacked, ColumnStacked100, Column3DClustered, Column3DStacked, Column3DStacked100, BarClustered, BarStacked, BarStacked100, Bar3DClustered, Bar3DStacked, Bar3DStacked100, Line, LineStacked, LineStacked100, Line3D, Area, AreaStacked, AreaStacked100, Area3D, Area3DStacked, Area3DStacked100, Pie, Pie3D, PieOfPie, BarOfPie, Doughnut, Scatter, Bubble, Radar, Stock, Surface, SurfaceWireframe, SurfaceContour, SurfaceContourWireframe
ColorStyleId Int32 optionalposition: namedpipeline: False
Optional chart color style id override.
Column Int32 requiredposition: namedpipeline: False
Top-left column (1-based) where the chart should be placed.
HasHeaders Boolean optionalposition: namedpipeline: False
Whether the range includes headers.
HeightPixels Int32 optionalposition: namedpipeline: False
Optional chart height in pixels.
IncludeCachedData Boolean optionalposition: namedpipeline: False
Include cached data in the chart for portability.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created chart.
Preset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4
Dashboard chart preset.
Possible values: Comparison, Trend, Contribution, CompactComparison
Range String requiredposition: 0pipeline: False
A1 range containing chart data.
Row Int32 requiredposition: namedpipeline: False
Top-left row (1-based) where the chart should be placed.
StyleId Int32 optionalposition: namedpipeline: False
Optional chart style id override.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Int32 optionalposition: namedpipeline: False
Optional chart width in pixels.
Add-OfficeExcelDashboardChart [-ChartType <ColumnClustered>] [-ColorStyleId <Int32>] -Column <Int32> -Document <ExcelDocument> [-HasHeaders <Boolean>] [-HeightPixels <Int32>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Range <String> -Row <Int32> [-Sheet <String>] [-SheetIndex <Int32>] [-StyleId <Int32>] [-Title <String>] [-WidthPixels <Int32>] [<CommonParameters>]
#
Parameter set: DocumentRange

Parameters

ChartType ExcelChartType optionalposition: namedpipeline: Falsevalues: 35
Optional chart type override.
Possible values: ColumnClustered, ColumnStacked, ColumnStacked100, Column3DClustered, Column3DStacked, Column3DStacked100, BarClustered, BarStacked, BarStacked100, Bar3DClustered, Bar3DStacked, Bar3DStacked100, Line, LineStacked, LineStacked100, Line3D, Area, AreaStacked, AreaStacked100, Area3D, Area3DStacked, Area3DStacked100, Pie, Pie3D, PieOfPie, BarOfPie, Doughnut, Scatter, Bubble, Radar, Stock, Surface, SurfaceWireframe, SurfaceContour, SurfaceContourWireframe
ColorStyleId Int32 optionalposition: namedpipeline: False
Optional chart color style id override.
Column Int32 requiredposition: namedpipeline: False
Top-left column (1-based) where the chart should be placed.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
HasHeaders Boolean optionalposition: namedpipeline: False
Whether the range includes headers.
HeightPixels Int32 optionalposition: namedpipeline: False
Optional chart height in pixels.
IncludeCachedData Boolean optionalposition: namedpipeline: False
Include cached data in the chart for portability.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created chart.
Preset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4
Dashboard chart preset.
Possible values: Comparison, Trend, Contribution, CompactComparison
Range String requiredposition: 0pipeline: False
A1 range containing chart data.
Row Int32 requiredposition: namedpipeline: False
Top-left row (1-based) where the chart should be placed.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Int32 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
StyleId Int32 optionalposition: namedpipeline: False
Optional chart style id override.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Int32 optionalposition: namedpipeline: False
Optional chart width in pixels.
Add-OfficeExcelDashboardChart [-ChartType <ColumnClustered>] [-ColorStyleId <Int32>] -Column <Int32> -Document <ExcelDocument> [-HeightPixels <Int32>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Row <Int32> [-Sheet <String>] [-SheetIndex <Int32>] [-StyleId <Int32>] -TableName <String> [-Title <String>] [-WidthPixels <Int32>] [<CommonParameters>]
#
Parameter set: DocumentTable

Parameters

ChartType ExcelChartType optionalposition: namedpipeline: Falsevalues: 35
Optional chart type override.
Possible values: ColumnClustered, ColumnStacked, ColumnStacked100, Column3DClustered, Column3DStacked, Column3DStacked100, BarClustered, BarStacked, BarStacked100, Bar3DClustered, Bar3DStacked, Bar3DStacked100, Line, LineStacked, LineStacked100, Line3D, Area, AreaStacked, AreaStacked100, Area3D, Area3DStacked, Area3DStacked100, Pie, Pie3D, PieOfPie, BarOfPie, Doughnut, Scatter, Bubble, Radar, Stock, Surface, SurfaceWireframe, SurfaceContour, SurfaceContourWireframe
ColorStyleId Int32 optionalposition: namedpipeline: False
Optional chart color style id override.
Column Int32 requiredposition: namedpipeline: False
Top-left column (1-based) where the chart should be placed.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
HeightPixels Int32 optionalposition: namedpipeline: False
Optional chart height in pixels.
IncludeCachedData Boolean optionalposition: namedpipeline: False
Include cached data in the chart for portability.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created chart.
Preset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4
Dashboard chart preset.
Possible values: Comparison, Trend, Contribution, CompactComparison
Row Int32 requiredposition: namedpipeline: False
Top-left row (1-based) where the chart should be placed.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Int32 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
StyleId Int32 optionalposition: namedpipeline: False
Optional chart style id override.
TableName String requiredposition: 0pipeline: False
Table name containing chart data.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Int32 optionalposition: namedpipeline: False
Optional chart width in pixels.
Add-OfficeExcelDashboardChart [-ChartType <ColumnClustered>] [-ColorStyleId <Int32>] -Column <Int32> [-HeightPixels <Int32>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Row <Int32> [-StyleId <Int32>] -TableName <String> [-Title <String>] [-WidthPixels <Int32>] [<CommonParameters>]
#
Parameter set: ContextTable

Parameters

ChartType ExcelChartType optionalposition: namedpipeline: Falsevalues: 35
Optional chart type override.
Possible values: ColumnClustered, ColumnStacked, ColumnStacked100, Column3DClustered, Column3DStacked, Column3DStacked100, BarClustered, BarStacked, BarStacked100, Bar3DClustered, Bar3DStacked, Bar3DStacked100, Line, LineStacked, LineStacked100, Line3D, Area, AreaStacked, AreaStacked100, Area3D, Area3DStacked, Area3DStacked100, Pie, Pie3D, PieOfPie, BarOfPie, Doughnut, Scatter, Bubble, Radar, Stock, Surface, SurfaceWireframe, SurfaceContour, SurfaceContourWireframe
ColorStyleId Int32 optionalposition: namedpipeline: False
Optional chart color style id override.
Column Int32 requiredposition: namedpipeline: False
Top-left column (1-based) where the chart should be placed.
HeightPixels Int32 optionalposition: namedpipeline: False
Optional chart height in pixels.
IncludeCachedData Boolean optionalposition: namedpipeline: False
Include cached data in the chart for portability.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created chart.
Preset ExcelDashboardChartPreset optionalposition: namedpipeline: Falsevalues: 4
Dashboard chart preset.
Possible values: Comparison, Trend, Contribution, CompactComparison
Row Int32 requiredposition: namedpipeline: False
Top-left row (1-based) where the chart should be placed.
StyleId Int32 optionalposition: namedpipeline: False
Optional chart style id override.
TableName String requiredposition: 0pipeline: False
Table name containing chart data.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Int32 optionalposition: namedpipeline: False
Optional chart width in pixels.