IgrSeriesViewer

Represents a control for viewing series objects.

Constructors

new IgrSeriesViewer(props: P): IgrSeriesViewer

Returns IgrSeriesViewer

Properties

actualContentHitTestMode

actualContentHitTestMode: ChartHitTestMode

actualInteractionPixelScalingRatio

actualInteractionPixelScalingRatio: number

actualPixelScalingRatio

actualPixelScalingRatio: number

actualWindowPositionHorizontal

actualWindowPositionHorizontal: number

actualWindowPositionVertical

actualWindowPositionVertical: number

actualWindowRect

actualWindowRect: IgRect

actualWindowRectChanged

actualWindowRectChanged: object

actualWindowRectMinHeight

actualWindowRectMinHeight: number

actualWindowRectMinWidth

actualWindowRectMinWidth: number

animateSeriesWhenAxisRangeChanges

animateSeriesWhenAxisRangeChanges: boolean

autoMarginHeight

autoMarginHeight: number

autoMarginWidth

autoMarginWidth: number

axisLabelMouseClick

axisLabelMouseClick: object

axisLabelMouseDown

axisLabelMouseDown: object

axisLabelMouseEnter

axisLabelMouseEnter: object

axisLabelMouseLeave

axisLabelMouseLeave: object

axisLabelMouseOver

axisLabelMouseOver: object

axisLabelMouseUp

axisLabelMouseUp: object

axisPanelMouseClick

axisPanelMouseClick: object

axisPanelMouseDown

axisPanelMouseDown: object

axisPanelMouseEnter

axisPanelMouseEnter: object

axisPanelMouseLeave

axisPanelMouseLeave: object

axisPanelMouseOver

axisPanelMouseOver: object

axisPanelMouseUp

axisPanelMouseUp: object

bottomMargin

bottomMargin: number

brushes

brushes: string[]

chartTitle

chartTitle: string

contentHitTestMode

contentHitTestMode: ChartHitTestMode

crosshairPoint

crosshairPoint: IgPoint

crosshairVisibility

crosshairVisibility: Visibility

defaultInteraction

defaultInteraction: InteractionState

dragModifier

dragModifier: ModifierKeys

effectiveViewport

effectiveViewport: IgRect

fireMouseLeaveOnManipulationStart

fireMouseLeaveOnManipulationStart: boolean

focusBrush

focusBrush: string

focusDismissDelayMilliseconds

focusDismissDelayMilliseconds: number

focusedSeriesItems

focusedSeriesItems: IgrChartSelectedItemCollection

focusedSeriesItemsChanged

focusedSeriesItemsChanged: object

focusMode

focusMode: SeriesSelectionMode

focusTransitionDuration

focusTransitionDuration: number

fullSeries

fullSeries: IgrSeriesCollection

gridAreaRectChanged

gridAreaRectChanged: object

highlightedValuesDisplayMode

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightingBehavior

highlightingBehavior: SeriesHighlightingBehavior

highlightingDismissDelayMilliseconds

highlightingDismissDelayMilliseconds: number

highlightingFadeOpacity

highlightingFadeOpacity: number

highlightingMode

highlightingMode: SeriesHighlightingMode

highlightingTransitionDuration

highlightingTransitionDuration: number

horizontalCrosshairBrush

horizontalCrosshairBrush: string

horizontalViewScrollbarCornerRadius

horizontalViewScrollbarCornerRadius: number

horizontalViewScrollbarFill

horizontalViewScrollbarFill: string

horizontalViewScrollbarHeight

horizontalViewScrollbarHeight: number

horizontalViewScrollbarInset

horizontalViewScrollbarInset: number

horizontalViewScrollbarMaxOpacity

horizontalViewScrollbarMaxOpacity: number

horizontalViewScrollbarMode

horizontalViewScrollbarMode: SeriesViewerScrollbarMode

horizontalViewScrollbarOutline

horizontalViewScrollbarOutline: string

horizontalViewScrollbarPosition

horizontalViewScrollbarPosition: SeriesViewerHorizontalScrollbarPosition

horizontalViewScrollbarShouldAddAutoTrackInsets

horizontalViewScrollbarShouldAddAutoTrackInsets: boolean

horizontalViewScrollbarStrokeThickness

horizontalViewScrollbarStrokeThickness: number

horizontalViewScrollbarTrackEndInset

horizontalViewScrollbarTrackEndInset: number

horizontalViewScrollbarTrackStartInset

horizontalViewScrollbarTrackStartInset: number

imageCaptured

imageCaptured: object

interactionOverride

interactionOverride: InteractionState

interactionPixelScalingRatio

interactionPixelScalingRatio: number

isAntiAliasingEnabledDuringInteraction

isAntiAliasingEnabledDuringInteraction: boolean

isPagePanningAllowed

isPagePanningAllowed: boolean

isSurfaceInteractionDisabled

isSurfaceInteractionDisabled: boolean

isUserAnnotationsEnabled

isUserAnnotationsEnabled: boolean

isWindowSyncedToVisibleRange

isWindowSyncedToVisibleRange: boolean

leftMargin

leftMargin: number

legendHighlightingMode

legendHighlightingMode: LegendHighlightingMode

legendItemBadgeMode

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

legendItemBadgeShape: LegendItemBadgeShape

markerAutomaticBehavior

markerAutomaticBehavior: MarkerAutomaticBehavior

markerBrushes

markerBrushes: string[]

markerOutlines

markerOutlines: string[]

outlines

outlines: string[]

panModifier

panModifier: ModifierKeys

pixelScalingRatio

pixelScalingRatio: number

plotAreaBackground

plotAreaBackground: string

plotAreaClicked

plotAreaClicked: object

plotAreaMouseEnter

plotAreaMouseEnter: object

plotAreaMouseLeave

plotAreaMouseLeave: object

plotAreaMouseLeftButtonDown

plotAreaMouseLeftButtonDown: object

plotAreaMouseLeftButtonUp

plotAreaMouseLeftButtonUp: object

plotAreaMouseOver

plotAreaMouseOver: object

preferHigherResolutionTiles

preferHigherResolutionTiles: boolean

previewPathFill

previewPathFill: string

previewPathOpacity

previewPathOpacity: number

previewPathStroke

previewPathStroke: string

previewRect

previewRect: IgRect

refreshCompleted

refreshCompleted: object

resizeIdle

resizeIdle: object

resizeIdleMilliseconds

resizeIdleMilliseconds: number

rightButtonDefaultInteraction

rightButtonDefaultInteraction: InteractionState

rightMargin

rightMargin: number

scrollbarsAnimationDuration

scrollbarsAnimationDuration: number

selectedSeriesItems

selectedSeriesItems: IgrChartSelectedItemCollection

selectedSeriesItemsChanged

selectedSeriesItemsChanged: object

selectionBehavior

selectionBehavior: SeriesSelectionBehavior

selectionBrush

selectionBrush: string

selectionDismissDelayMilliseconds

selectionDismissDelayMilliseconds: number

selectionMode

selectionMode: SeriesSelectionMode

selectionModifier

selectionModifier: ModifierKeys

selectionTransitionDuration

selectionTransitionDuration: number

seriesClick

seriesClick: object

seriesCursorMouseMove

seriesCursorMouseMove: object

seriesMouseEnter

seriesMouseEnter: object

seriesMouseLeave

seriesMouseLeave: object

seriesMouseLeftButtonDown

seriesMouseLeftButtonDown: object

seriesMouseLeftButtonUp

seriesMouseLeftButtonUp: object

seriesMouseMove

seriesMouseMove: object

seriesValueLayerUseLegend

seriesValueLayerUseLegend: boolean

shouldMatchZOrderToSeriesOrder

shouldMatchZOrderToSeriesOrder: boolean

shouldPanOnMaximumZoom

shouldPanOnMaximumZoom: boolean

shouldSimulateHoverMoveCrosshairPoint

shouldSimulateHoverMoveCrosshairPoint: boolean

sizeChanged

sizeChanged: object

subtitle

subtitle: string

subtitleBottomMargin

subtitleBottomMargin: number

subtitleHorizontalAlignment

subtitleHorizontalAlignment: HorizontalAlignment

subtitleLeftMargin

subtitleLeftMargin: number

subtitleRightMargin

subtitleRightMargin: number

subtitleTextColor

subtitleTextColor: string

subtitleTextStyle

subtitleTextStyle: string

subtitleTopMargin

subtitleTopMargin: number

titleBottomMargin

titleBottomMargin: number

titleHorizontalAlignment

titleHorizontalAlignment: HorizontalAlignment

titleLeftMargin

titleLeftMargin: number

titleRightMargin

titleRightMargin: number

titleTextColor

titleTextColor: string

titleTextStyle

titleTextStyle: string

titleTopMargin

titleTopMargin: number

topMargin

topMargin: number

userAnnotationInformationRequested

userAnnotationInformationRequested: object

userAnnotationToolTipContentUpdating

userAnnotationToolTipContentUpdating: object

useTiledZooming

useTiledZooming: boolean

verticalCrosshairBrush

verticalCrosshairBrush: string

verticalViewScrollbarCornerRadius

verticalViewScrollbarCornerRadius: number

verticalViewScrollbarFill

verticalViewScrollbarFill: string

verticalViewScrollbarInset

verticalViewScrollbarInset: number

verticalViewScrollbarMaxOpacity

verticalViewScrollbarMaxOpacity: number

verticalViewScrollbarMode

verticalViewScrollbarMode: SeriesViewerScrollbarMode

verticalViewScrollbarOutline

verticalViewScrollbarOutline: string

verticalViewScrollbarPosition

verticalViewScrollbarPosition: SeriesViewerVerticalScrollbarPosition

verticalViewScrollbarShouldAddAutoTrackInsets

verticalViewScrollbarShouldAddAutoTrackInsets: boolean

verticalViewScrollbarStrokeThickness

verticalViewScrollbarStrokeThickness: number

verticalViewScrollbarTrackEndInset

verticalViewScrollbarTrackEndInset: number

verticalViewScrollbarTrackStartInset

verticalViewScrollbarTrackStartInset: number

verticalViewScrollbarWidth

verticalViewScrollbarWidth: number

viewerManipulationEnding

viewerManipulationEnding: object

viewerManipulationStarting

viewerManipulationStarting: object

windowPositionHorizontal

windowPositionHorizontal: number

windowPositionVertical

windowPositionVertical: number

windowRect

windowRect: IgRect

windowRectChanged

windowRectChanged: object

windowRectMinHeight

windowRectMinHeight: number

windowRectMinWidth

windowRectMinWidth: number

windowResponse

windowResponse: WindowResponse

windowSizeMinHeight

windowSizeMinHeight: number

windowSizeMinWidth

windowSizeMinWidth: number

zoomCoercionMode

zoomCoercionMode: ZoomCoercionMode

zoomTileCacheSize

zoomTileCacheSize: number

Accessors

contentViewport

Represents the subset area within the viewport into which content should be mapped. This is the projection of the current EffectiveViewport into the viewport at current zoom level.

get contentViewport(): IgRect

Returns IgRect

isDetached

get isDetached(): boolean

Returns boolean

isInCreateAnnotationMode

get isInCreateAnnotationMode(): boolean

Returns boolean

isInDeleteAnnotationMode

get isInDeleteAnnotationMode(): boolean

Returns boolean

isMap

Indicates if this SeriesViewer is a map.

get isMap(): boolean

Returns boolean

nativeElement

get nativeElement(): HTMLElement

Returns HTMLElement

viewportRect

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

get viewportRect(): IgRect

Returns IgRect

Methods

addCommandAvailabilityListener

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

attachSeries

Attaches the given series to the chart.

attachSeries(s: IgrSeries): void

Parameters

s: IgrSeries
- The series to attach to the chart.

Returns void

cancelAnnotationFlow

cancelAnnotationFlow(annotationFlowID: string): void

Parameters

annotationFlowID: string

Returns void

cancelCreatingAnnotation

cancelCreatingAnnotation(): void

Returns void

cancelDeletingAnnotation

cancelDeletingAnnotation(): void

Returns void

cancelManipulation

cancelManipulation(): void

Returns void

captureImage

captureImage(settings: IgrCaptureImageSettings): void

Parameters

settings: IgrCaptureImageSettings

Returns void

clearTileZoomCache

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

clearTileZoomCache(): void

Returns void

componentDidMount

componentDidMount(): void

Returns void

destroy

Release any resources held by the control.

destroy(): void

Returns void

endTiledZoomingIfRunning

Manually ends a tiled zoom if one is running.

endTiledZoomingIfRunning(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

finishAnnotationFlow

finishAnnotationFlow(info: IgrUserAnnotationInformation): void

Parameters

info: IgrUserAnnotationInformation

Returns void

finishCreatingAnnotation

finishCreatingAnnotation(): void

Returns void

finishDeletingAnnotation

finishDeletingAnnotation(): void

Returns void

flush

Use to force the SeriesViewer to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the SeriesViewer needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the SeriesViewer.

flush(): void

Returns void

getActualWindowScaleHorizontal

Gets actual window scale for horizontal dimension of the control

getActualWindowScaleHorizontal(): number

Returns number

getActualWindowScaleVertical

Gets actual window scale for vertical dimension of the control

getActualWindowScaleVertical(): number

Returns number

getAnimationIdleVersionNumber

getAnimationIdleVersionNumber(): number

Returns number

getCurrentActualWindowRect

getCurrentActualWindowRect(): IgRect

Returns IgRect

getDesiredToolbarActions

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

hideToolTip

Hides the active main tooltip, if displayed.

hideToolTip(): void

Returns void

isAnimationActive

isAnimationActive(): boolean

Returns boolean

loadAnnotationsFromJson

loadAnnotationsFromJson(jsonString: string): void

Parameters

jsonString: string

Returns void

notifyClearItems

Used to manually notify the SeriesViewer that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable.

notifyClearItems(source_: any): void

Parameters

source_: any
- The data source which was cleared or reset.
```
this.chart.notifyClearItems(this.data);
```

Returns void

notifyContainerResized

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

notifyContainerResized(): void

Returns void

notifyInsertItem

notifyInsertItem(source_: any, index: number, newItem: any): void

Parameters

source_: any
index: number
newItem: any

Returns void

notifyRemoveItem

notifyRemoveItem(source_: any, index: number, oldItem: any): void

Parameters

source_: any
index: number
oldItem: any

Returns void

notifySeriesDataChanged

notifySeriesDataChanged(): void

Returns void

notifySetItem

notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void

Parameters

source_: any
index: number
oldItem: any
newItem: any

Returns void

queueForAnimationIdle

queueForAnimationIdle(action: object, version: number): void

Parameters

action: object
version: number

Returns void

removeCommandAvailabilityListener

removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener

removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

render

render(): any

Returns any

renderToImage

renderToImage(width: number, height: number): any

Parameters

width: number
height: number

Returns any

resetAnnotations

resetAnnotations(): void

Returns void

resetZoom

Resets the zoom level to default.

resetZoom(): void

Returns void

saveAnnotationsToJson

saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

nextProps: any
nextState: any

Returns boolean

simulateClick

simulateClick(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulateHover

simulateHover(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulateMouseLeave

simulateMouseLeave(): void

Returns void

simulatePlotPointerUp

simulatePlotPointerUp(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulatePressAndHold

simulatePressAndHold(point: IgPoint): void

Parameters

point: IgPoint

Returns void

startCreatingAnnotation

startCreatingAnnotation(): void

Returns void

startDeletingAnnotation

startDeletingAnnotation(): void

Returns void

startTiledZoomingIfNecessary

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

startTiledZoomingIfNecessary(): void

Returns void

zoomIn

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

zoomIn(percentage: number): void

Parameters

percentage: number

Returns void

zoomOut

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

zoomOut(percentage: number): void

Parameters

percentage: number

Returns void

_createFromInternal

_createFromInternal(internal: any): IgrSeriesViewer

Parameters

internal: any