oxyplotcli

1.0.0

OxyPlot.Series.HighLowSeries.ps1

                                Set-StrictMode -Version 3

<#

.SYNOPSIS

Represents a series for high-low plots.

See link (http://www.mathworks.com/help/toolbox/finance/highlowfts.html)

.PARAMETER Parent

Gets the parent model of the element.

.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 Color

Sets the color of the item.

.PARAMETER ActualColor

Gets the actual color of the item.

.PARAMETER Dashes

Sets the dashes array.

If this is not null it overrides the LineStyle property.

.PARAMETER DataFieldClose

Sets the data field for the Close value.

.PARAMETER DataFieldHigh

Sets the data field for the High value.

.PARAMETER DataFieldLow

Sets the data field for the Low value.

.PARAMETER DataFieldOpen

Sets the data field for the Open value.

.PARAMETER DataFieldX

Sets the x data field (time).

.PARAMETER Items

Gets the items of the series.

.PARAMETER LineJoin

Sets the line join.

.PARAMETER LineStyle

Sets the line style.

.PARAMETER Mapping

Sets the mapping delegate.

Example: series1.Mapping = item => new HighLowItem(((MyType)item).Time,((MyType)item).Value);

.PARAMETER StrokeThickness

Sets the thickness of the curve.

.PARAMETER TickLength

Sets the length of the open/close ticks (screen coordinates).

.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.

.LINK

http://www.mathworks.com/help/toolbox/finance/highlowfts.html

.PARAMETER InputObject

Sets the source of the data set.

.PARAMETER X

Sets the column X of the data set.

.PARAMETER InputObject

Sets the source of the data set.

.PARAMETER High

Sets the column High of the data set.

.PARAMETER InputObject

Sets the source of the data set.

.PARAMETER Low

Sets the column Low of the data set.

.PARAMETER InputObject

Sets the source of the data set.

.PARAMETER Open

Sets the column Open of the data set.

.PARAMETER InputObject

Sets the source of the data set.

.PARAMETER Close

Sets the column Close 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 HighName

Specifies a property name of the input objects to be assigned to the column High of the data set.

.PARAMETER LowName

Specifies a property name of the input objects to be assigned to the column Low of the data set.

.PARAMETER OpenName

Specifies a property name of the input objects to be assigned to the column Open of the data set.

.PARAMETER CloseName

Specifies a property name of the input objects to be assigned to the column Close 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-OxyHighLowSeries {

  [cmdletbinding()]

  [OutputType([OxyPlot.Series.HighLowSeries[]], [void])]

  param(

    [Parameter(ValueFromPipeline=$true)]

    [object]$InputObject,

    [object[]]$X = @(),

    [double[]]$High = @(),

    [double[]]$Low = @(),

    [double[]]$Open = @(),

    [double[]]$Close = @(),

    [string[]]$Group = @(),

    [string]$XName,

    [string]$HighName,

    [string]$LowName,

    [string]$OpenName,

    [string]$CloseName,

    [string]$GroupName,

    [string[]]$GroupingKeys = @(),

    [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]$Color,

    [double[]]$Dashes,

    [string]$DataFieldClose,

    [string]$DataFieldHigh,

    [string]$DataFieldLow,

    [string]$DataFieldOpen,

    [string]$DataFieldX,

    [OxyPlot.LineJoin]$LineJoin,

    [OxyPlot.LineStyle]$LineStyle,

    [System.Func[System.Object,OxyPlot.Series.HighLowItem]]$Mapping,

    [double]$StrokeThickness,

    [double]$TickLength,

    [double]$MaxX,

    [double]$MaxY,

    [double]$MinX,

    [double]$MinY,

    [string]$XAxisKey,

    [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,

    [bool]$IsVisible,

    [string]$Title,

    [bool]$RenderInLegend,

    [string]$TrackerFormatString,

    [string]$TrackerKey,

    [string]$Font,

    [double]$FontSize,

    [double]$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,

    [string]$ToolTip,

    [bool]$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 = "Close"

    XDataType = $null

    YDataType = $null

    GroupName = $GroupName

    CategoryNames = @()

    CategoryTitle = $null

  }

  if ($PSBoundParameters.ContainsKey("XName")) { $info.XAxisTitle = $XName }

  if ($PSBoundParameters.ContainsKey("CloseName")) { $info.YAxisTitle = $CloseName }

  $XData = New-Object Collections.Generic.List[object]

  $HighData = New-Object Collections.Generic.List[double]

  $LowData = New-Object Collections.Generic.List[double]

  $OpenData = New-Object Collections.Generic.List[double]

  $CloseData = New-Object Collections.Generic.List[double]

  $GroupData = New-Object Collections.Generic.List[string]

  Set-StrictMode -Off

}

process {

  if ($InputObject -ne $null) {

    if ($PSBoundParameters.ContainsKey("XName")) { $XData.Add($InputObject.$XName) }

    if ($PSBoundParameters.ContainsKey("HighName")) { $HighData.Add($InputObject.$HighName) }

    if ($PSBoundParameters.ContainsKey("LowName")) { $LowData.Add($InputObject.$LowName) }

    if ($PSBoundParameters.ContainsKey("OpenName")) { $OpenData.Add($InputObject.$OpenName) }

    if ($PSBoundParameters.ContainsKey("CloseName")) { $CloseData.Add($InputObject.$CloseName) }

    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 ($HighData.Count -gt 0 -and $High.Count -gt 0) { Write-Error "Data set of 'High' is given in two ways"; return }

  if ($LowData.Count -gt 0 -and $Low.Count -gt 0) { Write-Error "Data set of 'Low' is given in two ways"; return }

  if ($OpenData.Count -gt 0 -and $Open.Count -gt 0) { Write-Error "Data set of 'Open' is given in two ways"; return }

  if ($CloseData.Count -gt 0 -and $Close.Count -gt 0) { Write-Error "Data set of 'Close' 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)

  $HighData.AddRange($High)

  $LowData.AddRange($Low)

  $OpenData.AddRange($Open)

  $CloseData.AddRange($Close)

  $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.HighLowSeries

    if ($grouping) {

      $series.Title = $group

    }

    foreach ($key in $Options.Keys) {

      $series.$key = $Options[$key]

    }

    if ($PSBoundParameters.ContainsKey('Color')) { $series.Color = New-OxyColor $Color }

    if ($PSBoundParameters.ContainsKey('Dashes')) { $series.Dashes = $Dashes }

    if ($PSBoundParameters.ContainsKey('DataFieldClose')) { $series.DataFieldClose = $DataFieldClose }

    if ($PSBoundParameters.ContainsKey('DataFieldHigh')) { $series.DataFieldHigh = $DataFieldHigh }

    if ($PSBoundParameters.ContainsKey('DataFieldLow')) { $series.DataFieldLow = $DataFieldLow }

    if ($PSBoundParameters.ContainsKey('DataFieldOpen')) { $series.DataFieldOpen = $DataFieldOpen }

    if ($PSBoundParameters.ContainsKey('DataFieldX')) { $series.DataFieldX = $DataFieldX }

    if ($PSBoundParameters.ContainsKey('LineJoin')) { $series.LineJoin = $LineJoin }

    if ($PSBoundParameters.ContainsKey('LineStyle')) { $series.LineStyle = $LineStyle }

    if ($PSBoundParameters.ContainsKey('Mapping')) { $series.Mapping = $Mapping }

    if ($PSBoundParameters.ContainsKey('StrokeThickness')) { $series.StrokeThickness = $StrokeThickness }

    if ($PSBoundParameters.ContainsKey('TickLength')) { $series.TickLength = $TickLength }

    if ($PSBoundParameters.ContainsKey('MaxX')) { $series.MaxX = $MaxX }

    if ($PSBoundParameters.ContainsKey('MaxY')) { $series.MaxY = $MaxY }

    if ($PSBoundParameters.ContainsKey('MinX')) { $series.MinX = $MinX }

    if ($PSBoundParameters.ContainsKey('MinY')) { $series.MinY = $MinY }

    if ($PSBoundParameters.ContainsKey('XAxisKey')) { $series.XAxisKey = $XAxisKey }

    if ($PSBoundParameters.ContainsKey('YAxisKey')) { $series.YAxisKey = $YAxisKey }

    if ($PSBoundParameters.ContainsKey('ItemsSource')) { $series.ItemsSource = $ItemsSource }

    if ($PSBoundParameters.ContainsKey('Background')) { $series.Background = New-OxyColor $Background }

    if ($PSBoundParameters.ContainsKey('IsVisible')) { $series.IsVisible = $IsVisible }

    if ($PSBoundParameters.ContainsKey('Title')) { $series.Title = $Title }

    if ($PSBoundParameters.ContainsKey('RenderInLegend')) { $series.RenderInLegend = $RenderInLegend }

    if ($PSBoundParameters.ContainsKey('TrackerFormatString')) { $series.TrackerFormatString = $TrackerFormatString }

    if ($PSBoundParameters.ContainsKey('TrackerKey')) { $series.TrackerKey = $TrackerKey }

    if ($PSBoundParameters.ContainsKey('Font')) { $series.Font = $Font }

    if ($PSBoundParameters.ContainsKey('FontSize')) { $series.FontSize = $FontSize }

    if ($PSBoundParameters.ContainsKey('FontWeight')) { $series.FontWeight = $FontWeight }

    if ($PSBoundParameters.ContainsKey('Tag')) { $series.Tag = $Tag }

    if ($PSBoundParameters.ContainsKey('TextColor')) { $series.TextColor = New-OxyColor $TextColor }

    if ($PSBoundParameters.ContainsKey('ToolTip')) { $series.ToolTip = $ToolTip }

    if ($PSBoundParameters.ContainsKey('Selectable')) { $series.Selectable = $Selectable }

    if ($PSBoundParameters.ContainsKey('SelectionMode')) { $series.SelectionMode = $SelectionMode }

    if ($PSBoundParameters.ContainsKey('Parent')) { $series.Parent = $Parent }

    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 $HighData.Count) { $HighElement = $HighData[$i] } else { $HighElement = $null }

      if ($i -lt $LowData.Count) { $LowElement = $LowData[$i] } else { $LowElement = $null }

      if ($i -lt $OpenData.Count) { $OpenElement = $OpenData[$i] } else { $OpenElement = $null }

      if ($i -lt $CloseData.Count) { $CloseElement = $CloseData[$i] } else { $CloseElement = $null }

      Add-OxyCandleStickSeriesPoint $series $XElement $HighElement $LowElement $OpenElement $CloseElement

    }

    if ($XData.Count -gt 0) { $info.XDataType = $XData[0].GetType() }

    if ($CloseData.Count -gt 0) { $info.YDataType = $CloseData[0].GetType() }

    $series = $series | Add-Member -PassThru NoteProperty _Info $info

    Apply-OxyStyle $series $Style $MyInvocation

    if ($AddTo -ne $null) {

      Add-OxyObjectToPlotModel $series $AddTo -NoRefresh

    }

    else {

      $series

    }

  }

  if ($AddTo -ne $null) {

    $AddTo.InvalidatePlot($true)

  }

}

}