Command

New-ImageChartOptions

Module imageplayground

Inputs

None

Outputs

ImagePlayground.ChartRenderOptions

Creates renderer options for New-ImageChart.

Syntax

New-ImageChartOptions [-BarLayout <Grouped|Stacked>] [-DonutCenterLabel <String>] [-DonutCenterValue <String>] [-DonutInnerRadiusRatio <Double>] [-HeatmapScale <Sequential|Semantic>] [-LegendPosition <Bottom|Top|Left|Right>] [-NoAxes] [-NoCard] [-NoHeatmapScale] [-NoLegend] [-NoPlotBackground] [-NoProgressHandles] [-Palette <ChartColor[]>] [-PictorialColumns <Int32>] [-PictorialSymbol <ChartPictorialSymbol>] [-PieLabelContent <Label|Value|Percent|LabelAndValue|LabelAndPercent>] [-ProgressMaximum <Double>] [-ShowDataLabels] [-ShowLegend] [-ShowPointLegend] [-TickCount <Int32>] [-Transparent] [-WordCloudMaximumTerms <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Create options for a labeled chart with a right-side legend

New-ImageChartOptions -ShowLegend -LegendPosition Right -ShowDataLabels -Palette '#8B5CF6','#2DD4BF'

Stack bar series

New-ImageChart -Title 'Builds by result' -XLabel Mon, Tue, Wed -Options (New-ImageChartOptions -BarLayout Stacked -ShowLegend) -FilePath builds.png { New-ImageChartBar -Name Passed -Value 41, 38, 45; New-ImageChartBar -Name Failed -Value 3, 6, 2 }

Parameters

-BarLayout ChartBarLayout optional: How several bar series share one category: Grouped (side by side) or Stacked.; Possible values: Grouped, Stacked
-DonutCenterLabel String optional: Donut center label text.
-DonutCenterValue String optional: Donut center value text.
-DonutInnerRadiusRatio Double optional: Donut inner radius ratio.
-HeatmapScale ChartHeatmapColorScale optional: Heatmap color scale.; Possible values: Sequential, Semantic
-LegendPosition ChartLegendPosition optional: Legend placement.; Possible values: Bottom, Top, Left, Right
-NoAxes SwitchParameter optional: Hide axes.
-NoCard SwitchParameter optional: Hide chart card surface.
-NoHeatmapScale SwitchParameter optional: Hide heatmap scale legend.
-NoLegend SwitchParameter optional: Hide the legend.
-NoPlotBackground SwitchParameter optional: Hide plot background surface.
-NoProgressHandles SwitchParameter optional: Hide progress handles.
-Palette ChartColor[] optional: Palette colors used by series and point-based charts.
-PictorialColumns Int32 optional: Pictorial columns per row.
-PictorialSymbol ChartPictorialSymbol optional: Pictorial symbol.; Possible values: Circle, Square, Diamond, Triangle, Star, Person
-PieLabelContent ChartPieLabelContent optional: Pie and donut slice label content.; Possible values: Label, Value, Percent, LabelAndValue, LabelAndPercent
-ProgressMaximum Double optional: Progress maximum.
-ShowDataLabels SwitchParameter optional: Show data labels.
-ShowLegend SwitchParameter optional: Show the legend.
-ShowPointLegend SwitchParameter optional: Show point-level legend entries.
-TickCount Int32 optional: Preferred number of axis ticks.
-Transparent SwitchParameter optional: Use transparent background.
-WordCloudMaximumTerms Int32 optional: Maximum number of word cloud terms.

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.

Outputs

ImagePlayground.ChartRenderOptions: Renderer-neutral chart options exposed by ImagePlayground.