< Back

New-OxyPieSeries

Sat Jan 18, 2020 6:20 pm

NAME New-OxyPieSeries



SYNOPSIS

Returns an object that represents a series for pie/circle/doughnut charts.



The arc length/central angle/area of each slice is proportional to the quantity it represents. See Pie charts

(http://en.wikipedia.org/wiki/Pie_chart).





SYNTAX

New-OxyPieSeries [-AddTo <OxyPlot.PlotModel>] [-AngleIncrement <Horker.OxyPlotCli.TypeAdaptors.Double>]

[-AngleSpan <Horker.OxyPlotCli.TypeAdaptors.Double>] [-AreInsideLabelsAngled

<Horker.OxyPlotCli.TypeAdaptors.Bool>] [-Background <Horker.OxyPlotCli.TypeAdaptors.OxyColor>] [-ColorField

<System.String>] [-Diameter <Horker.OxyPlotCli.TypeAdaptors.Double>] [-ExplodedDistance

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-Fill <Horker.OxyPlotCli.TypeAdaptors.OxyColor[]>] [-FillName

<System.String>] [-Font <System.String>] [-FontSize <Horker.OxyPlotCli.TypeAdaptors.Double>] [-FontWeight

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-Group <System.Object[]>] [-GroupName <System.String>] [-InnerDiameter

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-InputObject <System.Management.Automation.PSObject>] [-InsideLabelColor

<Horker.OxyPlotCli.TypeAdaptors.OxyColor>] [-InsideLabelFormat <System.String>] [-InsideLabelPosition

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-IsExploded <Horker.OxyPlotCli.TypeAdaptors.Bool[]>] [-IsExplodedField

<System.String>] [-IsExplodedName <System.String>] [-IsVisible <Horker.OxyPlotCli.TypeAdaptors.Bool>]

[-ItemsSource <System.Collections.IEnumerable>] [-Label <System.String[]>] [-LabelField <System.String>]

[-LabelName <System.String>] [-LegendFormat <System.String>] [-OutFile <System.String>] [-OutHeight

<System.Int32>] [-OutWidth <System.Int32>] [-OutsideLabelFormat <System.String>] [-PassThru] [-RenderInLegend

<Horker.OxyPlotCli.TypeAdaptors.Bool>] [-ReuseWindow] [-Selectable <Horker.OxyPlotCli.TypeAdaptors.Bool>]

[-SelectionMode <OxyPlot.SelectionMode>] [-Show] [-Slices

<System.Collections.Generic.IList`1[OxyPlot.Series.PieSlice]>] [-StartAngle

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-Stroke <Horker.OxyPlotCli.TypeAdaptors.OxyColor>] [-StrokeThickness

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-Style <System.String>] [-SvgIsDocument] [-Tag <System.Object>]

[-TextColor <Horker.OxyPlotCli.TypeAdaptors.OxyColor>] [-TickDistance <Horker.OxyPlotCli.TypeAdaptors.Double>]

[-TickHorizontalLength <Horker.OxyPlotCli.TypeAdaptors.Double>] [-TickLabelDistance

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-TickRadialLength <Horker.OxyPlotCli.TypeAdaptors.Double>] [-Title

<System.String>] [-ToolTip <System.String>] [-TrackerFormatString <System.String>] [-TrackerKey <System.String>]

[-Value <Horker.OxyPlotCli.TypeAdaptors.Double[]>] [-ValueField <System.String>] [-ValueName <System.String>]

[-AsPlotView] [<CommonParameters>]





DESCRIPTION

Returns an object that represents a series for pie/circle/doughnut charts.



The arc length/central angle/area of each slice is proportional to the quantity it represents. See Pie charts

(http://en.wikipedia.org/wiki/Pie_chart).





PARAMETERS

-AddTo <OxyPlot.PlotModel>

Specifies the PlotModel object to which the object is added.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AngleIncrement <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the angle increment.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AngleSpan <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the angle span.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AreInsideLabelsAngled <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether inside labels are angled.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Background <Horker.OxyPlotCli.TypeAdaptors.OxyColor>

Sets the background color of the series. The default is OxyColors.Undefined.



This property defines the background color in the area defined by the x and y axes used by this series.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ColorField <System.String>

Sets the name of the property containing the color.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Diameter <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the diameter.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ExplodedDistance <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the exploded distance.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Fill <Horker.OxyPlotCli.TypeAdaptors.OxyColor[]>

Specifies the sequence of the element Fill of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FillName <System.String>

Specifies the property name of the input object to be processed as the element Fill of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Font <System.String>

Sets the font. The default is null (use OxyPlot.PlotModel.DefaultFont.



If the value is null, the DefaultFont of the parent PlotModel will be used.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FontSize <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the size of the font. The default is double.NaN (use OxyPlot.PlotModel.DefaultFontSize).



If the value is NaN, the DefaultFontSize of the parent PlotModel will be used.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FontWeight <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the font weight. The default is FontWeights.Normal.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Group <System.Object[]>

Specifies groups to which each data point belongs. If this parameter is specified, the data points will be

grouped by these values, and multiple series will be produced for each group.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GroupName <System.String>

Specifies the property name of the input object to be treated as groups.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InnerDiameter <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the inner diameter.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <System.Management.Automation.PSObject>

Specifies a dataset that represents the data points of the series.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-InsideLabelColor <Horker.OxyPlotCli.TypeAdaptors.OxyColor>

Sets the color of the inside labels.



If the value is OxyColors.Automatic, the OxyPlot.PlotElement.TextColor will be used.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InsideLabelFormat <System.String>

Sets the inside label format.



The formatting arguments are: value {0}, label {1} and percentage {2}.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InsideLabelPosition <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the inside label position.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsExploded <Horker.OxyPlotCli.TypeAdaptors.Bool[]>

Specifies the sequence of the element IsExploded of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsExplodedField <System.String>

Sets the is exploded field.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsExplodedName <System.String>

Specifies the property name of the input object to be processed as the element IsExploded of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsVisible <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether this series is visible. The default is true.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ItemsSource <System.Collections.IEnumerable>

Sets the items source. The default is null.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Label <System.String[]>

Specifies the sequence of the element Label of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LabelField <System.String>

Sets the label field.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LabelName <System.String>

Specifies the property name of the input object to be processed as the element Label of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LegendFormat <System.String>

Sets the legend format.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-OutFile <System.String>

Specifies the output file name. The output format is determined based on the file extension, which should be

either ".png" or ".svg".



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-OutHeight <System.Int32>

Specifies the height of the output image. Use with the -OutFile parameter.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-OutWidth <System.Int32>

Specifies the width of the output image. Use with the -OutFile parameter.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-OutsideLabelFormat <System.String>

Sets the outside label format.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PassThru <System.Management.Automation.SwitchParameter>

Returns a created object when the -AddTo, -OutFile or -Show parameter is specified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-RenderInLegend <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether the series should be rendered in the legend. The default is true.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ReuseWindow <System.Management.Automation.SwitchParameter>

Indicates to reuse the most recently used window to show the chart instead of creating a new one. Use with the

-Show parameter.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Selectable <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether this element can be selected. The default is true.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SelectionMode <OxyPlot.SelectionMode>

Sets the selection mode of items in this element. The default is SelectionMode.All.



This is only used by the select/unselect functionality, not by the rendering.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Show <System.Management.Automation.SwitchParameter>

Shows the chart in the GUI window.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Slices <System.Collections.Generic.IList`1[OxyPlot.Series.PieSlice]>

Sets the slices.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-StartAngle <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the start angle.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Stroke <Horker.OxyPlotCli.TypeAdaptors.OxyColor>

Sets the stroke color.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-StrokeThickness <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the stroke thickness.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Style <System.String>

Specifies the style.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SvgIsDocument <System.Management.Automation.SwitchParameter>

Indicates that a SVG file should be generated as a complete document. Use with the -OutFile parameter.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Tag <System.Object>

Sets an arbitrary object value that can be used to store custom information about this plot element. The

default is null.



This property is analogous to Tag properties in other Microsoft programming models. Tag is intended to provide

a pre-existing property location where you can store some basic custom information about any PlotElement

without requiring you to subclass an element.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextColor <Horker.OxyPlotCli.TypeAdaptors.OxyColor>

Sets the color of the text. The default is OxyColors.Automatic (use OxyPlot.PlotModel.TextColor).



If the value is OxyColors.Automatic, the TextColor of the parent PlotModel will be used.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TickDistance <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the distance from the edge of the pie slice to the tick line.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TickHorizontalLength <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the length of the horizontal part of the tick.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TickLabelDistance <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the distance from the tick line to the outside label.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TickRadialLength <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the length of the radial part of the tick line.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Title <System.String>

Sets the title of the series. The default is null.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ToolTip <System.String>

Sets the tool tip. The default is null.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TrackerFormatString <System.String>

Sets a format string used for the tracker. The default depends on the series.



The arguments for the format string may be different for each type of series. See the documentation.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TrackerKey <System.String>

Sets the key for the tracker to use on this series. The default is null.



This key may be used by the plot view to show a custom tracker for the series.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Value <Horker.OxyPlotCli.TypeAdaptors.Double[]>

Specifies the sequence of the element Value of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ValueField <System.String>

Sets the name of the property containing the value.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ValueName <System.String>

Specifies the property name of the input object to be processed as the element Value of the data point.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AsPlotView <System.Management.Automation.SwitchParameter>

Returns an object as a PlotView object.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Management.Automation.PSObject







OUTPUTS

Horker.OxyPlotCli.SeriesInfo`1[[OxyPlot.Series.PieSeries, OxyPlot, Version=2.0.0.0, Culture=neutral,

PublicKeyToken=638079a8f0bd61e9]]







NOTES











RELATED LINKS

Online Version: https://github.com/horker/oxyplotcli2/b ... eSeries.md

http://en.wikipedia.org/wiki/Pie_chart http://en.wikipedia.org/wiki/Pie_chart