Command

New-MapLegendOption

Module: PSWriteHTML

Creates a new map legend option with specified parameters.

Syntax

New-MapLegendOption
[[-Mode] <horizontal|vertical>]
[[-RedrawOnResize] <Nullable`1>]
[[-Title] <String>]
[-Type] <area|plot>
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

This function creates a new map legend option with the provided parameters. It allows customization of the legend title, redraw behavior on resize, and display mode.

Examples

Example 1

New-MapLegendOption -Type "area" -Title "Area Legend" -RedrawOnResize $true -Mode "horizontal"
Creates a new map legend option for an area with the title "Area Legend", redraws on resize, and displays horizontally.

Example 2

New-MapLegendOption -Type "plot" -Title "Plot Legend" -Mode "vertical"
Creates a new map legend option for a plot with the title "Plot Legend" and displays vertically.

Parameters

-Mode String optionalposition: 3: Specifies the display mode of the legend option. Valid values are 'horizontal' and 'vertical'.; Possible values: horizontal, vertical
-RedrawOnResize Nullable<T> optionalposition: 2: Specifies whether the legend should redraw on resize. Default is $null.
-Title String optionalposition: 1: Specifies the title of the legend option.
-Type Object requiredposition: 0: Specifies the type of the legend option. Valid values are 'area' and 'plot'.; Possible values: area, plot

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.