< Back

New-OxyLineAnnotation

Sat Jan 18, 2020 6:20 pm

NAME New-OxyLineAnnotation



SYNOPSIS

Returns an object that represents an annotation that shows a straight line.





SYNTAX

New-OxyLineAnnotation [-AddTo <OxyPlot.PlotModel>] [-ClipByXAxis <Horker.OxyPlotCli.TypeAdaptors.Bool>]

[-ClipByYAxis <Horker.OxyPlotCli.TypeAdaptors.Bool>] [-ClipText <Horker.OxyPlotCli.TypeAdaptors.Bool>] [-Color

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

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-FontWeight <Horker.OxyPlotCli.TypeAdaptors.Double>] [-Intercept

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-Layer <OxyPlot.Annotations.AnnotationLayer>] [-LineJoin

<OxyPlot.LineJoin>] [-LineStyle <OxyPlot.LineStyle>] [-MaximumX <Horker.OxyPlotCli.TypeAdaptors.Double>]

[-MaximumY <Horker.OxyPlotCli.TypeAdaptors.Double>] [-MinimumX <Horker.OxyPlotCli.TypeAdaptors.Double>] [-MinimumY

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-PassThru] [-Selectable <Horker.OxyPlotCli.TypeAdaptors.Bool>]

[-SelectionMode <OxyPlot.SelectionMode>] [-Slope <Horker.OxyPlotCli.TypeAdaptors.Double>] [-StrokeThickness

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

[-TextColor <Horker.OxyPlotCli.TypeAdaptors.OxyColor>] [-TextHorizontalAlignment <OxyPlot.HorizontalAlignment>]

[-TextLinePosition <Horker.OxyPlotCli.TypeAdaptors.Double>] [-TextMargin <Horker.OxyPlotCli.TypeAdaptors.Double>]

[-TextOrientation <OxyPlot.Annotations.AnnotationTextOrientation>] [-TextPadding

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-TextPosition <Horker.OxyPlotCli.TypeAdaptors.Double[]>] [-TextRotation

<Horker.OxyPlotCli.TypeAdaptors.Double>] [-TextVerticalAlignment <OxyPlot.VerticalAlignment>] [-ToolTip

<System.String>] [-Type <OxyPlot.Annotations.LineAnnotationType>] [-X <Horker.OxyPlotCli.TypeAdaptors.Double>]

[-XAxisKey <System.String>] [-Y <Horker.OxyPlotCli.TypeAdaptors.Double>] [-YAxisKey <System.String>]

[<CommonParameters>]





DESCRIPTION

Returns an object that represents an annotation that shows a straight line.





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



-ClipByXAxis <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether to clip the annotation line by the X axis range.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ClipByYAxis <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether to clip the annotation line by the Y axis range.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ClipText <Horker.OxyPlotCli.TypeAdaptors.Bool>

Sets a value indicating whether to clip the text within the plot area.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Color <Horker.OxyPlotCli.TypeAdaptors.OxyColor>

Sets the color of the line.



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



-Intercept <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the y-intercept when Type is LinearEquation.



Linear equation y-intercept (the b in y=mx+b). http://en.wikipedia.org/wiki/Linear_equation



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Layer <OxyPlot.Annotations.AnnotationLayer>

Sets the rendering layer of the annotation. The default value is

OxyPlot.Annotations.AnnotationLayer.AboveSeries.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LineJoin <OxyPlot.LineJoin>

Sets the line join.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LineStyle <OxyPlot.LineStyle>

Sets the line style.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MaximumX <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the maximum X coordinate for the line.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MaximumY <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the maximum Y coordinate for the line.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MinimumX <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the minimum X coordinate for the line.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MinimumY <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the minimum Y coordinate for the line.



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



-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



-Slope <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the slope when Type is LinearEquation.



Linear equation slope (the m in y=mx+b) http://en.wikipedia.org/wiki/Linear_equation



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



-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



-Text <System.String>

Sets the annotation text.



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



-TextHorizontalAlignment <OxyPlot.HorizontalAlignment>

Sets the horizontal alignment of the text.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextLinePosition <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the text position relative to the line.



Positions smaller than 0.25 are left aligned at the start of the line Positions larger than 0.75 are right

aligned at the end of the line Other positions are center aligned at the specified position



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextMargin <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the text margin (along the line).



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextOrientation <OxyPlot.Annotations.AnnotationTextOrientation>

Sets the text orientation.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextPadding <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the text padding (in the direction of the text).



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



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

Sets the position of the text.



If the value is DataPoint.Undefined, the default position of the text will be used.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextRotation <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the rotation of the text.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TextVerticalAlignment <OxyPlot.VerticalAlignment>

Sets the vertical alignment of the text.



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



-Type <OxyPlot.Annotations.LineAnnotationType>

Sets the type of line equation.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-X <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the X position for vertical lines (only for Type==Vertical).



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-XAxisKey <System.String>

Sets the X axis key.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Y <Horker.OxyPlotCli.TypeAdaptors.Double>

Sets the Y position for horizontal lines (only for Type==Horizontal)



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-YAxisKey <System.String>

Sets the Y axis key.



Required? false

Position? named

Default value None

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

None







OUTPUTS

OxyPlot.Annotations.LineAnnotation







NOTES











RELATED LINKS

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