OxyPlot.Series.BoxPlotSeries.ps1
|
Set-StrictMode -Version 3 <# .SYNOPSIS Represents a series for box plots. .PARAMETER Parent Gets the parent model of the element. .PARAMETER BoxWidth Sets the width of the boxes (specified in x-axis units). .PARAMETER Fill Sets the fill color. If null, this color will be automatically set. .PARAMETER Items Sets the box plot items. .PARAMETER LineStyle Sets the line style. .PARAMETER MedianPointSize Sets the size of the median point. This property is only used when ShowMedianAsDot = true. .PARAMETER MedianThickness Sets the median thickness, relative to the StrokeThickness. .PARAMETER MeanPointSize Sets the size of the mean point. This property is only used when ShowMeanAsDot = true. .PARAMETER MeanThickness Sets the mean thickness, relative to the StrokeThickness. .PARAMETER OutlierSize Sets the diameter of the outlier circles (specified in points). .PARAMETER OutlierTrackerFormatString Sets the tracker format string for the outliers. Use {0} for series title, {1} for x- and {2} for y-value. .PARAMETER OutlierType Sets the type of the outliers. MarkerType.Custom is currently not supported. .PARAMETER OutlierOutline Sets the a custom polygon outline for the outlier markers. Set OxyPlot.Series.BoxPlotSeries.OutlierType to OxyPlot.MarkerType.Custom to use this property. .PARAMETER ShowBox Sets a value indicating whether to show the boxes. .PARAMETER ShowMedianAsDot Sets a value indicating whether to show the median as a dot. .PARAMETER ShowMeanAsDot Sets a value indicating whether to show the mean as a dot. .PARAMETER Stroke Sets the stroke color. .PARAMETER StrokeThickness Sets the stroke thickness. .PARAMETER WhiskerWidth Sets the width of the whiskers (relative to the BoxWidth). .PARAMETER ActualItems Gets the list of items that should be rendered. .PARAMETER ItemsSource Sets the items source. The default is null. .PARAMETER Background 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. .PARAMETER IsVisible Sets a value indicating whether this series is visible. The default is true. .PARAMETER Title Sets the title of the series. The default is null. .PARAMETER RenderInLegend Sets a value indicating whether the series should be rendered in the legend. The default is true. .PARAMETER TrackerFormatString 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. .PARAMETER TrackerKey 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. .PARAMETER MaxX Sets the maximum x-coordinate of the dataset. .PARAMETER MaxY Sets the maximum y-coordinate of the dataset. .PARAMETER MinX Sets the minimum x-coordinate of the dataset. .PARAMETER MinY Sets the minimum y-coordinate of the dataset. .PARAMETER XAxis Gets the x-axis. .PARAMETER XAxisKey Sets the x-axis key. The default is null. .PARAMETER YAxis Gets the y-axis. .PARAMETER YAxisKey Sets the y-axis key. The default is null. .PARAMETER IsXMonotonic Sets a value indicating whether the X coordinate of all data point increases monotonically. .PARAMETER WindowStartIndex Sets the last visible window start position in the data points collection. .PARAMETER Font 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. .PARAMETER FontSize 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. .PARAMETER FontWeight Sets the font weight. The default is FontWeights.Normal. .PARAMETER PlotModel Gets the parent OxyPlot.PlotElement.PlotModel. .PARAMETER Tag 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. .PARAMETER TextColor 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. .PARAMETER ToolTip Sets the tool tip. The default is null. .PARAMETER ActualFont Gets the actual font. .PARAMETER ActualFontSize Gets the actual size of the font. .PARAMETER ActualFontWeight Gets the actual font weight. .PARAMETER ActualTextColor Gets the actual color of the text. .PARAMETER ActualCulture Gets the actual culture. The culture is defined in the parent PlotModel. .PARAMETER Selectable Sets a value indicating whether this element can be selected. The default is true. .PARAMETER 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. .PARAMETER ActualSelectedColor Gets the actual selection color. .DESCRIPTION This cmdlet creates an OxyPlot.Series.BoxPlotSeries object. .PARAMETER InputObject Sets the source of the data set. .PARAMETER X Sets the column X of the data set. .PARAMETER LowerWhisker Sets the column LowerWhisker of the data set. .PARAMETER BoxBottom Sets the column BoxBottom of the data set. .PARAMETER Median Sets the column Median of the data set. .PARAMETER BoxTop Sets the column BoxTop of the data set. .PARAMETER UpperWhisker Sets the column UpperWhisker of the data set. .PARAMETER Group Specifies groups to which each element of the data set belongs. If this parameter is set, the data set will be grouped by these values, and multiple series will be produced for each group. .PARAMETER XName Specifies a property name of the input objects to be assigned to the column X of the data set. .PARAMETER LowerWhiskerName Specifies a property name of the input objects to be assigned to the column LowerWhisker of the data set. .PARAMETER BoxBottomName Specifies a property name of the input objects to be assigned to the column BoxBottom of the data set. .PARAMETER MedianName Specifies a property name of the input objects to be assigned to the column Median of the data set. .PARAMETER BoxTopName Specifies a property name of the input objects to be assigned to the column BoxTop of the data set. .PARAMETER UpperWhiskerName Specifies a property name of the input objects to be assigned to the column UpperWhisker of the data set. .PARAMETER GroupName Specifies a property name of the input objects to be treated as groups. If this parameter is set, the data set will be grouped by the values of this property, and multiple series will be produced for each group. .PARAMETER GroupingKeys Specifies effective groups and these order. This option is useful when you will select groups, or specify the order of the groups shown in the legend. .PARAMETER Options Sets properties of the object. .PARAMETER Style Sets a style of the object. .PARAMETER AddTo Specifies a plot model to which the object will be added. .INPUTS You can send any object to the cmdlet as the source of the data set. #> function New-OxyBoxPlotSeries { [cmdletbinding()] [OutputType([OxyPlot.Series.BoxPlotSeries[]], [void])] param( [Parameter(ValueFromPipeline=$true)] [object]$InputObject, [object[]]$X = @(), [object[]]$LowerWhisker = @(), [object[]]$BoxBottom = @(), [object[]]$Median = @(), [object[]]$BoxTop = @(), [object[]]$UpperWhisker = @(), [string[]]$Group = @(), [string]$XName, [string]$LowerWhiskerName, [string]$BoxBottomName, [string]$MedianName, [string]$BoxTopName, [string]$UpperWhiskerName, [string]$GroupName, [string[]]$GroupingKeys = @(), [object]$BoxWidth, [ValidatePattern('AliceBlue|AntiqueWhite|Aqua|Aquamarine|Automatic|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenrod|DarkGray|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGray|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGray|DodgerBlue|Firebrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|Goldenrod|Gray|Green|GreenYellow|Honeydew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenrodYellow|LightGray|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGray|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquamarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenrod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGray|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Undefined|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen|(#?[0-9a-f]{1,8})')][string]$Fill, [OxyPlot.Series.BoxPlotItem[]]$Items, [OxyPlot.LineStyle]$LineStyle, [object]$MedianPointSize, [object]$MedianThickness, [object]$MeanPointSize, [object]$MeanThickness, [object]$OutlierSize, [System.String]$OutlierTrackerFormatString, [OxyPlot.MarkerType]$OutlierType, [OxyPlot.ScreenPoint[]]$OutlierOutline, [System.Boolean]$ShowBox, [System.Boolean]$ShowMedianAsDot, [System.Boolean]$ShowMeanAsDot, [ValidatePattern('AliceBlue|AntiqueWhite|Aqua|Aquamarine|Automatic|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenrod|DarkGray|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGray|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGray|DodgerBlue|Firebrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|Goldenrod|Gray|Green|GreenYellow|Honeydew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenrodYellow|LightGray|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGray|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquamarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenrod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGray|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Undefined|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen|(#?[0-9a-f]{1,8})')][string]$Stroke, [object]$StrokeThickness, [object]$WhiskerWidth, [object]$MaxX, [object]$MaxY, [object]$MinX, [object]$MinY, [System.String]$XAxisKey, [System.String]$YAxisKey, [System.Collections.IEnumerable]$ItemsSource, [ValidatePattern('AliceBlue|AntiqueWhite|Aqua|Aquamarine|Automatic|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenrod|DarkGray|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGray|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGray|DodgerBlue|Firebrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|Goldenrod|Gray|Green|GreenYellow|Honeydew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenrodYellow|LightGray|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGray|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquamarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenrod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGray|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Undefined|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen|(#?[0-9a-f]{1,8})')][string]$Background, [System.Boolean]$IsVisible, [System.String]$Title, [System.Boolean]$RenderInLegend, [System.String]$TrackerFormatString, [System.String]$TrackerKey, [System.String]$Font, [object]$FontSize, [object]$FontWeight, [System.Object]$Tag, [ValidatePattern('AliceBlue|AntiqueWhite|Aqua|Aquamarine|Automatic|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenrod|DarkGray|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGray|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGray|DodgerBlue|Firebrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|Goldenrod|Gray|Green|GreenYellow|Honeydew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenrodYellow|LightGray|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGray|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquamarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenrod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGray|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Undefined|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen|(#?[0-9a-f]{1,8})')][string]$TextColor, [System.String]$ToolTip, [System.Boolean]$Selectable, [OxyPlot.SelectionMode]$SelectionMode, [OxyPlot.Model]$Parent, [hashtable]$Options = @{}, [string]$Style = "default", [OxyPlot.PlotModel]$AddTo ) begin { if (!(Test-OxyStyleName $Style)) { Write-Error "Unknown style: '$Style'" return } $info = [PSCustomObject]@{ XAxisTitle = "X" YAxisTitle = "Median" XDataType = $null YDataType = $null GroupName = $GroupName CategoryNames = @() CategoryTitle = $null } if ($PSBoundParameters.ContainsKey("XName")) { $info.XAxisTitle = $XName } if ($PSBoundParameters.ContainsKey("MedianName")) { $info.YAxisTitle = $MedianName } $XData = New-Object Collections.Generic.List[object] $LowerWhiskerData = New-Object Collections.Generic.List[object] $BoxBottomData = New-Object Collections.Generic.List[object] $MedianData = New-Object Collections.Generic.List[object] $BoxTopData = New-Object Collections.Generic.List[object] $UpperWhiskerData = New-Object Collections.Generic.List[object] $GroupData = New-Object Collections.Generic.List[string] } process { if ($InputObject -ne $null) { if ($PSBoundParameters.ContainsKey("XName")) { $XData.Add($InputObject.$XName) } if ($PSBoundParameters.ContainsKey("LowerWhiskerName")) { $LowerWhiskerData.Add($InputObject.$LowerWhiskerName) } if ($PSBoundParameters.ContainsKey("BoxBottomName")) { $BoxBottomData.Add($InputObject.$BoxBottomName) } if ($PSBoundParameters.ContainsKey("MedianName")) { $MedianData.Add($InputObject.$MedianName) } if ($PSBoundParameters.ContainsKey("BoxTopName")) { $BoxTopData.Add($InputObject.$BoxTopName) } if ($PSBoundParameters.ContainsKey("UpperWhiskerName")) { $UpperWhiskerData.Add($InputObject.$UpperWhiskerName) } if ($PSBoundParameters.ContainsKey("GroupName")) { $GroupData.Add($InputObject.$GroupName) } } } end { if ($XData.Count -gt 0 -and $X.Count -gt 0) { Write-Error "Data set of 'X' is given in two ways"; return } if ($LowerWhiskerData.Count -gt 0 -and $LowerWhisker.Count -gt 0) { Write-Error "Data set of 'LowerWhisker' is given in two ways"; return } if ($BoxBottomData.Count -gt 0 -and $BoxBottom.Count -gt 0) { Write-Error "Data set of 'BoxBottom' is given in two ways"; return } if ($MedianData.Count -gt 0 -and $Median.Count -gt 0) { Write-Error "Data set of 'Median' is given in two ways"; return } if ($BoxTopData.Count -gt 0 -and $BoxTop.Count -gt 0) { Write-Error "Data set of 'BoxTop' is given in two ways"; return } if ($UpperWhiskerData.Count -gt 0 -and $UpperWhisker.Count -gt 0) { Write-Error "Data set of 'UpperWhisker' is given in two ways"; return } if ($GroupData.Count -gt 0 -and $Group.Count -gt 0) { Write-Error "Data set of 'Group' is given in two ways"; return } $XData.AddRange($X) $LowerWhiskerData.AddRange($LowerWhisker) $BoxBottomData.AddRange($BoxBottom) $MedianData.AddRange($Median) $BoxTopData.AddRange($BoxTop) $UpperWhiskerData.AddRange($UpperWhisker) $GroupData.AddRange($Group) if ($GroupData.Count -gt 0) { $groups = @{} foreach ($e in $GroupData) { $groups[$e] = 1 } if ($GroupKeys.Count -eq 0) { $groupKeys = $groups.Keys | Sort } $grouping = $true } else { $groupKeys = @("dummy") $grouping = $false } $dataCount = $XData.Count foreach ($group in $groupKeys) { $series = New-Object OxyPlot.Series.BoxPlotSeries if ($grouping) { $series.Title = $group } for ($i = 0; $i -lt $dataCount; ++$i) { if ($grouping -and $GroupData[$i] -ne $group) { continue } if ($i -lt $XData.Count) { $XElement = $XData[$i] } else { $XElement = $null } if ($i -lt $LowerWhiskerData.Count) { $LowerWhiskerElement = $LowerWhiskerData[$i] } else { $LowerWhiskerElement = $null } if ($i -lt $BoxBottomData.Count) { $BoxBottomElement = $BoxBottomData[$i] } else { $BoxBottomElement = $null } if ($i -lt $MedianData.Count) { $MedianElement = $MedianData[$i] } else { $MedianElement = $null } if ($i -lt $BoxTopData.Count) { $BoxTopElement = $BoxTopData[$i] } else { $BoxTopElement = $null } if ($i -lt $UpperWhiskerData.Count) { $UpperWhiskerElement = $UpperWhiskerData[$i] } else { $UpperWhiskerElement = $null } Add-OxyBoxPlotSeriesPoint $series $XElement $LowerWhiskerElement $BoxBottomElement $MedianElement $BoxTopElement $UpperWhiskerElement } if ($XData.Count -gt 0) { $info.XDataType = Get-ValueType $XData[0] } if ($MedianData.Count -gt 0) { $info.YDataType = Get-ValueType $MedianData[0] } $series = $series | Add-Member -PassThru NoteProperty _Info $info Apply-OxyStyle $series $Style $MyInvocation $props = $PROPERTY_HASH["OxyPlot.Series.BoxPlotSeries"] Assign-ParametersToProperties $props $PSBoundParameters $Options $series if ($AddTo -ne $null) { Add-OxyObjectToPlotModel $series $AddTo -NoRefresh } else { $series } } if ($AddTo -ne $null) { $AddTo.InvalidatePlot($true) } } } |