Get Started

API Reference

Cmdlet

Add-OfficeExcelDashboardChart

Aliases: ExcelDashboardChart
Namespace PSWriteOffice
Aliases
ExcelDashboardChart
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object
Source
Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelDashboardChartCommand.cs:15 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 <Nullable`1>] [-ColorStyleId <Nullable`1>] -Column <Int32> [-HasHeaders <Boolean>] [-HeightPixels <Nullable`1>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Range <String> -Row <Int32> [-StyleId <Nullable`1>] [-Title <String>] [-WidthPixels <Nullable`1>] [<CommonParameters>]
#
Parameter set: ContextRange

Parameters

ChartType Nullable`1 optionalposition: namedpipeline: False
Optional chart type override.
ColorStyleId Nullable`1 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 Nullable`1 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 Nullable`1 optionalposition: namedpipeline: False
Optional chart style id override.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Nullable`1 optionalposition: namedpipeline: False
Optional chart width in pixels.

Outputs

System.Object

Add-OfficeExcelDashboardChart [-ChartType <Nullable`1>] [-ColorStyleId <Nullable`1>] -Column <Int32> -Document <ExcelDocument> [-HasHeaders <Boolean>] [-HeightPixels <Nullable`1>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Range <String> -Row <Int32> [-Sheet <String>] [-SheetIndex <Nullable`1>] [-StyleId <Nullable`1>] [-Title <String>] [-WidthPixels <Nullable`1>] [<CommonParameters>]
#
Parameter set: DocumentRange

Parameters

ChartType Nullable`1 optionalposition: namedpipeline: False
Optional chart type override.
ColorStyleId Nullable`1 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 Nullable`1 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 Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
StyleId Nullable`1 optionalposition: namedpipeline: False
Optional chart style id override.
Title String optionalposition: namedpipeline: False
Chart title.
WidthPixels Nullable`1 optionalposition: namedpipeline: False
Optional chart width in pixels.

Outputs

System.Object

Add-OfficeExcelDashboardChart [-ChartType <Nullable`1>] [-ColorStyleId <Nullable`1>] -Column <Int32> -Document <ExcelDocument> [-HeightPixels <Nullable`1>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Row <Int32> [-Sheet <String>] [-SheetIndex <Nullable`1>] [-StyleId <Nullable`1>] -TableName <String> [-Title <String>] [-WidthPixels <Nullable`1>] [<CommonParameters>]
#
Parameter set: DocumentTable

Parameters

ChartType Nullable`1 optionalposition: namedpipeline: False
Optional chart type override.
ColorStyleId Nullable`1 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 Nullable`1 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 Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
StyleId Nullable`1 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 Nullable`1 optionalposition: namedpipeline: False
Optional chart width in pixels.

Outputs

System.Object

Add-OfficeExcelDashboardChart [-ChartType <Nullable`1>] [-ColorStyleId <Nullable`1>] -Column <Int32> [-HeightPixels <Nullable`1>] [-IncludeCachedData <Boolean>] [-PassThru] [-Preset <Comparison|Trend|Contribution|CompactComparison>] -Row <Int32> [-StyleId <Nullable`1>] -TableName <String> [-Title <String>] [-WidthPixels <Nullable`1>] [<CommonParameters>]
#
Parameter set: ContextTable

Parameters

ChartType Nullable`1 optionalposition: namedpipeline: False
Optional chart type override.
ColorStyleId Nullable`1 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 Nullable`1 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 Nullable`1 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 Nullable`1 optionalposition: namedpipeline: False
Optional chart width in pixels.

Outputs

System.Object