PSWriteHTML

PSWriteHTML is an open-source PowerShell project with packages, release history, and working documentation.

Stars 995

Forks 114

Open issues 69

PowerShell Gallery downloads 7,436,513

Release v1.41.0

Language: PowerShell Updated: 2026-04-11

API Reference

Function

New-MapLegendOption

Namespace PSWriteHTML

Creates a new map legend option with specified parameters.

Remarks

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

Authored help example

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.

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

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

Parameter set: All Parameter Sets

Parameters

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