Class IgbSeries

Represents the base class for all IgbDataChart series.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbAnnotationLayer
IgbFinancialSeries
IgbGeographicMapSeriesHost
IgbHighDensityScatterSeries
IgbMarkerSeries
IgbScatterTriangulationSeries
IgbShapeSeriesBase
IgbUserAnnotationLayer
IgbValueOverlay
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbSeries : BaseRendererElement, JsonSerializable, IDisposable

Constructors

IgbSeries()

Declaration
public IgbSeries()

Properties

ActualAreaFillOpacity

Gets the actual opacity applied to the area fill visual.

Declaration
public double ActualAreaFillOpacity { get; set; }
Property Value
Type Description
System.Double

ActualBrush

Gets the effective brush for the current series object.

Declaration
public string ActualBrush { get; set; }
Property Value
Type Description
System.String

ActualFocusBrush

Gets the effective emphasis brush for the current series object.

Declaration
public string ActualFocusBrush { get; set; }
Property Value
Type Description
System.String

ActualFocusMode

Gets actual Selection mode

Declaration
public SeriesSelectionMode ActualFocusMode { get; set; }
Property Value
Type Description
SeriesSelectionMode

ActualHighlightedValuesFadeOpacity

Gets actual HighlightedValues fade opacity

Declaration
public double ActualHighlightedValuesFadeOpacity { get; set; }
Property Value
Type Description
System.Double

ActualHighlightingFadeOpacity

Gets actual highlighting fade opacity

Declaration
public double ActualHighlightingFadeOpacity { get; set; }
Property Value
Type Description
System.Double

ActualHighlightingMode

Gets actual highlighting mode

Declaration
public SeriesHighlightingMode ActualHighlightingMode { get; set; }
Property Value
Type Description
SeriesHighlightingMode

ActualHitTestMode

Resolved method of hit testing to use when pointing to items in the chart.

Declaration
public SeriesHitTestMode ActualHitTestMode { get; set; }
Property Value
Type Description
SeriesHitTestMode

ActualLayers

Gets the actual extra layers for the series.

Declaration
public IgbSeriesLayerCollection ActualLayers { get; protected set; }
Property Value
Type Description
IgbSeriesLayerCollection

ActualLegendItemBadgeBrush

Gets the effective legend badge fill for the current series.

Declaration
public string ActualLegendItemBadgeBrush { get; set; }
Property Value
Type Description
System.String

ActualLegendItemBadgeOutline

Gets the effective legend badge outline for the current series.

Declaration
public string ActualLegendItemBadgeOutline { get; set; }
Property Value
Type Description
System.String

ActualLegendItemBadgeTemplate

Gets the actual legend item badge template used by the series.

Declaration
public object ActualLegendItemBadgeTemplate { get; set; }
Property Value
Type Description
System.Object

ActualLegendItemBadgeTemplateScript

Provides a means of setting ActualLegendItemBadgeTemplate in the JavaScript environment.

Declaration
public string ActualLegendItemBadgeTemplateScript { get; set; }
Property Value
Type Description
System.String

ActualMarkerFillOpacity

Gets the actual opacity applied to the fill of the markers.

Declaration
public double ActualMarkerFillOpacity { get; set; }
Property Value
Type Description
System.Double

ActualOutline

Gets the effective outline for the current series object.

Declaration
public string ActualOutline { get; set; }
Property Value
Type Description
System.String

ActualResolution

Declaration
public double ActualResolution { get; set; }
Property Value
Type Description
System.Double

ActualSelectionBrush

Gets the effective emphasis brush for the current series object.

Declaration
public string ActualSelectionBrush { get; set; }
Property Value
Type Description
System.String

ActualSelectionMode

Gets actual Selection mode

Declaration
public SeriesSelectionMode ActualSelectionMode { get; set; }
Property Value
Type Description
SeriesSelectionMode

ActualThickness

Gets the effective Thickness for the current series object.

Declaration
public double ActualThickness { get; set; }
Property Value
Type Description
System.Double

AreaFillOpacity

Gets or sets the opacity applied to the area fill visual.

Declaration
public double AreaFillOpacity { get; set; }
Property Value
Type Description
System.Double
Remarks

This property only applies to series that have area visual.

AttachTooltipToRoot

Gets or sets whether the tooltip will be attached to the root, when set to false it will be a child of the chart.

Declaration
public bool AttachTooltipToRoot { get; set; }
Property Value
Type Description
System.Boolean

AutoCalloutLabelFormat

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

Declaration
public string AutoCalloutLabelFormat { get; set; }
Property Value
Type Description
System.String

AutoCalloutLabelFormatSpecifiers

Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string.

Declaration
public IgbFormatSpecifierCollection AutoCalloutLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

AutoCalloutValueLabelFormat

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

Declaration
public string AutoCalloutValueLabelFormat { get; set; }
Property Value
Type Description
System.String

AutoCalloutValueLabelFormatSpecifiers

Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string.

Declaration
public IgbFormatSpecifierCollection AutoCalloutValueLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

Brush

Gets or sets the brush to use for the series.

Declaration
public string Brush { get; set; }
Property Value
Type Description
System.String

CoercionMethods

Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

Declaration
public virtual object CoercionMethods { get; set; }
Property Value
Type Description
System.Object

CoercionMethodsScript

Provides a means of setting CoercionMethods in the JavaScript environment.

Declaration
public virtual string CoercionMethodsScript { get; set; }
Property Value
Type Description
System.String

DashArray

Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

Declaration
public double[] DashArray { get; set; }
Property Value
Type Description
System.Double[]

DataLegendGroup

Gets or sets a name used for grouping multiple series in the Data Legend

Declaration
public string DataLegendGroup { get; set; }
Property Value
Type Description
System.String
Remarks

If not set, series will be grouped by series family, e.g. Category, Range, Financial, Scatter

DataSource

Gets or sets the ItemsSource property for the current series object.

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

Declaration
public string DataSourceScript { get; set; }
Property Value
Type Description
System.String

DiscreteLegendItemTemplate

Gets or sets the DiscreteLegendItemTemplate property.

Declaration
public object DiscreteLegendItemTemplate { get; set; }
Property Value
Type Description
System.Object
Remarks

The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

DiscreteLegendItemTemplateScript

Provides a means of setting DiscreteLegendItemTemplate in the JavaScript environment.

Declaration
public string DiscreteLegendItemTemplateScript { get; set; }
Property Value
Type Description
System.String

ExpectFunctions

Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

Declaration
public virtual bool ExpectFunctions { get; set; }
Property Value
Type Description
System.Boolean

FinalValue

The final value of this series.

Declaration
public double FinalValue { get; set; }
Property Value
Type Description
System.Double

FocusBrush

Gets or sets the Focus brush to use for the series.

Declaration
public string FocusBrush { get; set; }
Property Value
Type Description
System.String

HighlightedDataSource

Gets or sets the data to highlight for the series.

Declaration
public object HighlightedDataSource { get; set; }
Property Value
Type Description
System.Object

HighlightedDataSourceScript

Provides a means of setting HighlightedDataSource in the JavaScript environment.

Declaration
public string HighlightedDataSourceScript { get; set; }
Property Value
Type Description
System.String

HighlightedLegendItemVisibility

Gets or sets whether the highlighted values layer should have a legend item.

Declaration
public Visibility HighlightedLegendItemVisibility { get; set; }
Property Value
Type Description
Visibility

HighlightedTitleSuffix

Gets or sets the HighlightedTitleSuffix property.

Declaration
public string HighlightedTitleSuffix { get; set; }
Property Value
Type Description
System.String

HighlightedValuesDataLegendGroup

Gets or sets a name used for grouping highlighted series in the Data Legend

Declaration
public string HighlightedValuesDataLegendGroup { get; set; }
Property Value
Type Description
System.String
Remarks

If not set, series will default to parent series' DataLegendGroup, e.g. Category, Range, Financial, Scatter

HighlightedValuesDisplayMode

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

Declaration
public SeriesHighlightedValuesDisplayMode HighlightedValuesDisplayMode { get; set; }
Property Value
Type Description
SeriesHighlightedValuesDisplayMode

HighlightedValuesExtraPropertyOverlays

Gets the current extra layers for the series.

Declaration
public IgbSeriesLayerPropertyOverlayCollection HighlightedValuesExtraPropertyOverlays { get; protected set; }
Property Value
Type Description
IgbSeriesLayerPropertyOverlayCollection

HighlightedValuesFadeOpacity

Gets or sets the target opacity to fade to for fade style HighlightedValues.

Declaration
public double HighlightedValuesFadeOpacity { get; set; }
Property Value
Type Description
System.Double

HighlightingFadeOpacity

Gets or sets the target opacity to fade to for fade style highlighting.

Declaration
public double HighlightingFadeOpacity { get; set; }
Property Value
Type Description
System.Double

HitTestMode

Method of hit testing to use when pointing to items in this series.

Declaration
public SeriesHitTestMode HitTestMode { get; set; }
Property Value
Type Description
SeriesHitTestMode

Index

Gets the Index property.

Declaration
public int Index { get; set; }
Property Value
Type Description
System.Int32

IsActualLegendFinancial

Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

Declaration
public bool IsActualLegendFinancial { get; set; }
Property Value
Type Description
System.Boolean

IsComponentHighlightingModeIgnored

Gets or sets whether the component level highlight mode is ignored.

Declaration
public bool IsComponentHighlightingModeIgnored { get; set; }
Property Value
Type Description
System.Boolean

IsDefaultToolTipSelected

Gets if the default tooltip has been selected for display.

Declaration
public bool IsDefaultToolTipSelected { get; set; }
Property Value
Type Description
System.Boolean

IsDropShadowEnabled

Gets or sets whether drop shadow should be enabled for this series.

Declaration
public bool IsDropShadowEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsHighlightingEnabled

Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

Declaration
public bool IsHighlightingEnabled { get; set; }
Property Value
Type Description
System.Boolean

Layers

Gets the current extra layers for the series.

Declaration
public IgbSeriesLayerCollection Layers { get; protected set; }
Property Value
Type Description
IgbSeriesLayerCollection

Legend

Gets or sets a legend for the current series object.

Declaration
public IgbLegendBase Legend { get; set; }
Property Value
Type Description
IgbLegendBase
Remarks

If the Legend property is not set, the series will use the setting according to the parent IgbDataChart's Legend property. This is generally expressed as an element name binding, as the Legend must exist at some other position in the layout. This property only indicates which Legend to use and will not alone cause the legend to be visible.

LegendItemBadgeMode

Gets or sets the mode of legend badge representing the current series in a legend.

Declaration
public LegendItemBadgeMode LegendItemBadgeMode { get; set; }
Property Value
Type Description
LegendItemBadgeMode
Remarks

This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

LegendItemBadgeShape

Gets or sets the type of legend badge representing the current series in a legend.

Declaration
public LegendItemBadgeShape LegendItemBadgeShape { get; set; }
Property Value
Type Description
LegendItemBadgeShape
Remarks

This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

LegendItemBadgeTemplate

Gets or sets the LegendItemBadgeTemplate property.

Declaration
public object LegendItemBadgeTemplate { get; set; }
Property Value
Type Description
System.Object
Remarks

The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

LegendItemBadgeTemplateScript

Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment.

Declaration
public string LegendItemBadgeTemplateScript { get; set; }
Property Value
Type Description
System.String

LegendItemTemplate

Gets or sets the LegendItemTemplate property.

Declaration
public object LegendItemTemplate { get; set; }
Property Value
Type Description
System.Object
Remarks

The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

LegendItemTemplateScript

Provides a means of setting LegendItemTemplate in the JavaScript environment.

Declaration
public string LegendItemTemplateScript { get; set; }
Property Value
Type Description
System.String

LegendItemVisibility

Gets or sets whether or not the current series will have a legend item displayed in a legend.

Declaration
public Visibility LegendItemVisibility { get; set; }
Property Value
Type Description
Visibility

LegendScript

Provides a means of setting Legend in the JavaScript environment.

Declaration
public string LegendScript { get; set; }
Property Value
Type Description
System.String

LineCap

Gets or sets the style of the starting point of any lines or polylines representing this series.

Declaration
public PenLineCap LineCap { get; set; }
Property Value
Type Description
PenLineCap
Remarks

Not every series type has a line at which it would be appropriate to display a start cap, so this property does not affect every series type. LineSeries, for example, is affected by StartCap, but ColumnSeries is not.

LineJoin

Gets or sets the brush that specifies current series object's line join style.

Declaration
public PenLineJoin LineJoin { get; set; }
Property Value
Type Description
PenLineJoin

MarkerFillOpacity

Gets or sets the opacity applied to the fill of the markers.

Declaration
public double MarkerFillOpacity { get; set; }
Property Value
Type Description
System.Double
Remarks

This property only applies to series that have area visual.

MouseOverEnabled

Gets or sets the whether the chart reacts to mouse move events.

Declaration
public bool MouseOverEnabled { get; set; }
Property Value
Type Description
System.Boolean

Opacity

Declaration
public double Opacity { get; set; }
Property Value
Type Description
System.Double

Outline

Gets or sets the brush to use for the outline of the series.

Declaration
public string Outline { get; set; }
Property Value
Type Description
System.String
Remarks

Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

OutlineMode

Gets or sets the outline mode to use for the series.

Declaration
public SeriesOutlineMode OutlineMode { get; set; }
Property Value
Type Description
SeriesOutlineMode

PercentChange

The percent change from the beginning to the end of this series.

Declaration
public double PercentChange { get; set; }
Property Value
Type Description
System.Double

RenderRequested

Declaration
public Action<IgbRenderRequestedEventArgs> RenderRequested { get; set; }
Property Value
Type Description
System.Action<IgbRenderRequestedEventArgs>

RenderRequestedScript

Declaration
public string RenderRequestedScript { get; set; }
Property Value
Type Description
System.String

Resolution

Gets or sets the current series object's rendering resolution.

Declaration
public double Resolution { get; set; }
Property Value
Type Description
System.Double

SafeActualBrush

Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

Declaration
public string SafeActualBrush { get; set; }
Property Value
Type Description
System.String

SelectionBrush

Gets or sets the selection brush to use for the series.

Declaration
public string SelectionBrush { get; set; }
Property Value
Type Description
System.String

SelectionThickness

Gets or sets the width of the current series object's line thickness when the series is selected.

Declaration
public double SelectionThickness { get; set; }
Property Value
Type Description
System.Double

SeriesViewerParent

Declaration
protected BaseRendererControl SeriesViewerParent { get; set; }
Property Value
Type Description
BaseRendererControl

ShadowBlur

Gets or sets the shadow blur.

Declaration
public double ShadowBlur { get; set; }
Property Value
Type Description
System.Double
Remarks

This property is ignored when Series.UseSingleShadow is set to true.

ShadowColor

Gets or sets the drop shadow color.

Declaration
public string ShadowColor { get; set; }
Property Value
Type Description
System.String

ShadowOffsetX

Gets or sets the drop shadow x-offset.

Declaration
public double ShadowOffsetX { get; set; }
Property Value
Type Description
System.Double

ShadowOffsetY

Gets or sets the drop shadow y-offset.

Declaration
public double ShadowOffsetY { get; set; }
Property Value
Type Description
System.Double

ShouldAnimateOnDataSourceSwap

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

Declaration
public bool ShouldAnimateOnDataSourceSwap { get; set; }
Property Value
Type Description
System.Boolean

ShouldHideAutoCallouts

Gets or sets whether this series should suppress it's auto callouts

Declaration
public bool ShouldHideAutoCallouts { get; set; }
Property Value
Type Description
System.Boolean

ShouldRemoveHighlightedDataOnLayerHidden

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

Declaration
public bool ShouldRemoveHighlightedDataOnLayerHidden { get; set; }
Property Value
Type Description
System.Boolean

ShouldShiftOpacityForSafeActualBrush

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

Declaration
public bool ShouldShiftOpacityForSafeActualBrush { get; set; }
Property Value
Type Description
System.Boolean

ShowDefaultTooltip

Gets or sets whether default tooltip will be shown.

Declaration
public bool ShowDefaultTooltip { get; set; }
Property Value
Type Description
System.Boolean

Thickness

Gets or sets the width of the current series object's line thickness.

Declaration
public double Thickness { get; set; }
Property Value
Type Description
System.Double

Title

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

TooltipTemplate

Declaration
public RenderFragment<IgbDataContext> TooltipTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbDataContext>

TransitionDuration

Gets or sets the duration of the current series' morph.

Declaration
public int TransitionDuration { get; set; }
Property Value
Type Description
System.Int32

TransitionEasingFunction

Gets or sets the easing function used to morph the current series.

Declaration
public string TransitionEasingFunction { get; set; }
Property Value
Type Description
System.String

TransitionEasingFunctionScript

Provides a means of setting TransitionEasingFunction in the JavaScript environment.

Declaration
public string TransitionEasingFunctionScript { get; set; }
Property Value
Type Description
System.String

TransitionInDuration

Gets or sets the duration of the current series' transition in morph.

Declaration
public int TransitionInDuration { get; set; }
Property Value
Type Description
System.Int32

TransitionInEasingFunction

Gets or sets the EasingFunction used to morph the current series during the initial transition.

Declaration
public string TransitionInEasingFunction { get; set; }
Property Value
Type Description
System.String

TransitionInEasingFunctionScript

Provides a means of setting TransitionInEasingFunction in the JavaScript environment.

Declaration
public string TransitionInEasingFunctionScript { get; set; }
Property Value
Type Description
System.String

TransitionInSpeedType

Gets or sets the duration of the current series' transition in morph.

Declaration
public TransitionInSpeedType TransitionInSpeedType { get; set; }
Property Value
Type Description
TransitionInSpeedType

TransitionOutCompleted

Declaration
public EventCallback<IgbTransitionOutCompletedEventArgs> TransitionOutCompleted { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbTransitionOutCompletedEventArgs>

TransitionOutCompletedScript

Declaration
public string TransitionOutCompletedScript { get; set; }
Property Value
Type Description
System.String

TransitionOutDuration

Gets or sets the duration of the current series' transition out morph.

Declaration
public int TransitionOutDuration { get; set; }
Property Value
Type Description
System.Int32

TransitionOutEasingFunction

Gets or sets the EasingFunction used to morph the current series during the initial transition.

Declaration
public string TransitionOutEasingFunction { get; set; }
Property Value
Type Description
System.String

TransitionOutEasingFunctionScript

Provides a means of setting TransitionOutEasingFunction in the JavaScript environment.

Declaration
public string TransitionOutEasingFunctionScript { get; set; }
Property Value
Type Description
System.String

TransitionOutSpeedType

Gets or sets the duration of the current series' transition out morph.

Declaration
public TransitionOutSpeedType TransitionOutSpeedType { get; set; }
Property Value
Type Description
TransitionOutSpeedType

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseItemWiseColors

Gets or sets whether the series should use individual palette colors for each item.

Declaration
public bool UseItemWiseColors { get; set; }
Property Value
Type Description
System.Boolean

UseSingleShadow

Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series.

Declaration
public bool UseSingleShadow { get; set; }
Property Value
Type Description
System.Boolean
Remarks

When this property is set to true, no Series.ShadowBlur is applied.

Visibility

Declaration
public Visibility Visibility { get; set; }
Property Value
Type Description
Visibility

VisibleRangeMarginBottom

Gets or sets the bottom margin to use when getting a visible axis range for the series.

Declaration
public double VisibleRangeMarginBottom { get; set; }
Property Value
Type Description
System.Double

VisibleRangeMarginLeft

Gets or sets the left margin to use when getting a visible axis range for the series.

Declaration
public double VisibleRangeMarginLeft { get; set; }
Property Value
Type Description
System.Double

VisibleRangeMarginRight

Gets or sets the right margin to use when getting a visible axis range for the series.

Declaration
public double VisibleRangeMarginRight { get; set; }
Property Value
Type Description
System.Double

VisibleRangeMarginTop

Gets or sets the top margin to use when getting a visible axis range for the series.

Declaration
public double VisibleRangeMarginTop { get; set; }
Property Value
Type Description
System.Double

VisibleRangeMode

Gets or sets the visible range mode to use.

Declaration
public SeriesVisibleRangeMode VisibleRangeMode { get; set; }
Property Value
Type Description
SeriesVisibleRangeMode

Methods

BindAxes(IgbAxis[])

Declaration
protected virtual void BindAxes(IgbAxis[] Axes)
Parameters
Type Name Description
IgbAxis[] Axes

BindSeries(IgbSeries[])

Declaration
protected virtual void BindSeries(IgbSeries[] Series)
Parameters
Type Name Description
IgbSeries[] Series

Dispose()

Declaration
public void Dispose()

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FromWorldPosition(Point)

Declaration
public Point FromWorldPosition(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
Point

FromWorldPositionAsync(Point)

Converts a point from world coordinates to coordinates within the viewport of the series.

Declaration
public Task<Point> FromWorldPositionAsync(Point world)
Parameters
Type Name Description
Point world

The world position from which to convert.
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetEffectiveViewport()

Declaration
public virtual Rect GetEffectiveViewport()
Returns
Type Description
Rect

GetEffectiveViewportAsync()

Gets the effective viewport, adjusted to account for margins and other factors.

Declaration
public virtual Task<Rect> GetEffectiveViewportAsync()
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetExactItemIndex(Point)

Declaration
public virtual double GetExactItemIndex(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Double

GetExactItemIndexAsync(Point)

Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

Declaration
public virtual Task<double> GetExactItemIndexAsync(Point world)
Parameters
Type Name Description
Point world

The world position for which to return the index.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetItem(Point)

Declaration
public virtual object GetItem(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Object

GetItemAsync(Point)

Gets the item that is the best match for the specified world coordinates.

Declaration
public virtual Task<object> GetItemAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinates to use.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

GetItemIndex(Point)

Declaration
public virtual int GetItemIndex(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Int32

GetItemIndexAsync(Point)

Gets the item index associated with the specified world position

Declaration
public virtual Task<int> GetItemIndexAsync(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetItemSpan()

Declaration
public virtual double GetItemSpan()
Returns
Type Description
System.Double

GetItemSpanAsync()

For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

Declaration
public virtual Task<double> GetItemSpanAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetItemValue(Object, String)

Declaration
public virtual object GetItemValue(object item, string memberPathName)
Parameters
Type Name Description
System.Object item
System.String memberPathName
Returns
Type Description
System.Object

GetItemValueAsync(Object, String)

Declaration
public virtual Task<object> GetItemValueAsync(object item, string memberPathName)
Parameters
Type Name Description
System.Object item
System.String memberPathName
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

GetMainContentViewport()

Declaration
public Rect GetMainContentViewport()
Returns
Type Description
Rect

GetMainContentViewportAsync()

Declaration
public Task<Rect> GetMainContentViewportAsync()
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetMemberPathValue(String)

Declaration
public virtual string GetMemberPathValue(string memberPathName)
Parameters
Type Name Description
System.String memberPathName
Returns
Type Description
System.String

GetMemberPathValueAsync(String)

Gets the value of a requested member path from the series.

Declaration
public virtual Task<string> GetMemberPathValueAsync(string memberPathName)
Parameters
Type Name Description
System.String memberPathName

The property name of a valid member path for the series
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetNextOrExactIndex(Point, Boolean)

Declaration
public virtual int GetNextOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32

GetNextOrExactIndexAsync(Point, Boolean)

Declaration
public virtual Task<int> GetNextOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetPreviousOrExactIndex(Point, Boolean)

Declaration
public virtual int GetPreviousOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32

GetPreviousOrExactIndexAsync(Point, Boolean)

Declaration
public virtual Task<int> GetPreviousOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetSeriesHighValue(Point, Boolean, Boolean)

Declaration
public virtual double GetSeriesHighValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double

GetSeriesHighValueAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<double> GetSeriesHighValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetSeriesHighValuePosition(Point, Boolean, Boolean)

Declaration
public virtual Point GetSeriesHighValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point

GetSeriesHighValuePositionAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<Point> GetSeriesHighValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetSeriesLowValue(Point, Boolean, Boolean)

Declaration
public virtual double GetSeriesLowValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double

GetSeriesLowValueAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<double> GetSeriesLowValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetSeriesLowValuePosition(Point, Boolean, Boolean)

Declaration
public virtual Point GetSeriesLowValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point

GetSeriesLowValuePositionAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<Point> GetSeriesLowValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetSeriesValue(Point, Boolean, Boolean)

Declaration
public virtual double GetSeriesValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double

GetSeriesValueAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<double> GetSeriesValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetSeriesValueBoundingBox(Point)

Declaration
public virtual Rect GetSeriesValueBoundingBox(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
Rect

GetSeriesValueBoundingBoxAsync(Point)

If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

Declaration
public virtual Task<Rect> GetSeriesValueBoundingBoxAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinate for which to get a value bounding box for
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetSeriesValueFromSeriesPixel(Point, Boolean, Boolean)

Declaration
public virtual double GetSeriesValueFromSeriesPixel(Point mouse, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point mouse
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double

GetSeriesValueFromSeriesPixelAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<double> GetSeriesValueFromSeriesPixelAsync(Point mouse, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point mouse
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetSeriesValueMarkerBoundingBox(Point)

Declaration
public virtual Rect GetSeriesValueMarkerBoundingBox(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
Rect

GetSeriesValueMarkerBoundingBoxAsync(Point)

If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.

Declaration
public virtual Task<Rect> GetSeriesValueMarkerBoundingBoxAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinates for which to get a value marker bounding box for
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetSeriesValuePosition(Point, Boolean, Boolean)

Declaration
public virtual Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point

GetSeriesValuePositionAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetSeriesValuePositionFromSeriesPixel(Point, Boolean, Boolean)

Declaration
public virtual Point GetSeriesValuePositionFromSeriesPixel(Point mouse, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point mouse
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point

GetSeriesValuePositionFromSeriesPixelAsync(Point, Boolean, Boolean)

Declaration
public virtual Task<Point> GetSeriesValuePositionFromSeriesPixelAsync(Point mouse, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point mouse
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetSeriesValueType(ValueLayerValueMode)

Declaration
public virtual double[] GetSeriesValueType(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
System.Double[]

GetSeriesValueTypeAsync(ValueLayerValueMode)

Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN.

Declaration
public virtual Task<double[]> GetSeriesValueTypeAsync(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode

The type of value desired from the series axes.
Returns
Type Description
System.Threading.Tasks.Task<System.Double[]>

GetSeriesValueTypePosition(ValueLayerValueMode)

Declaration
public virtual Point GetSeriesValueTypePosition(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
Point

GetSeriesValueTypePositionAsync(ValueLayerValueMode)

Gets position of series value for specified layer value mode

Declaration
public virtual Task<Point> GetSeriesValueTypePositionAsync(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetUnscaledPosition(Point)

Declaration
public virtual Point GetUnscaledPosition(Point pos)
Parameters
Type Name Description
Point pos
Returns
Type Description
Point

GetUnscaledPositionAsync(Point)

Gets an unscaled position in terms of axis values from a viewport position.

Declaration
public virtual Task<Point> GetUnscaledPositionAsync(Point pos)
Parameters
Type Name Description
Point pos

The viewport relative position
Returns
Type Description
System.Threading.Tasks.Task<Point>

HideToolTips()

Declaration
public virtual void HideToolTips()

HideToolTipsAsync()

Hides any internal tooltips presented by the series, if any.

Declaration
public virtual Task HideToolTipsAsync()
Returns
Type Description
System.Threading.Tasks.Task

HideToolTipsImmediate()

Declaration
public virtual void HideToolTipsImmediate()

HideToolTipsImmediateAsync()

Hides any internal tooltips presented by the series, if any.

Declaration
public virtual Task HideToolTipsImmediateAsync()
Returns
Type Description
System.Threading.Tasks.Task

MoveCursorPoint(Point)

Declaration
public void MoveCursorPoint(Point point)
Parameters
Type Name Description
Point point

MoveCursorPointAsync(Point)

Moves the cursor point to the provided world position. Some series may react to the current cursor position.

Declaration
public Task MoveCursorPointAsync(Point point)
Parameters
Type Name Description
Point point

The cursor point, in world coordinates.
Returns
Type Description
System.Threading.Tasks.Task

NotifyIndexedPropertiesChanged()

Declaration
public virtual void NotifyIndexedPropertiesChanged()

NotifyIndexedPropertiesChangedAsync()

Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

Declaration
public virtual Task NotifyIndexedPropertiesChangedAsync()
Returns
Type Description
System.Threading.Tasks.Task

NotifyVisualPropertiesChanged()

Declaration
public void NotifyVisualPropertiesChanged()

NotifyVisualPropertiesChangedAsync()

Notifies the series that a visual property has changed, requiring a visual update.

Declaration
public Task NotifyVisualPropertiesChangedAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

PlayTransitionIn()

Declaration
public virtual void PlayTransitionIn()

PlayTransitionInAsync()

Plays the assigned transition out animation, if any.

Declaration
public virtual Task PlayTransitionInAsync()
Returns
Type Description
System.Threading.Tasks.Task

PlayTransitionOut()

Declaration
public virtual void PlayTransitionOut()

PlayTransitionOutAndRemove()

Declaration
public virtual void PlayTransitionOutAndRemove()

PlayTransitionOutAndRemoveAsync()

Plays the assigned transition out animation, if any.

Declaration
public virtual Task PlayTransitionOutAndRemoveAsync()
Returns
Type Description
System.Threading.Tasks.Task

PlayTransitionOutAsync()

Plays the assigned transition out animation, if any.

Declaration
public virtual Task PlayTransitionOutAsync()
Returns
Type Description
System.Threading.Tasks.Task

RemoveAllAlternateViews()

Declaration
public virtual void RemoveAllAlternateViews()

RemoveAllAlternateViewsAsync()

Removes all alternate views of this series.

Declaration
public virtual Task RemoveAllAlternateViewsAsync()
Returns
Type Description
System.Threading.Tasks.Task

RemoveAlternateView(String)

Declaration
public virtual void RemoveAlternateView(string viewIdentifier)
Parameters
Type Name Description
System.String viewIdentifier

RemoveAlternateViewAsync(String)

Removes an alternate view of this series.

Declaration
public virtual Task RemoveAlternateViewAsync(string viewIdentifier)
Parameters
Type Name Description
System.String viewIdentifier

The string identifier for the view to remove.
Returns
Type Description
System.Threading.Tasks.Task

RemoveAxes()

Declaration
public void RemoveAxes()

RemoveAxesAsync()

Call to null out the axes of the series;

Declaration
public Task RemoveAxesAsync()
Returns
Type Description
System.Threading.Tasks.Task

RenderSeries(Boolean)

Declaration
public virtual void RenderSeries(bool animate)
Parameters
Type Name Description
System.Boolean animate

RenderSeriesAsync(Boolean)

Renders the series.

Declaration
public virtual Task RenderSeriesAsync(bool animate)
Parameters
Type Name Description
System.Boolean animate

True if the change should be animated.
Returns
Type Description
System.Threading.Tasks.Task

ReplayTransitionIn()

Declaration
public virtual void ReplayTransitionIn()

ReplayTransitionInAsync()

Replays the assigned transition in animation, if any.

Declaration
public virtual Task ReplayTransitionInAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveTooltipBrush()

Declaration
public string ResolveTooltipBrush()
Returns
Type Description
System.String

ResolveTooltipBrushAsync()

Gets the brush for tooltip labels.

Declaration
public Task<string> ResolveTooltipBrushAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ScrollIntoView(Object)

Declaration
public virtual bool ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Boolean

ScrollIntoViewAsync(Object)

Requests that the provided item should be brought into view if possible.

Declaration
public virtual Task<bool> ScrollIntoViewAsync(object item)
Parameters
Type Name Description
System.Object item

The item to attempt to bring into view.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

SetNegativeColors(String, String)

Declaration
public virtual void SetNegativeColors(string negativeBrush, string negativeOutline)
Parameters
Type Name Description
System.String negativeBrush
System.String negativeOutline

SetNegativeColorsAsync(String, String)

Declaration
public virtual Task SetNegativeColorsAsync(string negativeBrush, string negativeOutline)
Parameters
Type Name Description
System.String negativeBrush
System.String negativeOutline
Returns
Type Description
System.Threading.Tasks.Task

SimulateHover(Point)

Declaration
public virtual void SimulateHover(Point point)
Parameters
Type Name Description
Point point

SimulateHoverAsync(Point)

Simulates a pointer hover over the series surface.

Declaration
public virtual Task SimulateHoverAsync(Point point)
Parameters
Type Name Description
Point point

The pointer position relative to the series viewport over which to hover.
Returns
Type Description
System.Threading.Tasks.Task

StyleUpdated()

Declaration
public virtual void StyleUpdated()

StyleUpdatedAsync()

Called when this series' Style is updated.

Declaration
public virtual Task StyleUpdatedAsync()
Returns
Type Description
System.Threading.Tasks.Task

ToWorldPosition(Point)

Declaration
public Point ToWorldPosition(Point seriesPoint)
Parameters
Type Name Description
Point seriesPoint
Returns
Type Description
Point

ToWorldPositionAsync(Point)

Converts a point from coordinates within the series plot area to a world position within axis space.

Declaration
public Task<Point> ToWorldPositionAsync(Point seriesPoint)
Parameters
Type Name Description
Point seriesPoint

The pixel location within the plot area of the series.
Returns
Type Description
System.Threading.Tasks.Task<Point>

ToWorldRect(Rect)

Declaration
public Rect ToWorldRect(Rect rect)
Parameters
Type Name Description
Rect rect
Returns
Type Description
Rect

ToWorldRectAsync(Rect)

Converts a rect from coordinates within the series plot area to a world position within axis space.

Declaration
public Task<Rect> ToWorldRectAsync(Rect rect)
Parameters
Type Name Description
Rect rect

The pixel rect within the plot area of the series.
Returns
Type Description
System.Threading.Tasks.Task<Rect>

Implements

System.IDisposable