SeriesInfo
Provides a ViewModel containing info about a series, such as name, value, color. SeriesInfo types are produced by the RolloverModifier, CursorModifier and LegendModifier. They are consumed by the UltrachartLegend and may be consumed by a custom ItemsControl binding to collection of SeriesInfo. See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information
Inherits: BindableObject
Implements: ICloneable
Constructors
public SeriesInfo(IRenderableSeries rSeries, HitTestInfo hitTestInfo)
seriesInfo = SeriesInfo(rSeries, hitTestInfo)
Initializes a new instance of the SeriesInfo class.
- rSeries
- The IRenderableSeries that this SeriesInfo represents.
- hitTestInfo
public SeriesInfo(IRenderableSeries rSeries)
seriesInfo = SeriesInfo(rSeries)
Initializes a new instance of the SeriesInfo class.
Properties
public int DataSeriesIndex { get; set; }
value = seriesInfo.DataSeriesIndex
seriesInfo.DataSeriesIndex = value
Gets or sets the DataSeriesIndex a the hit-test site
public DataSeriesType DataSeriesType { get; set; }
value = seriesInfo.DataSeriesType
seriesInfo.DataSeriesType = value
Gets or sets the type of the data series.
public string FormattedXValue { get; }
value = seriesInfo.FormattedXValue
Gets a formatted XValue.
public string FormattedYValue { get; }
value = seriesInfo.FormattedYValue
Gets a formatted YValue.
public bool IsHit { get; set; }
value = seriesInfo.IsHit
seriesInfo.IsHit = value
Get or sets whether the HitTest operation was a hit or not
public bool IsVisible { get; set; }
value = seriesInfo.IsVisible
seriesInfo.IsVisible = value
Gets or sets whether the IRenderableSeries that this SeriesInfo represents is visible or not. NOTE: Setting this value will show or hide the associated IRenderableSeries and may be data-bound to
public IRenderableSeries RenderableSeries { get; }
value = seriesInfo.RenderableSeries
Gets the IRenderableSeries instance which this SeriesInfo wraps
public Color SeriesColor { get; set; }
value = seriesInfo.SeriesColor
seriesInfo.SeriesColor = value
Gets or sets the color of the series.
public string SeriesName { get; set; }
value = seriesInfo.SeriesName
seriesInfo.SeriesName = value
Gets or sets the name of the series.
public double Value { get; set; }
value = seriesInfo.Value
seriesInfo.Value = value
Gets or sets the Y-value.
public IComparable XValue { get; set; }
value = seriesInfo.XValue
seriesInfo.XValue = value
Gets or sets the X-value.
public Point XyCoordinate { get; set; }
value = seriesInfo.XyCoordinate
seriesInfo.XyCoordinate = value
Gets or sets the xy coordinate in pixels of the data-point being inspected
public IComparable YValue { get; set; }
value = seriesInfo.YValue
seriesInfo.YValue = value
Gets or sets the Y-value.
Methods
public virtual object Clone()
result = seriesInfo.Clone()
Creates a new object that is a copy of the current instance.
Returns: A new object that is a copy of this instance.
protected string GetXCursorFormattedValue(IComparable value)
result = seriesInfo.GetXCursorFormattedValue(value)
Returns a value formatted using X axis format for cursors
- value
- The value to format
protected string GetYCursorFormattedValue(IComparable value)
result = seriesInfo.GetYCursorFormattedValue(value)
Returns a value formatted using Y axis format for cursors
- value
- The value to format