Represents the base class for all IgbDataChart series.
Inheritance
object
ComponentBase
Classes that extend this class.
Derived Classes- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbSeries() Returns IgbSeries
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; } IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; } ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; } UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; } ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; } SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; } Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; } Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; } MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; } CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; } ActualAreaFillOpacity
Section titled "ActualAreaFillOpacity"Gets the actual opacity applied to the area fill visual.
[Parameter]
public double ActualAreaFillOpacity { get; set; } ActualBrush
Section titled "ActualBrush"Gets the effective brush for the current series object.
[Parameter]
public string ActualBrush { get; set; } ActualFocusBrush
Section titled "ActualFocusBrush"Gets the effective emphasis brush for the current series object.
[Parameter]
public string ActualFocusBrush { get; set; } ActualFocusMode
Section titled "ActualFocusMode"Gets actual Selection mode
[Parameter]
public SeriesSelectionMode ActualFocusMode { get; set; } ActualHighlightedValuesFadeOpacity
Section titled "ActualHighlightedValuesFadeOpacity"Gets actual HighlightedValues fade opacity
[Parameter]
public double ActualHighlightedValuesFadeOpacity { get; set; } ActualHighlightingFadeOpacity
Section titled "ActualHighlightingFadeOpacity"Gets actual highlighting fade opacity
[Parameter]
public double ActualHighlightingFadeOpacity { get; set; } ActualHighlightingMode
Section titled "ActualHighlightingMode"Gets actual highlighting mode
[Parameter]
public SeriesHighlightingMode ActualHighlightingMode { get; set; } ActualHitTestMode
Section titled "ActualHitTestMode"Resolved method of hit testing to use when pointing to items in the chart.
[Parameter]
public SeriesHitTestMode ActualHitTestMode { get; set; } ActualLayers
Section titled "ActualLayers"Gets the actual extra layers for the series.
public IgbSeriesLayerCollection ActualLayers { get; protected set; } ActualLegendItemBadgeBrush
Section titled "ActualLegendItemBadgeBrush"Gets the effective legend badge fill for the current series.
[Parameter]
public string ActualLegendItemBadgeBrush { get; set; } ActualLegendItemBadgeOutline
Section titled "ActualLegendItemBadgeOutline"Gets the effective legend badge outline for the current series.
[Parameter]
public string ActualLegendItemBadgeOutline { get; set; } ActualLegendItemBadgeTemplate
Section titled "ActualLegendItemBadgeTemplate"Gets the actual legend item badge template used by the series.
[Parameter]
public object ActualLegendItemBadgeTemplate { get; set; } ActualLegendItemBadgeTemplateScript
Section titled "ActualLegendItemBadgeTemplateScript"Provides a means of setting ActualLegendItemBadgeTemplate in the JavaScript environment.
[Parameter]
public string ActualLegendItemBadgeTemplateScript { get; set; } ActualMarkerFillOpacity
Section titled "ActualMarkerFillOpacity"Gets the actual opacity applied to the fill of the markers.
[Parameter]
public double ActualMarkerFillOpacity { get; set; } ActualOutline
Section titled "ActualOutline"Gets the effective outline for the current series object.
[Parameter]
public string ActualOutline { get; set; } ActualResolution
Section titled "ActualResolution"[Parameter]
public double ActualResolution { get; set; } ActualSelectionBrush
Section titled "ActualSelectionBrush"Gets the effective emphasis brush for the current series object.
[Parameter]
public string ActualSelectionBrush { get; set; } ActualSelectionMode
Section titled "ActualSelectionMode"Gets actual Selection mode
[Parameter]
public SeriesSelectionMode ActualSelectionMode { get; set; } ActualThickness
Section titled "ActualThickness"Gets the effective Thickness for the current series object.
[Parameter]
public double ActualThickness { get; set; } AreaFillOpacity
Section titled "AreaFillOpacity"Gets or sets the opacity applied to the area fill visual.
[Parameter]
public double AreaFillOpacity { get; set; } AttachTooltipToRoot
Section titled "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.
[Parameter]
public bool AttachTooltipToRoot { get; set; } AutoCalloutLabelFormat
Section titled "AutoCalloutLabelFormat"Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.
[Parameter]
public string AutoCalloutLabelFormat { get; set; } AutoCalloutLabelFormatSpecifiers
Section titled "AutoCalloutLabelFormatSpecifiers"Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string.
public IgbFormatSpecifierCollection AutoCalloutLabelFormatSpecifiers { get; set; } AutoCalloutValueLabelFormat
Section titled "AutoCalloutValueLabelFormat"Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.
[Parameter]
public string AutoCalloutValueLabelFormat { get; set; } AutoCalloutValueLabelFormatSpecifiers
Section titled "AutoCalloutValueLabelFormatSpecifiers"Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string.
public IgbFormatSpecifierCollection AutoCalloutValueLabelFormatSpecifiers { get; set; } Brush
Section titled "Brush"Gets or sets the brush to use for the series.
[Parameter]
public string Brush { get; set; } CoercionMethods
Section titled "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.
[Parameter]
public virtual object CoercionMethods { get; set; } CoercionMethodsScript
Section titled "CoercionMethodsScript"Provides a means of setting CoercionMethods in the JavaScript environment.
[Parameter]
public virtual string CoercionMethodsScript { get; set; } DashArray
Section titled "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.
[Parameter]
public double[] DashArray { get; set; } DataLegendGroup
Section titled "DataLegendGroup"Gets or sets a name used for grouping multiple series in the Data Legend
[Parameter]
public string DataLegendGroup { get; set; } DataSource
Section titled "DataSource"Gets or sets the ItemsSource property for the current series object.
[Parameter]
public object DataSource { get; set; } DataSourceScript
Section titled "DataSourceScript"Provides a means of setting DataSource in the JavaScript environment.
[Parameter]
public string DataSourceScript { get; set; } DiscreteLegendItemTemplate
Section titled "DiscreteLegendItemTemplate"Gets or sets the DiscreteLegendItemTemplate property.
[Parameter]
public object DiscreteLegendItemTemplate { get; set; } DiscreteLegendItemTemplateScript
Section titled "DiscreteLegendItemTemplateScript"Provides a means of setting DiscreteLegendItemTemplate in the JavaScript environment.
[Parameter]
public string DiscreteLegendItemTemplateScript { get; set; } ExpectFunctions
Section titled "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.
[Parameter]
public virtual bool ExpectFunctions { get; set; } FinalValue
Section titled "FinalValue"The final value of this series.
[Parameter]
public double FinalValue { get; set; } FocusBrush
Section titled "FocusBrush"Gets or sets the Focus brush to use for the series.
[Parameter]
public string FocusBrush { get; set; } HighlightedDataSource
Section titled "HighlightedDataSource"Gets or sets the data to highlight for the series.
[Parameter]
public object HighlightedDataSource { get; set; } HighlightedDataSourceScript
Section titled "HighlightedDataSourceScript"Provides a means of setting HighlightedDataSource in the JavaScript environment.
[Parameter]
public string HighlightedDataSourceScript { get; set; } HighlightedLegendItemVisibility
Section titled "HighlightedLegendItemVisibility"Gets or sets whether the highlighted values layer should have a legend item.
[Parameter]
public Visibility HighlightedLegendItemVisibility { get; set; } HighlightedTitleSuffix
Section titled "HighlightedTitleSuffix"Gets or sets the HighlightedTitleSuffix property.
[Parameter]
public string HighlightedTitleSuffix { get; set; } HighlightedValuesDataLegendGroup
Section titled "HighlightedValuesDataLegendGroup"Gets or sets a name used for grouping highlighted series in the Data Legend
[Parameter]
public string HighlightedValuesDataLegendGroup { get; set; } HighlightedValuesDisplayMode
Section titled "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.
[Parameter]
public SeriesHighlightedValuesDisplayMode HighlightedValuesDisplayMode { get; set; } HighlightedValuesExtraPropertyOverlays
Section titled "HighlightedValuesExtraPropertyOverlays"Gets the current extra layers for the series.
public IgbSeriesLayerPropertyOverlayCollection HighlightedValuesExtraPropertyOverlays { get; protected set; } HighlightedValuesFadeOpacity
Section titled "HighlightedValuesFadeOpacity"Gets or sets the target opacity to fade to for fade style HighlightedValues.
[Parameter]
public double HighlightedValuesFadeOpacity { get; set; } HighlightingFadeOpacity
Section titled "HighlightingFadeOpacity"Gets or sets the target opacity to fade to for fade style highlighting.
[Parameter]
public double HighlightingFadeOpacity { get; set; } HitTestMode
Section titled "HitTestMode"Method of hit testing to use when pointing to items in this series.
[Parameter]
public SeriesHitTestMode HitTestMode { get; set; } Index
Section titled "Index"Gets the Index property.
[Parameter]
public int Index { get; set; } IsActualLegendFinancial
Section titled "IsActualLegendFinancial"Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.
[Parameter]
public bool IsActualLegendFinancial { get; set; } IsComponentHighlightingModeIgnored
Section titled "IsComponentHighlightingModeIgnored"Gets or sets whether the component level highlight mode is ignored.
[Parameter]
public bool IsComponentHighlightingModeIgnored { get; set; } IsDefaultToolTipSelected
Section titled "IsDefaultToolTipSelected"Gets if the default tooltip has been selected for display.
[Parameter]
public bool IsDefaultToolTipSelected { get; set; } IsDropShadowEnabled
Section titled "IsDropShadowEnabled"Gets or sets whether drop shadow should be enabled for this series.
[Parameter]
public bool IsDropShadowEnabled { get; set; } IsHighlightingEnabled
Section titled "IsHighlightingEnabled"Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.
[Parameter]
public bool IsHighlightingEnabled { get; set; } Layers
Section titled "Layers"Gets the current extra layers for the series.
public IgbSeriesLayerCollection Layers { get; protected set; } Legend
Section titled "Legend"Gets or sets a legend for the current series object.
[Parameter]
public IgbLegendBase Legend { get; set; } LegendItemBadgeMode
Section titled "LegendItemBadgeMode"Gets or sets the mode of legend badge representing the current series in a legend.
[Parameter]
public LegendItemBadgeMode LegendItemBadgeMode { get; set; } LegendItemBadgeShape
Section titled "LegendItemBadgeShape"Gets or sets the type of legend badge representing the current series in a legend.
[Parameter]
public LegendItemBadgeShape LegendItemBadgeShape { get; set; } LegendItemBadgeTemplate
Section titled "LegendItemBadgeTemplate"Gets or sets the LegendItemBadgeTemplate property.
[Parameter]
public object LegendItemBadgeTemplate { get; set; } LegendItemBadgeTemplateScript
Section titled "LegendItemBadgeTemplateScript"Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment.
[Parameter]
public string LegendItemBadgeTemplateScript { get; set; } LegendItemTemplate
Section titled "LegendItemTemplate"Gets or sets the LegendItemTemplate property.
[Parameter]
public object LegendItemTemplate { get; set; } LegendItemTemplateScript
Section titled "LegendItemTemplateScript"Provides a means of setting LegendItemTemplate in the JavaScript environment.
[Parameter]
public string LegendItemTemplateScript { get; set; } LegendItemVisibility
Section titled "LegendItemVisibility"Gets or sets whether or not the current series will have a legend item displayed in a legend.
[Parameter]
public Visibility LegendItemVisibility { get; set; } LegendScript
Section titled "LegendScript"Provides a means of setting Legend in the JavaScript environment.
[Parameter]
public string LegendScript { get; set; } LineCap
Section titled "LineCap"Gets or sets the style of the starting point of any lines or polylines representing this series.
[Parameter]
public PenLineCap LineCap { get; set; } LineJoin
Section titled "LineJoin"Gets or sets the brush that specifies current series object's line join style.
[Parameter]
public PenLineJoin LineJoin { get; set; } MarkerFillOpacity
Section titled "MarkerFillOpacity"Gets or sets the opacity applied to the fill of the markers.
[Parameter]
public double MarkerFillOpacity { get; set; } MouseOverEnabled
Section titled "MouseOverEnabled"Gets or sets the whether the chart reacts to mouse move events.
[Parameter]
public bool MouseOverEnabled { get; set; } Opacity
Section titled "Opacity"[Parameter]
public double Opacity { get; set; } Outline
Section titled "Outline"Gets or sets the brush to use for the outline of the series.
[Parameter]
public string Outline { get; set; } OutlineMode
Section titled "OutlineMode"Gets or sets the outline mode to use for the series.
[Parameter]
public SeriesOutlineMode OutlineMode { get; set; } PercentChange
Section titled "PercentChange"The percent change from the beginning to the end of this series.
[Parameter]
public double PercentChange { get; set; } RenderRequested
Section titled "RenderRequested"[Parameter]
public Action<IgbRenderRequestedEventArgs> RenderRequested { get; set; } RenderRequestedScript
Section titled "RenderRequestedScript"[Parameter]
public string RenderRequestedScript { get; set; } Resolution
Section titled "Resolution"Gets or sets the current series object's rendering resolution.
[Parameter]
public double Resolution { get; set; } SafeActualBrush
Section titled "SafeActualBrush"Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.
[Parameter]
public string SafeActualBrush { get; set; } SelectionBrush
Section titled "SelectionBrush"Gets or sets the selection brush to use for the series.
[Parameter]
public string SelectionBrush { get; set; } SelectionThickness
Section titled "SelectionThickness"Gets or sets the width of the current series object's line thickness when the series is selected.
[Parameter]
public double SelectionThickness { get; set; } SeriesViewerParent
Section titled "SeriesViewerParent"[CascadingParameter(Name = "SeriesViewerParent")]
protected BaseRendererControl SeriesViewerParent { get; set; } ShadowBlur
Section titled "ShadowBlur"Gets or sets the shadow blur.
[Parameter]
public double ShadowBlur { get; set; } ShadowColor
Section titled "ShadowColor"Gets or sets the drop shadow color.
[Parameter]
public string ShadowColor { get; set; } ShadowOffsetX
Section titled "ShadowOffsetX"Gets or sets the drop shadow x-offset.
[Parameter]
public double ShadowOffsetX { get; set; } ShadowOffsetY
Section titled "ShadowOffsetY"Gets or sets the drop shadow y-offset.
[Parameter]
public double ShadowOffsetY { get; set; } ShouldAnimateOnDataSourceSwap
Section titled "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.
[Parameter]
public bool ShouldAnimateOnDataSourceSwap { get; set; } ShouldHideAutoCallouts
Section titled "ShouldHideAutoCallouts"Gets or sets whether this series should suppress it's auto callouts
[Parameter]
public bool ShouldHideAutoCallouts { get; set; } ShouldRemoveHighlightedDataOnLayerHidden
Section titled "ShouldRemoveHighlightedDataOnLayerHidden"Gets or sets whether the opacity should be automatically shifted for the safe actual brush.
[Parameter]
public bool ShouldRemoveHighlightedDataOnLayerHidden { get; set; } ShouldShiftOpacityForSafeActualBrush
Section titled "ShouldShiftOpacityForSafeActualBrush"Gets or sets whether the opacity should be automatically shifted for the safe actual brush.
[Parameter]
public bool ShouldShiftOpacityForSafeActualBrush { get; set; } ShowDefaultTooltip
Section titled "ShowDefaultTooltip"Gets or sets whether default tooltip will be shown.
[Parameter]
public bool ShowDefaultTooltip { get; set; } Thickness
Section titled "Thickness"Gets or sets the width of the current series object's line thickness.
[Parameter]
public double Thickness { get; set; } Title
Section titled "Title"[Parameter]
public string Title { get; set; } TooltipTemplate
Section titled "TooltipTemplate"[Parameter]
public RenderFragment<IgbDataContext> TooltipTemplate { get; set; } TransitionDuration
Section titled "TransitionDuration"Gets or sets the duration of the current series' morph.
[Parameter]
public int TransitionDuration { get; set; } TransitionEasingFunction
Section titled "TransitionEasingFunction"Gets or sets the easing function used to morph the current series.
[Parameter]
public string TransitionEasingFunction { get; set; } TransitionEasingFunctionScript
Section titled "TransitionEasingFunctionScript"Provides a means of setting TransitionEasingFunction in the JavaScript environment.
[Parameter]
public string TransitionEasingFunctionScript { get; set; } TransitionInDuration
Section titled "TransitionInDuration"Gets or sets the duration of the current series' transition in morph.
[Parameter]
public int TransitionInDuration { get; set; } TransitionInEasingFunction
Section titled "TransitionInEasingFunction"Gets or sets the EasingFunction used to morph the current series during the initial transition.
[Parameter]
public string TransitionInEasingFunction { get; set; } TransitionInEasingFunctionScript
Section titled "TransitionInEasingFunctionScript"Provides a means of setting TransitionInEasingFunction in the JavaScript environment.
[Parameter]
public string TransitionInEasingFunctionScript { get; set; } TransitionInSpeedType
Section titled "TransitionInSpeedType"Gets or sets the duration of the current series' transition in morph.
[Parameter]
public TransitionInSpeedType TransitionInSpeedType { get; set; } TransitionOutDuration
Section titled "TransitionOutDuration"Gets or sets the duration of the current series' transition out morph.
[Parameter]
public int TransitionOutDuration { get; set; } TransitionOutEasingFunction
Section titled "TransitionOutEasingFunction"Gets or sets the EasingFunction used to morph the current series during the initial transition.
[Parameter]
public string TransitionOutEasingFunction { get; set; } TransitionOutEasingFunctionScript
Section titled "TransitionOutEasingFunctionScript"Provides a means of setting TransitionOutEasingFunction in the JavaScript environment.
[Parameter]
public string TransitionOutEasingFunctionScript { get; set; } TransitionOutSpeedType
Section titled "TransitionOutSpeedType"Gets or sets the duration of the current series' transition out morph.
[Parameter]
public TransitionOutSpeedType TransitionOutSpeedType { get; set; } public override string Type { get; } UseItemWiseColors
Section titled "UseItemWiseColors"Gets or sets whether the series should use individual palette colors for each item.
[Parameter]
public bool UseItemWiseColors { get; set; } UseSingleShadow
Section titled "UseSingleShadow"Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series.
[Parameter]
public bool UseSingleShadow { get; set; } Visibility
Section titled "Visibility"[Parameter]
public Visibility Visibility { get; set; } VisibleRangeMarginBottom
Section titled "VisibleRangeMarginBottom"Gets or sets the bottom margin to use when getting a visible axis range for the series.
[Parameter]
public double VisibleRangeMarginBottom { get; set; } VisibleRangeMarginLeft
Section titled "VisibleRangeMarginLeft"Gets or sets the left margin to use when getting a visible axis range for the series.
[Parameter]
public double VisibleRangeMarginLeft { get; set; } VisibleRangeMarginRight
Section titled "VisibleRangeMarginRight"Gets or sets the right margin to use when getting a visible axis range for the series.
[Parameter]
public double VisibleRangeMarginRight { get; set; } VisibleRangeMarginTop
Section titled "VisibleRangeMarginTop"Gets or sets the top margin to use when getting a visible axis range for the series.
[Parameter]
public double VisibleRangeMarginTop { get; set; } VisibleRangeMode
Section titled "VisibleRangeMode"Gets or sets the visible range mode to use.
[Parameter]
public SeriesVisibleRangeMode VisibleRangeMode { get; set; } Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _name eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache _cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContent Methods
Section titled "Methods"EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"Inherited from: BaseRendererElement
protected virtual void EnsureModulesLoaded() Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder) Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName) Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null) Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null) Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements) Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements) Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName) Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null) Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize() Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid() Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args) Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args) Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string id, string value) Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json) Parameters
- grouping:
string - json:
string
Returns any
BindAxes(IgbAxis[])
Section titled "BindAxes(IgbAxis[])"protected virtual void BindAxes(IgbAxis[] Axes) Parameters
- Axes:
IgbAxis[]
Returns any
BindSeries(IgbSeries[])
Section titled "BindSeries(IgbSeries[])"protected virtual void BindSeries(IgbSeries[] Series) Parameters
- Series:
IgbSeries[]
Returns any
Dispose()
Section titled "Dispose()"public void Dispose() Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name) Parameters
- name:
string
Returns any
FromWorldPosition(Point)
Section titled "FromWorldPosition(Point)"public Point FromWorldPosition(Point world) Parameters
- world:
Point
Returns any
FromWorldPositionAsync(Point)
Section titled "FromWorldPositionAsync(Point)"Converts a point from world coordinates to coordinates within the viewport of the series.
public Task<Point> FromWorldPositionAsync(Point world) Parameters
- world:
Point
Returns any
GetEffectiveViewport()
Section titled "GetEffectiveViewport()"public virtual Rect GetEffectiveViewport() Returns any
GetEffectiveViewportAsync()
Section titled "GetEffectiveViewportAsync()"Gets the effective viewport, adjusted to account for margins and other factors.
public virtual Task<Rect> GetEffectiveViewportAsync() Returns any
GetExactItemIndex(Point)
Section titled "GetExactItemIndex(Point)"public virtual double GetExactItemIndex(Point world) Parameters
- world:
Point
Returns any
GetExactItemIndexAsync(Point)
Section titled "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.
public virtual Task<double> GetExactItemIndexAsync(Point world) Parameters
- world:
Point
Returns any
GetItem(Point)
Section titled "GetItem(Point)"public virtual object GetItem(Point world) Parameters
- world:
Point
Returns any
GetItemAsync(Point)
Section titled "GetItemAsync(Point)"Gets the item that is the best match for the specified world coordinates.
public virtual Task<object> GetItemAsync(Point world) Parameters
- world:
Point
Returns any
GetItemIndex(Point)
Section titled "GetItemIndex(Point)"public virtual int GetItemIndex(Point world) Parameters
- world:
Point
Returns any
GetItemIndexAsync(Point)
Section titled "GetItemIndexAsync(Point)"Gets the item index associated with the specified world position
public virtual Task<int> GetItemIndexAsync(Point world) Parameters
- world:
Point
Returns any
GetItemSpan()
Section titled "GetItemSpan()"public virtual double GetItemSpan() Returns any
GetItemSpanAsync()
Section titled "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.
public virtual Task<double> GetItemSpanAsync() Returns any
GetItemValue(object, string)
Section titled "GetItemValue(object, string)"public virtual object GetItemValue(object item, string memberPathName) Parameters
- item:
object - memberPathName:
string
Returns any
GetItemValueAsync(object, string)
Section titled "GetItemValueAsync(object, string)"public virtual Task<object> GetItemValueAsync(object item, string memberPathName) Parameters
- item:
object - memberPathName:
string
Returns any
GetMainContentViewport()
Section titled "GetMainContentViewport()"public Rect GetMainContentViewport() Returns any
GetMainContentViewportAsync()
Section titled "GetMainContentViewportAsync()"public Task<Rect> GetMainContentViewportAsync() Returns any
GetMemberPathValue(string)
Section titled "GetMemberPathValue(string)"public virtual string GetMemberPathValue(string memberPathName) Parameters
- memberPathName:
string
Returns any
GetMemberPathValueAsync(string)
Section titled "GetMemberPathValueAsync(string)"Gets the value of a requested member path from the series.
public virtual Task<string> GetMemberPathValueAsync(string memberPathName) Parameters
- memberPathName:
string
Returns any
GetNextOrExactIndex(Point, bool)
Section titled "GetNextOrExactIndex(Point, bool)"public virtual int GetNextOrExactIndex(Point world, bool skipUnknowns) Parameters
- world:
Point - skipUnknowns:
bool
Returns any
GetNextOrExactIndexAsync(Point, bool)
Section titled "GetNextOrExactIndexAsync(Point, bool)"public virtual Task<int> GetNextOrExactIndexAsync(Point world, bool skipUnknowns) Parameters
- world:
Point - skipUnknowns:
bool
Returns any
GetPreviousOrExactIndex(Point, bool)
Section titled "GetPreviousOrExactIndex(Point, bool)"public virtual int GetPreviousOrExactIndex(Point world, bool skipUnknowns) Parameters
- world:
Point - skipUnknowns:
bool
Returns any
GetPreviousOrExactIndexAsync(Point, bool)
Section titled "GetPreviousOrExactIndexAsync(Point, bool)"public virtual Task<int> GetPreviousOrExactIndexAsync(Point world, bool skipUnknowns) Parameters
- world:
Point - skipUnknowns:
bool
Returns any
GetSeriesHighValue(Point, bool, bool)
Section titled "GetSeriesHighValue(Point, bool, bool)"public virtual double GetSeriesHighValue(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesHighValueAsync(Point, bool, bool)
Section titled "GetSeriesHighValueAsync(Point, bool, bool)"public virtual Task<double> GetSeriesHighValueAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesHighValuePosition(Point, bool, bool)
Section titled "GetSeriesHighValuePosition(Point, bool, bool)"public virtual Point GetSeriesHighValuePosition(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesHighValuePositionAsync(Point, bool, bool)
Section titled "GetSeriesHighValuePositionAsync(Point, bool, bool)"public virtual Task<Point> GetSeriesHighValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesLowValue(Point, bool, bool)
Section titled "GetSeriesLowValue(Point, bool, bool)"public virtual double GetSeriesLowValue(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesLowValueAsync(Point, bool, bool)
Section titled "GetSeriesLowValueAsync(Point, bool, bool)"public virtual Task<double> GetSeriesLowValueAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesLowValuePosition(Point, bool, bool)
Section titled "GetSeriesLowValuePosition(Point, bool, bool)"public virtual Point GetSeriesLowValuePosition(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesLowValuePositionAsync(Point, bool, bool)
Section titled "GetSeriesLowValuePositionAsync(Point, bool, bool)"public virtual Task<Point> GetSeriesLowValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValue(Point, bool, bool)
Section titled "GetSeriesValue(Point, bool, bool)"public virtual double GetSeriesValue(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValueAsync(Point, bool, bool)
Section titled "GetSeriesValueAsync(Point, bool, bool)"public virtual Task<double> GetSeriesValueAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValueBoundingBox(Point)
Section titled "GetSeriesValueBoundingBox(Point)"public virtual Rect GetSeriesValueBoundingBox(Point world) Parameters
- world:
Point
Returns any
GetSeriesValueBoundingBoxAsync(Point)
Section titled "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.
public virtual Task<Rect> GetSeriesValueBoundingBoxAsync(Point world) Parameters
- world:
Point
Returns any
GetSeriesValueFromSeriesPixel(Point, bool, bool)
Section titled "GetSeriesValueFromSeriesPixel(Point, bool, bool)"public virtual double GetSeriesValueFromSeriesPixel(Point mouse, bool useInterpolation, bool skipUnknowns) Parameters
- mouse:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValueFromSeriesPixelAsync(Point, bool, bool)
Section titled "GetSeriesValueFromSeriesPixelAsync(Point, bool, bool)"public virtual Task<double> GetSeriesValueFromSeriesPixelAsync(Point mouse, bool useInterpolation, bool skipUnknowns) Parameters
- mouse:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValueMarkerBoundingBox(Point)
Section titled "GetSeriesValueMarkerBoundingBox(Point)"public virtual Rect GetSeriesValueMarkerBoundingBox(Point world) Parameters
- world:
Point
Returns any
GetSeriesValueMarkerBoundingBoxAsync(Point)
Section titled "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.
public virtual Task<Rect> GetSeriesValueMarkerBoundingBoxAsync(Point world) Parameters
- world:
Point
Returns any
GetSeriesValuePosition(Point, bool, bool)
Section titled "GetSeriesValuePosition(Point, bool, bool)"public virtual Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValuePositionAsync(Point, bool, bool)
Section titled "GetSeriesValuePositionAsync(Point, bool, bool)"public virtual Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns) Parameters
- world:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValuePositionFromSeriesPixel(Point, bool, bool)
Section titled "GetSeriesValuePositionFromSeriesPixel(Point, bool, bool)"public virtual Point GetSeriesValuePositionFromSeriesPixel(Point mouse, bool useInterpolation, bool skipUnknowns) Parameters
- mouse:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValuePositionFromSeriesPixelAsync(Point, bool, bool)
Section titled "GetSeriesValuePositionFromSeriesPixelAsync(Point, bool, bool)"public virtual Task<Point> GetSeriesValuePositionFromSeriesPixelAsync(Point mouse, bool useInterpolation, bool skipUnknowns) Parameters
- mouse:
Point - useInterpolation:
bool - skipUnknowns:
bool
Returns any
GetSeriesValueType(ValueLayerValueMode)
Section titled "GetSeriesValueType(ValueLayerValueMode)"public virtual double[] GetSeriesValueType(ValueLayerValueMode mode) Parameters
- mode:
ValueLayerValueMode
Returns any
GetSeriesValueTypeAsync(ValueLayerValueMode)
Section titled "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.
public virtual Task<double[]> GetSeriesValueTypeAsync(ValueLayerValueMode mode) Parameters
- mode:
ValueLayerValueMode
Returns any
GetSeriesValueTypePosition(ValueLayerValueMode)
Section titled "GetSeriesValueTypePosition(ValueLayerValueMode)"public virtual Point GetSeriesValueTypePosition(ValueLayerValueMode mode) Parameters
- mode:
ValueLayerValueMode
Returns any
GetSeriesValueTypePositionAsync(ValueLayerValueMode)
Section titled "GetSeriesValueTypePositionAsync(ValueLayerValueMode)"Gets position of series value for specified layer value mode
public virtual Task<Point> GetSeriesValueTypePositionAsync(ValueLayerValueMode mode) Parameters
- mode:
ValueLayerValueMode
Returns any
GetUnscaledPosition(Point)
Section titled "GetUnscaledPosition(Point)"public virtual Point GetUnscaledPosition(Point pos) Parameters
- pos:
Point
Returns any
GetUnscaledPositionAsync(Point)
Section titled "GetUnscaledPositionAsync(Point)"Gets an unscaled position in terms of axis values from a viewport position.
public virtual Task<Point> GetUnscaledPositionAsync(Point pos) Parameters
- pos:
Point
Returns any
HideToolTips()
Section titled "HideToolTips()"public virtual void HideToolTips() Returns any
HideToolTipsAsync()
Section titled "HideToolTipsAsync()"Hides any internal tooltips presented by the series, if any.
public virtual Task HideToolTipsAsync() Returns any
HideToolTipsImmediate()
Section titled "HideToolTipsImmediate()"public virtual void HideToolTipsImmediate() Returns any
HideToolTipsImmediateAsync()
Section titled "HideToolTipsImmediateAsync()"Hides any internal tooltips presented by the series, if any.
public virtual Task HideToolTipsImmediateAsync() Returns any
MoveCursorPoint(Point)
Section titled "MoveCursorPoint(Point)"public void MoveCursorPoint(Point point) Parameters
- point:
Point
Returns any
MoveCursorPointAsync(Point)
Section titled "MoveCursorPointAsync(Point)"Moves the cursor point to the provided world position. Some series may react to the current cursor position.
public Task MoveCursorPointAsync(Point point) Parameters
- point:
Point
Returns any
NotifyIndexedPropertiesChanged()
Section titled "NotifyIndexedPropertiesChanged()"public virtual void NotifyIndexedPropertiesChanged() Returns any
NotifyIndexedPropertiesChangedAsync()
Section titled "NotifyIndexedPropertiesChangedAsync()"Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series
public virtual Task NotifyIndexedPropertiesChangedAsync() Returns any
NotifyVisualPropertiesChanged()
Section titled "NotifyVisualPropertiesChanged()"public void NotifyVisualPropertiesChanged() Returns any
NotifyVisualPropertiesChangedAsync()
Section titled "NotifyVisualPropertiesChangedAsync()"Notifies the series that a visual property has changed, requiring a visual update.
public Task NotifyVisualPropertiesChangedAsync() Returns any
OnInitializedAsync()
Section titled "OnInitializedAsync()"protected override Task OnInitializedAsync() Returns any
PlayTransitionIn()
Section titled "PlayTransitionIn()"public virtual void PlayTransitionIn() Returns any
PlayTransitionInAsync()
Section titled "PlayTransitionInAsync()"Plays the assigned transition out animation, if any.
public virtual Task PlayTransitionInAsync() Returns any
PlayTransitionOut()
Section titled "PlayTransitionOut()"public virtual void PlayTransitionOut() Returns any
PlayTransitionOutAndRemove()
Section titled "PlayTransitionOutAndRemove()"public virtual void PlayTransitionOutAndRemove() Returns any
PlayTransitionOutAndRemoveAsync()
Section titled "PlayTransitionOutAndRemoveAsync()"Plays the assigned transition out animation, if any.
public virtual Task PlayTransitionOutAndRemoveAsync() Returns any
PlayTransitionOutAsync()
Section titled "PlayTransitionOutAsync()"Plays the assigned transition out animation, if any.
public virtual Task PlayTransitionOutAsync() Returns any
RemoveAllAlternateViews()
Section titled "RemoveAllAlternateViews()"public virtual void RemoveAllAlternateViews() Returns any
RemoveAllAlternateViewsAsync()
Section titled "RemoveAllAlternateViewsAsync()"Removes all alternate views of this series.
public virtual Task RemoveAllAlternateViewsAsync() Returns any
RemoveAlternateView(string)
Section titled "RemoveAlternateView(string)"public virtual void RemoveAlternateView(string viewIdentifier) Parameters
- viewIdentifier:
string
Returns any
RemoveAlternateViewAsync(string)
Section titled "RemoveAlternateViewAsync(string)"Removes an alternate view of this series.
public virtual Task RemoveAlternateViewAsync(string viewIdentifier) Parameters
- viewIdentifier:
string
Returns any
RemoveAxes()
Section titled "RemoveAxes()"public void RemoveAxes() Returns any
RemoveAxesAsync()
Section titled "RemoveAxesAsync()"Call to null out the axes of the series;
public Task RemoveAxesAsync() Returns any
RenderSeries(bool)
Section titled "RenderSeries(bool)"public virtual void RenderSeries(bool animate) Parameters
- animate:
bool
Returns any
RenderSeriesAsync(bool)
Section titled "RenderSeriesAsync(bool)"Renders the series.
public virtual Task RenderSeriesAsync(bool animate) Parameters
- animate:
bool
Returns any
ReplayTransitionIn()
Section titled "ReplayTransitionIn()"public virtual void ReplayTransitionIn() Returns any
ReplayTransitionInAsync()
Section titled "ReplayTransitionInAsync()"Replays the assigned transition in animation, if any.
public virtual Task ReplayTransitionInAsync() Returns any
ResolveTooltipBrush()
Section titled "ResolveTooltipBrush()"public string ResolveTooltipBrush() Returns any
ResolveTooltipBrushAsync()
Section titled "ResolveTooltipBrushAsync()"Gets the brush for tooltip labels.
public Task<string> ResolveTooltipBrushAsync() Returns any
ScrollIntoView(object)
Section titled "ScrollIntoView(object)"public virtual bool ScrollIntoView(object item) Parameters
- item:
object
Returns any
ScrollIntoViewAsync(object)
Section titled "ScrollIntoViewAsync(object)"Requests that the provided item should be brought into view if possible.
public virtual Task<bool> ScrollIntoViewAsync(object item) Parameters
- item:
object
Returns any
SetNegativeColors(string, string)
Section titled "SetNegativeColors(string, string)"public virtual void SetNegativeColors(string negativeBrush, string negativeOutline) Parameters
- negativeBrush:
string - negativeOutline:
string
Returns any
SetNegativeColorsAsync(string, string)
Section titled "SetNegativeColorsAsync(string, string)"public virtual Task SetNegativeColorsAsync(string negativeBrush, string negativeOutline) Parameters
- negativeBrush:
string - negativeOutline:
string
Returns any
SimulateHover(Point)
Section titled "SimulateHover(Point)"public virtual void SimulateHover(Point point) Parameters
- point:
Point
Returns any
SimulateHoverAsync(Point)
Section titled "SimulateHoverAsync(Point)"Simulates a pointer hover over the series surface.
public virtual Task SimulateHoverAsync(Point point) Parameters
- point:
Point
Returns any
StyleUpdated()
Section titled "StyleUpdated()"public virtual void StyleUpdated() Returns any
StyleUpdatedAsync()
Section titled "StyleUpdatedAsync()"Called when this series' Style is updated.
public virtual Task StyleUpdatedAsync() Returns any
ToWorldPosition(Point)
Section titled "ToWorldPosition(Point)"public Point ToWorldPosition(Point seriesPoint) Parameters
- seriesPoint:
Point
Returns any
ToWorldPositionAsync(Point)
Section titled "ToWorldPositionAsync(Point)"Converts a point from coordinates within the series plot area to a world position within axis space.
public Task<Point> ToWorldPositionAsync(Point seriesPoint) Parameters
- seriesPoint:
Point
Returns any
ToWorldRect(Rect)
Section titled "ToWorldRect(Rect)"public Rect ToWorldRect(Rect rect) Parameters
- rect:
Rect
Returns any
ToWorldRectAsync(Rect)
Section titled "ToWorldRectAsync(Rect)"Converts a rect from coordinates within the series plot area to a world position within axis space.
public Task<Rect> ToWorldRectAsync(Rect rect) Parameters
- rect:
Rect
Returns any
Events
Section titled "Events"TransitionOutCompleted
Section titled "TransitionOutCompleted"[Parameter]
public EventCallback<IgbTransitionOutCompletedEventArgs> TransitionOutCompleted { get; set; } TransitionOutCompletedScript
Section titled "TransitionOutCompletedScript"[Parameter]
public string TransitionOutCompletedScript { get; set; }