Skip to content

Latest commit

 

History

History
189 lines (148 loc) · 3.53 KB

File metadata and controls

189 lines (148 loc) · 3.53 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Set-OfficeExcelChartLegend

SYNOPSIS

Configures legend visibility and styling for an Excel chart.

SYNTAX

__AllParameterSets

Set-OfficeExcelChartLegend -Chart <ExcelChart> [-Position <string>] [-Overlay <bool>] [-Hide] [-FontSizePoints <double>] [-Bold <bool>] [-Italic <bool>] [-Color <string>] [-FontName <string>] [<CommonParameters>]

DESCRIPTION

Configures legend visibility and styling for an Excel chart.

EXAMPLES

EXAMPLE 1

PS>$chart | Set-OfficeExcelChartLegend -Position Right

Shows the legend on the right side of the chart and returns the chart for chaining.

PARAMETERS

-Bold

Optional bold setting for legend text.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Chart

Chart to update.

Type: ExcelChart
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Color

Optional legend text color in hex format.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-FontName

Optional legend font name.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-FontSizePoints

Optional legend font size in points.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Hide

Hide the legend instead of positioning it.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Italic

Optional italic setting for legend text.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Overlay

Overlay the legend on the chart area.

Type: Boolean
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Position

Legend position.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Bottom, Left, Right, Top, TopRight

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • OfficeIMO.Excel.ExcelChart

OUTPUTS

  • OfficeIMO.Excel.ExcelChart

RELATED LINKS

  • None