Represents a control for viewing series objects.

Inheritance

object

Classes that extend this class.

Derived Classes
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbSeriesViewer()

Returns IgbSeriesViewer

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

Resolved method of hit testing used when the pointer is over elements in the chart.

[Parameter]
public ChartHitTestMode ActualContentHitTestMode { get; set; }

Resolved method of pixel scaling to use during end user interaction with the chart.

[Parameter]
public double ActualInteractionPixelScalingRatio { get; set; }

Gets the resolved pixel scaling ratio.

[Parameter]
public double ActualPixelScalingRatio { get; set; }
public IgbSeriesCollection ActualSeries { get; }

A number between 0 and 1 determining the position of the horizontal scroll.

[Parameter]
public double ActualWindowPositionHorizontal { get; set; }

A number between 0 and 1 determining the position of the vertical scroll.

[Parameter]
public double ActualWindowPositionVertical { get; set; }

Gets the actual value of the window rectangle, which represents the current zoom level.

[Parameter]
public Rect ActualWindowRect { get; set; }
[Parameter]
public Action<IgbRectChangedEventArgs> ActualWindowRectChanged { get; set; }
[Parameter]
public string ActualWindowRectChangedScript { get; set; }

Gets the actual minimum height that the window rect is allowed to reach before being clamped.

[Parameter]
public double ActualWindowRectMinHeight { get; set; }

Gets the actual minimum width that the window rect is allowed to reach before being clamped.

[Parameter]
public double ActualWindowRectMinWidth { get; set; }

Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

[Parameter]
public bool AnimateSeriesWhenAxisRangeChanges { get; set; }

Sets or gets the automatic height to add when automatically adding margins to the chart.

[Parameter]
public double AutoMarginHeight { get; set; }

Sets or gets the automatic width to add when automatically adding margins to the chart.

[Parameter]
public double AutoMarginWidth { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseClick { get; set; }
[Parameter]
public string AxisLabelMouseClickScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseDown { get; set; }
[Parameter]
public string AxisLabelMouseDownScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseEnter { get; set; }
[Parameter]
public string AxisLabelMouseEnterScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseLeave { get; set; }
[Parameter]
public string AxisLabelMouseLeaveScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseOver { get; set; }
[Parameter]
public string AxisLabelMouseOverScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisLabelMouseUp { get; set; }
[Parameter]
public string AxisLabelMouseUpScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseClick { get; set; }
[Parameter]
public string AxisPanelMouseClickScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseDown { get; set; }
[Parameter]
public string AxisPanelMouseDownScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseEnter { get; set; }
[Parameter]
public string AxisPanelMouseEnterScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseLeave { get; set; }
[Parameter]
public string AxisPanelMouseLeaveScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseOver { get; set; }
[Parameter]
public string AxisPanelMouseOverScript { get; set; }
[Parameter]
public Action<IgbAxisMouseEventArgs> AxisPanelMouseUp { get; set; }
[Parameter]
public string AxisPanelMouseUpScript { get; set; }

Sets or gets the bottom margin to use around the chart content.

[Parameter]
public double BottomMargin { get; set; }

Gets or sets the palette of brushes used for fill of plotted series.

[Parameter]
public string Brushes { get; set; }

Text to display above the plot area.

[Parameter]
public string ChartTitle { get; set; }

Determines the method of hit testing used when mousing over elements in the chart.

[Parameter]
public ChartHitTestMode ContentHitTestMode { get; set; }
public IgbSeriesCollection ContentSeries { get; }

Gets or sets the cross hair point (in world coordinates)

[Parameter]
public Point CrosshairPoint { get; set; }

Gets or sets the current SeriesViewer's crosshair visibility override.

[Parameter]
public Visibility CrosshairVisibility { get; set; }

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

Gets or sets the DefaultInteraction property.

[Parameter]
public InteractionState DefaultInteraction { get; set; }

Gets or sets the current SeriesViewer's DragModifier property.

[Parameter]
public ModifierKeys DragModifier { get; set; }

Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted.

[Parameter]
public Rect EffectiveViewport { get; set; }

Gets or sets how the mouse leave event fires when a manipulation is started.

[Parameter]
public bool FireMouseLeaveOnManipulationStart { get; set; }

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

[Parameter]
public string FocusBrush { get; set; }

Gets or sets the amount of time to delay before dismissing a selection effect.

[Parameter]
public int FocusDismissDelayMilliseconds { get; set; }

Gets or sets the focus mode to use for the series in the component, when supported.

[Parameter]
public SeriesSelectionMode FocusMode { get; set; }

Gets or sets the duration the Focus/de-Focus effects.

[Parameter]
public int FocusTransitionDuration { get; set; }

Gets the currently focused data items. Adding or removing data items from this collection will focus or blur the visuals associated with those items.

public IgbChartSelectedItemCollection FocusedSeriesItems { get; set; }
public IgbSeriesCollection FullSeries { get; protected set; }
[Parameter]
public Action<IgbRectChangedEventArgs> GridAreaRectChanged { get; set; }
[Parameter]
public string GridAreaRectChangedScript { get; set; }

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

[Parameter]
public SeriesHighlightedValuesDisplayMode HighlightedValuesDisplayMode { get; set; }

Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled.

[Parameter]
public SeriesHighlightingBehavior HighlightingBehavior { get; set; }

HighlightingDismissDelayMilliseconds

Section titled "HighlightingDismissDelayMilliseconds"

Gets or sets the amount of time to delay before dismissing a selection effect.

[Parameter]
public int HighlightingDismissDelayMilliseconds { get; set; }

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

[Parameter]
public double HighlightingFadeOpacity { get; set; }

Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled.

[Parameter]
public SeriesHighlightingMode HighlightingMode { get; set; }

Gets or sets the duration the highlighting/de-highlighting effects.

[Parameter]
public int HighlightingTransitionDuration { get; set; }

Gets or sets the current SeriesViewer's crosshair horizontal brush override.

[Parameter]
public string HorizontalCrosshairBrush { get; set; }

HorizontalViewScrollbarCornerRadius

Section titled "HorizontalViewScrollbarCornerRadius"

Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarCornerRadius { get; set; }

Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public string HorizontalViewScrollbarFill { get; set; }

Gets or sets the height to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarHeight { get; set; }

Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarInset { get; set; }

Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarMaxOpacity { get; set; }

Gets or sets the horizontal scrollbar mode to use for the series viewer.

[Parameter]
public SeriesViewerScrollbarMode HorizontalViewScrollbarMode { get; set; }

Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public string HorizontalViewScrollbarOutline { get; set; }

Gets or sets the position to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public SeriesViewerHorizontalScrollbarPosition HorizontalViewScrollbarPosition { get; set; }

HorizontalViewScrollbarShouldAddAutoTrackInsets

Section titled "HorizontalViewScrollbarShouldAddAutoTrackInsets"

Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled.

[Parameter]
public bool HorizontalViewScrollbarShouldAddAutoTrackInsets { get; set; }

HorizontalViewScrollbarStrokeThickness

Section titled "HorizontalViewScrollbarStrokeThickness"

Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarStrokeThickness { get; set; }

HorizontalViewScrollbarTrackEndInset

Section titled "HorizontalViewScrollbarTrackEndInset"

Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarTrackEndInset { get; set; }

HorizontalViewScrollbarTrackStartInset

Section titled "HorizontalViewScrollbarTrackStartInset"

Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled.

[Parameter]
public double HorizontalViewScrollbarTrackStartInset { get; set; }
[Parameter]
public Action<IgbImageCapturedEventArgs> ImageCaptured { get; set; }
[Parameter]
public string ImageCapturedScript { get; set; }

Gets or sets the InteractionOverride property.

[Parameter]
public InteractionState InteractionOverride { get; set; }

Method of pixel scaling to use during end user interaction with the chart.

[Parameter]
public double InteractionPixelScalingRatio { get; set; }

IsAntiAliasingEnabledDuringInteraction

Section titled "IsAntiAliasingEnabledDuringInteraction"

Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

[Parameter]
public bool IsAntiAliasingEnabledDuringInteraction { get; set; }

Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction.

[Parameter]
public bool IsPagePanningAllowed { get; set; }

Gets or sets whether all surface interactions with the plot area should be disabled.

[Parameter]
public bool IsSurfaceInteractionDisabled { get; set; }

Gets or sets whether initiating user annotations from the toolbar is enabled.

[Parameter]
public bool IsUserAnnotationsEnabled { get; set; }

Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series.

[Parameter]
public bool IsWindowSyncedToVisibleRange { get; set; }

Sets or gets the left margin to use around the chart content.

[Parameter]
public double LeftMargin { get; set; }

Gets or sets which legend to use for all series in this SeriesViewer, unless otherwise specified by the Series.Legend property.

[Parameter]
public IgbLegendBase Legend { get; set; }

Gets or sets the highlighting mode to use for the legend linked to the component, when supported.

[Parameter]
public LegendHighlightingMode LegendHighlightingMode { get; set; }

Gets or sets the mode of legend badges representing all series in this chart.

[Parameter]
public LegendItemBadgeMode LegendItemBadgeMode { get; set; }

Gets or sets type of legend badges representing all series displayed in a legend linked to this component

[Parameter]
public LegendItemBadgeShape LegendItemBadgeShape { get; set; }

Provides a means of setting Legend in the JavaScript environment.

[Parameter]
public string LegendScript { get; set; }

Gets or sets the marker mode used for assigning a marker type to series when the marker type is automatic.

[Parameter]
public MarkerAutomaticBehavior MarkerAutomaticBehavior { get; set; }

Gets or sets the palette of brushes used for fill of marker series.

[Parameter]
public string MarkerBrushes { get; set; }

Gets or sets the palette of brushes used for outlines of plotted markers.

[Parameter]
public string MarkerOutlines { get; set; }

Gets or sets the palette of brushes used for outlines of plotted series.

[Parameter]
public string Outlines { get; set; }

Gets or sets the current SeriesViewer's PanModifier property.

[Parameter]
public ModifierKeys PanModifier { get; set; }
protected override string ParentTypeName { get; }

Gets or sets the scaling value used to affect the pixel density of the control.

[Parameter]
public double PixelScalingRatio { get; set; }

Gets or sets the brush used as the background for the current SeriesViewer object's plot area.

[Parameter]
public string PlotAreaBackground { get; set; }
[Parameter]
public Action<IgbPlotAreaMouseEventArgs> PlotAreaMouseEnter { get; set; }
[Parameter]
public string PlotAreaMouseEnterScript { get; set; }
[Parameter]
public Action<IgbPlotAreaMouseEventArgs> PlotAreaMouseLeave { get; set; }
[Parameter]
public string PlotAreaMouseLeaveScript { get; set; }
[Parameter]
public Action<IgbPlotAreaMouseEventArgs> PlotAreaMouseOver { get; set; }
[Parameter]
public string PlotAreaMouseOverScript { get; set; }

Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality.

[Parameter]
public bool PreferHigherResolutionTiles { get; set; }

Gets or sets the brush used as the fill for the current SeriesViewer object's preview path. Null is treated as auto.

[Parameter]
public string PreviewPathFill { get; set; }

Gets or sets the opacity used as for the fill for the current SeriesViewer object's preview path. Null is treated as auto.

[Parameter]
public double PreviewPathOpacity { get; set; }

Gets or sets the brush used as the border for the current SeriesViewer object's preview path. Null is treated as auto.

[Parameter]
public string PreviewPathStroke { get; set; }

Gets or sets the preview rectangle.

[Parameter]
public Rect PreviewRect { get; set; }
[Parameter]
public Action<IgbRefreshCompletedEventArgs> RefreshCompleted { get; set; }
[Parameter]
public string RefreshCompletedScript { get; set; }

Gets or sets the milliseconds before the chart will fire the resize idle event after the last resize.

[Parameter]
public int ResizeIdleMilliseconds { get; set; }

Gets or sets the RightButtonDefaultInteraction property.

[Parameter]
public InteractionState RightButtonDefaultInteraction { get; set; }

Sets or gets the right margin to use around the chart content.

[Parameter]
public double RightMargin { get; set; }

Gets or sets the duration of the scrollbar effects.

[Parameter]
public int ScrollbarsAnimationDuration { get; set; }

Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items.

public IgbChartSelectedItemCollection SelectedSeriesItems { get; set; }

Gets or sets the selection behavior to use for the series in the component, when supported.

[Parameter]
public SeriesSelectionBehavior SelectionBehavior { get; set; }

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

[Parameter]
public string SelectionBrush { get; set; }

Gets or sets the amount of time to delay before dismissing a selection effect.

[Parameter]
public int SelectionDismissDelayMilliseconds { get; set; }

Gets or sets the selection mode to use for the series in the component, when supported.

[Parameter]
public SeriesSelectionMode SelectionMode { get; set; }

Gets or sets the current SeriesViewer's SelectionModifier property.

[Parameter]
public ModifierKeys SelectionModifier { get; set; }

Gets or sets the duration the selection/de-Selection effects.

[Parameter]
public int SelectionTransitionDuration { get; set; }

Gets the current SeriesViewer object's child Series.

public IgbSeriesCollection Series { get; protected set; }
[Parameter]
public Action<IgbChartCursorEventArgs> SeriesCursorMouseMove { get; set; }
[Parameter]
public string SeriesCursorMouseMoveScript { get; set; }
[Parameter]
public Action<IgbChartMouseEventArgs> SeriesMouseMove { get; set; }
[Parameter]
public string SeriesMouseMoveScript { get; set; }

Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

[Parameter]
public bool SeriesValueLayerUseLegend { get; set; }

Gets or sets whether to match the z order of the series to their positional order in the series collection, regardless of mutation.

[Parameter]
public bool ShouldMatchZOrderToSeriesOrder { get; set; }

Gets or sets a whether the chart should pan its content when zooming in passed max zoom level.

[Parameter]
public bool ShouldPanOnMaximumZoom { get; set; }

ShouldSimulateHoverMoveCrosshairPoint

Section titled "ShouldSimulateHoverMoveCrosshairPoint"

Gets or sets whether calling SimulateHover should shift the crosshair point.

[Parameter]
public bool ShouldSimulateHoverMoveCrosshairPoint { get; set; }
[Parameter]
public Action<IgbRectChangedEventArgs> SizeChanged { get; set; }
[Parameter]
public string SizeChangedScript { get; set; }

Gets or sets the Subtitle property.

[Parameter]
public string Subtitle { get; set; }

Margin applied below the subtitle.

[Parameter]
public double SubtitleBottomMargin { get; set; }

Gets or sets the SubtitleHorizontalAlignment property.

[Parameter]
public HorizontalAlignment SubtitleHorizontalAlignment { get; set; }

Margin applied to the left of the subtitle.

[Parameter]
public double SubtitleLeftMargin { get; set; }

Margin applied to the right of the subtitle.

[Parameter]
public double SubtitleRightMargin { get; set; }

Gets or sets the Color used for the Subtitle Text.

[Parameter]
public string SubtitleTextColor { get; set; }

Font settings for the subtitle.

[Parameter]
public string SubtitleTextStyle { get; set; }

Margin applied above the subtitle.

[Parameter]
public double SubtitleTopMargin { get; set; }

Sets or gets the Synchronization channel to use for the SeriesViewer.

[Parameter]
public string SyncChannel { get; set; }

Margin applied below the title.

[Parameter]
public double TitleBottomMargin { get; set; }

Gets or sets the TitleHorizontalAlignment property.

[Parameter]
public HorizontalAlignment TitleHorizontalAlignment { get; set; }

Margin applied to the left of the title.

[Parameter]
public double TitleLeftMargin { get; set; }

Margin applied to the right of the title.

[Parameter]
public double TitleRightMargin { get; set; }

Gets or sets the Color used for the Title Text.

[Parameter]
public string TitleTextColor { get; set; }

Font settings for the title.

[Parameter]
public string TitleTextStyle { get; set; }

Margin applied above the title.

[Parameter]
public double TitleTopMargin { get; set; }

Sets or gets the top margin to use around the chart content.

[Parameter]
public double TopMargin { get; set; }
public override string Type { get; }

Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content.

[Parameter]
public bool UseTiledZooming { get; set; }

Gets or sets the current SeriesViewer's crosshair vertical brush override.

[Parameter]
public string VerticalCrosshairBrush { get; set; }

Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarCornerRadius { get; set; }

Gets or sets the fill to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public string VerticalViewScrollbarFill { get; set; }

Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarInset { get; set; }

Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarMaxOpacity { get; set; }

Gets or sets the vertical scrollbar mode to use for the series viewer.

[Parameter]
public SeriesViewerScrollbarMode VerticalViewScrollbarMode { get; set; }

Gets or sets the outline to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public string VerticalViewScrollbarOutline { get; set; }

Gets or sets the position to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public SeriesViewerVerticalScrollbarPosition VerticalViewScrollbarPosition { get; set; }

VerticalViewScrollbarShouldAddAutoTrackInsets

Section titled "VerticalViewScrollbarShouldAddAutoTrackInsets"

Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled.

[Parameter]
public bool VerticalViewScrollbarShouldAddAutoTrackInsets { get; set; }

VerticalViewScrollbarStrokeThickness

Section titled "VerticalViewScrollbarStrokeThickness"

Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarStrokeThickness { get; set; }

Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarTrackEndInset { get; set; }

VerticalViewScrollbarTrackStartInset

Section titled "VerticalViewScrollbarTrackStartInset"

Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarTrackStartInset { get; set; }

Gets or sets the width to use for the vertical scrollbar in the component, when enabled.

[Parameter]
public double VerticalViewScrollbarWidth { get; set; }
[Parameter]
public Action<IgbSeriesViewerManipulationEventArgs> ViewerManipulationEnding { get; set; }
[Parameter]
public string ViewerManipulationEndingScript { get; set; }
[Parameter]
public Action<IgbSeriesViewerManipulationEventArgs> ViewerManipulationStarting { get; set; }
[Parameter]
public string ViewerManipulationStartingScript { get; set; }

Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area.

public virtual Rect ViewportRect { get; protected set; }

A number between 0 and 1 determining the position of the horizontal scroll.

[Parameter]
public double WindowPositionHorizontal { get; set; }

A number between 0 and 1 determining the position of the vertical scroll.

[Parameter]
public double WindowPositionVertical { get; set; }

A rectangle representing the portion of the SeriesViewer currently in view.

[Parameter]
public Rect WindowRect { get; set; }
[Parameter]
public Action<IgbRectChangedEventArgs> WindowRectChanged { get; set; }
[Parameter]
public string WindowRectChangedScript { get; set; }

Sets or gets the minimum height that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

[Parameter]
public double WindowRectMinHeight { get; set; }

Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

[Parameter]
public double WindowRectMinWidth { get; set; }

The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

[Parameter]
public WindowResponse WindowResponse { get; set; }

Sets or gets minimum pixel height that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

[Parameter]
public double WindowSizeMinHeight { get; set; }

Sets or gets minimum pixel width that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

[Parameter]
public double WindowSizeMinWidth { get; set; }

Gets or sets zoom is constrained to within the axes. Setting this to false is a preview feature at the present time.

[Parameter]
public ZoomCoercionMode ZoomCoercionMode { get; set; }

Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode.

[Parameter]
public int ZoomTileCacheSize { get; set; }

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

protected virtual void EnsureModulesLoaded()

Returns any

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererControl

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

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: BaseRendererControl

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererControl

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererControl

public 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: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public void CancelAnnotationFlow(string annotationFlowID)

Parameters

  • annotationFlowID: string

Returns any

public Task CancelAnnotationFlowAsync(string annotationFlowID)

Parameters

  • annotationFlowID: string

Returns any

public void CancelCreatingAnnotation()

Returns any

public Task CancelCreatingAnnotationAsync()

Returns any

public void CancelDeletingAnnotation()

Returns any

public Task CancelDeletingAnnotationAsync()

Returns any

public void CancelManipulation()

Returns any

public Task CancelManipulationAsync()

Returns any

CaptureImage(IgbCaptureImageSettings)

Section titled "CaptureImage(IgbCaptureImageSettings)"
public void CaptureImage(IgbCaptureImageSettings settings)

Parameters

  • settings: IgbCaptureImageSettings

Returns any

CaptureImageAsync(IgbCaptureImageSettings)

Section titled "CaptureImageAsync(IgbCaptureImageSettings)"
public Task CaptureImageAsync(IgbCaptureImageSettings settings)

Parameters

  • settings: IgbCaptureImageSettings

Returns any

public void ClearTileZoomCache()

Returns any

Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.

public Task ClearTileZoomCacheAsync()

Returns any

public void Destroy()

Returns any

Release any resources held by the control.

public Task DestroyAsync()

Returns any

public void EndTiledZoomingIfRunning()

Returns any

Manually ends a tiled zoom if one is running.

public Task EndTiledZoomingIfRunningAsync()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

FinishAnnotationFlow(IgbUserAnnotationInformation)

Section titled "FinishAnnotationFlow(IgbUserAnnotationInformation)"
public void FinishAnnotationFlow(IgbUserAnnotationInformation info)

Parameters

  • info: IgbUserAnnotationInformation

Returns any

FinishAnnotationFlowAsync(IgbUserAnnotationInformation)

Section titled "FinishAnnotationFlowAsync(IgbUserAnnotationInformation)"
public Task FinishAnnotationFlowAsync(IgbUserAnnotationInformation info)

Parameters

  • info: IgbUserAnnotationInformation

Returns any

public void FinishCreatingAnnotation()

Returns any

public Task FinishCreatingAnnotationAsync()

Returns any

public void FinishDeletingAnnotation()

Returns any

public Task FinishDeletingAnnotationAsync()

Returns any

public void Flush()

Returns any

Use to force the SeriesViewer to finish any deferred work before printing or evaluating its visual.

public Task FlushAsync()

Returns any

public virtual double GetActualWindowScaleHorizontal()

Returns any

GetActualWindowScaleHorizontalAsync()

Section titled "GetActualWindowScaleHorizontalAsync()"

Gets actual window scale for horizontal dimension of the control

public virtual Task<double> GetActualWindowScaleHorizontalAsync()

Returns any

public virtual double GetActualWindowScaleVertical()

Returns any

GetActualWindowScaleVerticalAsync()

Section titled "GetActualWindowScaleVerticalAsync()"

Gets actual window scale for vertical dimension of the control

public virtual Task<double> GetActualWindowScaleVerticalAsync()

Returns any

protected virtual IgbAxis[] GetAllAxes()

Returns any

protected virtual IgbSeries[] GetAllSeries()

Returns any

public int GetAnimationIdleVersionNumber()

Returns any

GetAnimationIdleVersionNumberAsync()

Section titled "GetAnimationIdleVersionNumberAsync()"
public Task<int> GetAnimationIdleVersionNumberAsync()

Returns any

public Rect GetCurrentActualWindowRect()

Returns any

public Task<Rect> GetCurrentActualWindowRectAsync()

Returns any

public IgbChartSelectedItemCollection GetCurrentFocusedSeriesItems()

Returns any

GetCurrentFocusedSeriesItemsAsync()

Section titled "GetCurrentFocusedSeriesItemsAsync()"
public Task<IgbChartSelectedItemCollection> GetCurrentFocusedSeriesItemsAsync()

Returns any

public IgbChartSelectedItemCollection GetCurrentSelectedSeriesItems()

Returns any

GetCurrentSelectedSeriesItemsAsync()

Section titled "GetCurrentSelectedSeriesItemsAsync()"
public Task<IgbChartSelectedItemCollection> GetCurrentSelectedSeriesItemsAsync()

Returns any

public virtual Rect GetCurrentViewportRect()

Returns any

public virtual Task<Rect> GetCurrentViewportRectAsync()

Returns any

public Rect GetCurrentWindowRect()

Returns any

public Task<Rect> GetCurrentWindowRectAsync()

Returns any

public void HideToolTip()

Returns any

Hides the active main tooltip, if displayed.

public Task HideToolTipAsync()

Returns any

public bool IsAnimationActive()

Returns any

public Task<bool> IsAnimationActiveAsync()

Returns any

public void LoadAnnotationsFromJson(string jsonString)

Parameters

  • jsonString: string

Returns any

LoadAnnotationsFromJsonAsync(string)

Section titled "LoadAnnotationsFromJsonAsync(string)"
public Task LoadAnnotationsFromJsonAsync(string jsonString)

Parameters

  • jsonString: string

Returns any

public void NotifyContainerResized()

Returns any

Notification from the containing object that the container has been resized.

public Task NotifyContainerResizedAsync()

Returns any

public void NotifySeriesDataChanged()

Returns any

public Task NotifySeriesDataChangedAsync()

Returns any

public object RenderToImage(double width, double height)

Parameters

  • width: double
  • height: double

Returns any

public Task<object> RenderToImageAsync(double width, double height)

Parameters

  • width: double
  • height: double

Returns any

public void ResetAnnotations()

Returns any

public Task ResetAnnotationsAsync()

Returns any

public void ResetZoom()

Returns any

Resets the zoom level to default.

public Task ResetZoomAsync()

Returns any

public string SaveAnnotationsToJson()

Returns any

public Task<string> SaveAnnotationsToJsonAsync()

Returns any

public void SimulateClick(Point point)

Parameters

  • point: Point

Returns any

public Task SimulateClickAsync(Point point)

Parameters

  • point: Point

Returns any

public void SimulateHover(Point point)

Parameters

  • point: Point

Returns any

public Task SimulateHoverAsync(Point point)

Parameters

  • point: Point

Returns any

public void SimulateMouseLeave()

Returns any

public Task SimulateMouseLeaveAsync()

Returns any

public void SimulatePlotPointerUp(Point point)

Parameters

  • point: Point

Returns any

public Task SimulatePlotPointerUpAsync(Point point)

Parameters

  • point: Point

Returns any

public void SimulatePressAndHold(Point point)

Parameters

  • point: Point

Returns any

public Task SimulatePressAndHoldAsync(Point point)

Parameters

  • point: Point

Returns any

public void StartCreatingAnnotation()

Returns any

public Task StartCreatingAnnotationAsync()

Returns any

public void StartDeletingAnnotation()

Returns any

public Task StartDeletingAnnotationAsync()

Returns any

public void StartTiledZoomingIfNecessary()

Returns any

StartTiledZoomingIfNecessaryAsync()

Section titled "StartTiledZoomingIfNecessaryAsync()"

Manually starts a tiled zoom if one isn't already running.

public Task StartTiledZoomingIfNecessaryAsync()

Returns any

public void ZoomIn(double percentage)

Parameters

  • percentage: double

Returns any

Performs zoom in action on the chart by specified percentage of current window rect

public Task ZoomInAsync(double percentage)

Parameters

  • percentage: double

Returns any

public void ZoomOut(double percentage)

Parameters

  • percentage: double

Returns any

Performs zoom out action on the chart by specified percentage of current window rect

public Task ZoomOutAsync(double percentage)

Parameters

  • percentage: double

Returns any

[Parameter]
public EventCallback<IgbSeriesViewerSelectedSeriesItemsChangedEventArgs> FocusedSeriesItemsChanged { get; set; }
[Parameter]
public EventCallback<IgbPlotAreaMouseButtonEventArgs> PlotAreaClicked { get; set; }
[Parameter]
public EventCallback<IgbPlotAreaMouseButtonEventArgs> PlotAreaMouseLeftButtonDown { get; set; }
[Parameter]
public EventCallback<IgbPlotAreaMouseButtonEventArgs> PlotAreaMouseLeftButtonUp { get; set; }
[Parameter]
public EventCallback<IgbChartResizeIdleEventArgs> ResizeIdle { get; set; }
[Parameter]
public EventCallback<IgbSeriesViewerSelectedSeriesItemsChangedEventArgs> SelectedSeriesItemsChanged { get; set; }
[Parameter]
public EventCallback<IgbDataChartMouseButtonEventArgs> SeriesClick { get; set; }
[Parameter]
public EventCallback<IgbChartMouseEventArgs> SeriesMouseEnter { get; set; }
[Parameter]
public EventCallback<IgbChartMouseEventArgs> SeriesMouseLeave { get; set; }
[Parameter]
public EventCallback<IgbDataChartMouseButtonEventArgs> SeriesMouseLeftButtonDown { get; set; }
[Parameter]
public EventCallback<IgbDataChartMouseButtonEventArgs> SeriesMouseLeftButtonUp { get; set; }
[Parameter]
public EventCallback<IgbUserAnnotationInformationEventArgs> UserAnnotationInformationRequested { get; set; }

UserAnnotationToolTipContentUpdating

Section titled "UserAnnotationToolTipContentUpdating"
[Parameter]
public EventCallback<IgbUserAnnotationToolTipContentUpdatingEventArgs> UserAnnotationToolTipContentUpdating { get; set; }
[Parameter]
public string FocusedSeriesItemsChangedScript { get; set; }
[Parameter]
public string PlotAreaClickedScript { get; set; }
[Parameter]
public string PlotAreaMouseLeftButtonDownScript { get; set; }
[Parameter]
public string PlotAreaMouseLeftButtonUpScript { get; set; }
[Parameter]
public string ResizeIdleScript { get; set; }
[Parameter]
public string SelectedSeriesItemsChangedScript { get; set; }
[Parameter]
public string SeriesClickScript { get; set; }
[Parameter]
public string SeriesMouseEnterScript { get; set; }
[Parameter]
public string SeriesMouseLeaveScript { get; set; }
[Parameter]
public string SeriesMouseLeftButtonDownScript { get; set; }
[Parameter]
public string SeriesMouseLeftButtonUpScript { get; set; }

UserAnnotationInformationRequestedScript

Section titled "UserAnnotationInformationRequestedScript"
[Parameter]
public string UserAnnotationInformationRequestedScript { get; set; }

UserAnnotationToolTipContentUpdatingScript

Section titled "UserAnnotationToolTipContentUpdatingScript"
[Parameter]
public string UserAnnotationToolTipContentUpdatingScript { get; set; }