Get Started

API Reference

Cmdlet

Set-OfficeExcelChartAxis

Aliases: ExcelChartAxis
Namespace PSWriteOffice
Aliases
ExcelChartAxis
Inputs
OfficeIMO.Excel.ExcelChart
Outputs
OfficeIMO.Excel.ExcelChart
Source
Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelChartAxisCommand.cs:21 Edit on GitHub

Configures common Excel chart axis titles, formats, scale, and gridlines.

Remarks

Configures common Excel chart axis titles, formats, scale, and gridlines.

Examples

Authored help example

Format value axis and gridlines.

PS>


$chart | Set-OfficeExcelChartAxis -CategoryTitle 'Month' -ValueTitle 'Revenue' -ValueNumberFormat '$#,##0' -ValueMinimum 0 -ValueMajorUnit 100 -ShowValueMajorGridlines

Sets axis titles, value formatting, scale, and major value gridlines.

Use a scaled date/category axis for a line chart.

PS>


$chart |
                Set-OfficeExcelChartAxis -CategoryTitle 'Week' -CategoryNumberFormat 'yyyy-mm-dd' -CategoryMinimum 46000 -CategoryMaximum 46090 -CategoryMajorUnit 14 -CategoryMinorUnit 7

Configures the chart's X axis through OfficeIMO's category/date-axis scale support while keeping the workbook chart object on the pipeline.

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

Set-OfficeExcelChartAxis [-AxisGroup <Primary|Secondary>] [-CategoryGridlineColor <String>] [-CategoryMajorUnit <Nullable`1>] [-CategoryMaximum <Nullable`1>] [-CategoryMinimum <Nullable`1>] [-CategoryMinorUnit <Nullable`1>] [-CategoryNumberFormat <String>] [-CategoryTitle <String>] -Chart <ExcelChart> [-GridlineWidthPoints <Nullable`1>] [-ShowCategoryMajorGridlines] [-ShowCategoryMinorGridlines] [-ShowValueMajorGridlines] [-ShowValueMinorGridlines] [-SourceLinked <Boolean>] [-ValueGridlineColor <String>] [-ValueMajorUnit <Nullable`1>] [-ValueMaximum <Nullable`1>] [-ValueMinimum <Nullable`1>] [-ValueMinorUnit <Nullable`1>] [-ValueNumberFormat <String>] [-ValueTitle <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AxisGroup ExcelChartAxisGroup optionalposition: namedpipeline: Falsevalues: 2
Axis group to configure.
Possible values: Primary, Secondary
CategoryGridlineColor String optionalposition: namedpipeline: False
Optional category gridline color in hex format.
CategoryMajorUnit Nullable`1 optionalposition: namedpipeline: False
Category/date axis major unit.
CategoryMaximum Nullable`1 optionalposition: namedpipeline: False
Category/date axis maximum.
CategoryMinimum Nullable`1 optionalposition: namedpipeline: False
Category/date axis minimum.
CategoryMinorUnit Nullable`1 optionalposition: namedpipeline: False
Category/date axis minor unit.
CategoryNumberFormat String optionalposition: namedpipeline: False
Category axis number format code.
CategoryTitle String optionalposition: namedpipeline: False
Category axis title.
Chart ExcelChart requiredposition: namedpipeline: True (ByValue)
Chart to update.
GridlineWidthPoints Nullable`1 optionalposition: namedpipeline: False
Optional gridline width in points.
ShowCategoryMajorGridlines SwitchParameter optionalposition: namedpipeline: False
Show category major gridlines.
ShowCategoryMinorGridlines SwitchParameter optionalposition: namedpipeline: False
Show category minor gridlines.
ShowValueMajorGridlines SwitchParameter optionalposition: namedpipeline: False
Show value major gridlines.
ShowValueMinorGridlines SwitchParameter optionalposition: namedpipeline: False
Show value minor gridlines.
SourceLinked Boolean optionalposition: namedpipeline: False
Keep axis number formats linked to source cells.
ValueGridlineColor String optionalposition: namedpipeline: False
Optional value gridline color in hex format.
ValueMajorUnit Nullable`1 optionalposition: namedpipeline: False
Value axis major unit.
ValueMaximum Nullable`1 optionalposition: namedpipeline: False
Value axis maximum.
ValueMinimum Nullable`1 optionalposition: namedpipeline: False
Value axis minimum.
ValueMinorUnit Nullable`1 optionalposition: namedpipeline: False
Value axis minor unit.
ValueNumberFormat String optionalposition: namedpipeline: False
Value axis number format code.
ValueTitle String optionalposition: namedpipeline: False
Value axis title.

Outputs

OfficeIMO.Excel.ExcelChart