IgrScatterPolylineSeries

Series class used for displaying multiple polylines for datasources which contain multiple lists of points.

Constructors

new IgrScatterPolylineSeries(props: IIgrScatterPolylineSeriesProps): IgrScatterPolylineSeries

Returns IgrScatterPolylineSeries

Properties

actualAreaFillOpacity

Inherited from: IgrShapeSeriesBase

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrShapeSeriesBase

actualBrush: string

actualFocusBrush

Inherited from: IgrShapeSeriesBase

actualFocusBrush: string

actualFocusMode

Inherited from: IgrShapeSeriesBase

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrShapeSeriesBase

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrShapeSeriesBase

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrShapeSeriesBase

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrShapeSeriesBase

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

Inherited from: IgrShapeSeriesBase

actualItemSearchMode: ShapeItemSearchMode

actualLayers

Inherited from: IgrShapeSeriesBase

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrShapeSeriesBase

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrShapeSeriesBase

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrShapeSeriesBase

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Inherited from: IgrShapeSeriesBase

actualMarkerFillOpacity: number

actualOutline

Inherited from: IgrShapeSeriesBase

actualOutline: string

actualResolution

Inherited from: IgrShapeSeriesBase

actualResolution: number

actualSelectionBrush

Inherited from: IgrShapeSeriesBase

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrShapeSeriesBase

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrShapeSeriesBase

actualThickness: number

areaFillOpacity

Inherited from: IgrShapeSeriesBase

areaFillOpacity: number

assigningShapeMarkerStyle

Inherited from: IgrShapeSeriesBase

assigningShapeMarkerStyle: object

assigningShapeStyle

Inherited from: IgrShapeSeriesBase

assigningShapeStyle: object

attachTooltipToRoot

Inherited from: IgrShapeSeriesBase

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrShapeSeriesBase

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrShapeSeriesBase

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgrShapeSeriesBase

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrShapeSeriesBase

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrShapeSeriesBase

brush: string

coercionMethods

Inherited from: IgrShapeSeriesBase

coercionMethods: any

dashArray

Inherited from: IgrShapeSeriesBase

dashArray: number[]

dataLegendGroup

Inherited from: IgrShapeSeriesBase

dataLegendGroup: string

dataSource

Inherited from: IgrShapeSeriesBase

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrShapeSeriesBase

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrShapeSeriesBase

expectFunctions: boolean

fillMemberPath

Inherited from: IgrShapeSeriesBase

fillMemberPath: string

fillScale

Inherited from: IgrShapeSeriesBase

fillScale: IgrBrushScale

fillScaleUseGlobalValues

Inherited from: IgrShapeSeriesBase

fillScaleUseGlobalValues: boolean

finalValue

Inherited from: IgrShapeSeriesBase

finalValue: number

focusBrush

Inherited from: IgrShapeSeriesBase

focusBrush: string

highlightedDataSource

Inherited from: IgrShapeSeriesBase

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrShapeSeriesBase

highlightedLegendItemVisibility: Visibility

highlightedShapeMemberPath

Inherited from: IgrShapeSeriesBase

highlightedShapeMemberPath: string

highlightedTitleSuffix

Inherited from: IgrShapeSeriesBase

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgrShapeSeriesBase

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrShapeSeriesBase

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrShapeSeriesBase

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrShapeSeriesBase

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgrShapeSeriesBase

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrShapeSeriesBase

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrShapeSeriesBase

index: number

isActualLegendFinancial

Inherited from: IgrShapeSeriesBase

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrShapeSeriesBase

isComponentHighlightingModeIgnored: boolean

isCustomShapeMarkerStyleAllowed

Inherited from: IgrShapeSeriesBase

isCustomShapeMarkerStyleAllowed: boolean

isCustomShapeStyleAllowed

Inherited from: IgrShapeSeriesBase

isCustomShapeStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgrShapeSeriesBase

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrShapeSeriesBase

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrShapeSeriesBase

isHighlightingEnabled: boolean

itemSearchMode

Inherited from: IgrShapeSeriesBase

itemSearchMode: ShapeItemSearchMode

itemSearchPointsThreshold

Inherited from: IgrShapeSeriesBase

itemSearchPointsThreshold: number

itemSearchThreshold

Inherited from: IgrShapeSeriesBase

itemSearchThreshold: number

layers

Inherited from: IgrShapeSeriesBase

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrShapeSeriesBase

legend: any

legendItemBadgeMode

Inherited from: IgrShapeSeriesBase

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrShapeSeriesBase

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrShapeSeriesBase

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrShapeSeriesBase

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrShapeSeriesBase

legendItemVisibility: Visibility

lineCap

Inherited from: IgrShapeSeriesBase

lineCap: PenLineCap

lineJoin

Inherited from: IgrShapeSeriesBase

lineJoin: PenLineJoin

markerFillOpacity

Inherited from: IgrShapeSeriesBase

markerFillOpacity: number

mouseOverEnabled

Inherited from: IgrShapeSeriesBase

mouseOverEnabled: boolean

name

Inherited from: IgrShapeSeriesBase

name: string

opacity

Inherited from: IgrShapeSeriesBase

opacity: number

outline

Inherited from: IgrShapeSeriesBase

outline: string

outlineMode

Inherited from: IgrShapeSeriesBase

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrShapeSeriesBase

percentChange: number

renderRequested

Inherited from: IgrShapeSeriesBase

renderRequested: object

resolution

Inherited from: IgrShapeSeriesBase

resolution: number

safeActualBrush

Inherited from: IgrShapeSeriesBase

safeActualBrush: string

selectionBrush

Inherited from: IgrShapeSeriesBase

selectionBrush: string

selectionThickness

Inherited from: IgrShapeSeriesBase

selectionThickness: number

shadowBlur

Inherited from: IgrShapeSeriesBase

shadowBlur: number

shadowColor

Inherited from: IgrShapeSeriesBase

shadowColor: string

shadowOffsetX

Inherited from: IgrShapeSeriesBase

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrShapeSeriesBase

shadowOffsetY: number

shapeFilterResolution

Inherited from: IgrShapeSeriesBase

shapeFilterResolution: number

shapeMemberPath

Inherited from: IgrShapeSeriesBase

shapeMemberPath: string

shapeStyle

shapeStyle: IgrStyle

shouldAnimateOnDataSourceSwap

Inherited from: IgrShapeSeriesBase

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrShapeSeriesBase

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrShapeSeriesBase

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrShapeSeriesBase

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrShapeSeriesBase

showDefaultTooltip: boolean

styleShape

Inherited from: IgrShapeSeriesBase

styleShape: object

thickness

Inherited from: IgrShapeSeriesBase

thickness: number

title

Inherited from: IgrShapeSeriesBase

title: any

tooltipContainerTemplate

Inherited from: IgrShapeSeriesBase

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrShapeSeriesBase

tooltipTemplate: any

transitionDuration

Inherited from: IgrShapeSeriesBase

transitionDuration: number

transitionEasingFunction

Inherited from: IgrShapeSeriesBase

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrShapeSeriesBase

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrShapeSeriesBase

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrShapeSeriesBase

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrShapeSeriesBase

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrShapeSeriesBase

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrShapeSeriesBase

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrShapeSeriesBase

transitionOutSpeedType: TransitionOutSpeedType

useItemWiseColors

Inherited from: IgrShapeSeriesBase

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrShapeSeriesBase

useSingleShadow: boolean

visibility

Inherited from: IgrShapeSeriesBase

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrShapeSeriesBase

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrShapeSeriesBase

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrShapeSeriesBase

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrShapeSeriesBase

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrShapeSeriesBase

visibleRangeMode: SeriesVisibleRangeMode

xAxis

Inherited from: IgrShapeSeriesBase

xAxis: IgrNumericXAxis

xAxisName

Inherited from: IgrShapeSeriesBase

xAxisName: string

yAxis

Inherited from: IgrShapeSeriesBase

yAxis: IgrNumericYAxis

yAxisName

Inherited from: IgrShapeSeriesBase

yAxisName: string

Accessors

actualCloseLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Close label in the tooltip.

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the High label in the tooltip.

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Low label in the tooltip.

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Open label in the tooltip.

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Value label in the tooltip.

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Value label in the tooltip.

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrShapeSeriesBase

Gets the text that is displayed for the Volume label in the tooltip.

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrShapeSeriesBase

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Inherited from: IgrShapeSeriesBase

Returns whether the current series supports visual markers.

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgrShapeSeriesBase

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrShapeSeriesBase

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is a data annotation layer that support binding to data source DataAnnotationShapeLayer, DataAnnotationSliceLayer, DataAnnotationStripLayer

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgrShapeSeriesBase

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

get isAnnotationHoverLayer(): boolean

Returns boolean

isAnnotationLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows an area or line shape.

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrShapeSeriesBase

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrShapeSeriesBase

Gets whether the default crosshair behavior should be disabled if this series is present.

IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Inherited from: IgrShapeSeriesBase

Gets whether the default tooltip behavior should be disabled if this series is present.

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrShapeSeriesBase

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrShapeSeriesBase

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrShapeSeriesBase

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrShapeSeriesBase

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrShapeSeriesBase

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrShapeSeriesBase

Gets if the series uses an index, which can be used to auto-assign it a color.

get isIndexed(): boolean

Returns boolean

isLayer

Inherited from: IgrShapeSeriesBase

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrShapeSeriesBase

Overridden by derived series classes to indicate when marker-less display is preferred or not.

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrShapeSeriesBase

Overridden by derived series classes to indicate when negative colors are supported or not.

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrShapeSeriesBase

Gets whether or not this series is a shape series

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrShapeSeriesBase

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrShapeSeriesBase

Gets whether the series supports summarization in Data Legend and Data Tooltip.

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrShapeSeriesBase

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrShapeSeriesBase

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrShapeSeriesBase

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrShapeSeriesBase

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrShapeSeriesBase

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrShapeSeriesBase

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrShapeSeriesBase

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrShapeSeriesBase

bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsXAxis

Inherited from: IgrShapeSeriesBase

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsYAxis

Inherited from: IgrShapeSeriesBase

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrShapeSeriesBase

componentDidMount(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrShapeSeriesBase

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

fromWorldPosition(world: IgPoint): IgPoint

Parameters

world: IgPoint
- The world position from which to convert.

Returns IgPoint

getEffectiveViewport

Inherited from: IgrShapeSeriesBase

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrShapeSeriesBase

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.

getExactItemIndex(world: IgPoint): number

Parameters

world: IgPoint

The world position for which to return the index.

let index: number = this.series.getExactItemIndex({x:.5,y:.5});

Returns number

getItem

Inherited from: IgrShapeSeriesBase

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

getItem(world: IgPoint): any

Parameters

world: IgPoint
- The world coordinates to use.

Returns any

getItemIndex

Inherited from: IgrShapeSeriesBase

Gets the item index associated with the specified world position

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

Inherited from: IgrShapeSeriesBase

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.

getItemSpan(): number

Returns number

getItemValue

Inherited from: IgrShapeSeriesBase

getItemValue(item: any, memberPathName: string): any

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrShapeSeriesBase

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgrShapeSeriesBase

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

getMemberPathValue(memberPathName: string): string

Parameters

memberPathName: string
- The property name of a valid member path for the series

Returns string

getNextOrExactIndex

Inherited from: IgrShapeSeriesBase

getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrShapeSeriesBase

getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrShapeSeriesBase

getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrShapeSeriesBase

getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrShapeSeriesBase

getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrShapeSeriesBase

getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrShapeSeriesBase

getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrShapeSeriesBase

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

getSeriesValueBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinate for which to get a value bounding box for

Returns IgRect

getSeriesValueFromSeriesPixel

Inherited from: IgrShapeSeriesBase

getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrShapeSeriesBase

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.

getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinates for which to get a value marker bounding box for

Returns IgRect

getSeriesValuePosition

Inherited from: IgrShapeSeriesBase

getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrShapeSeriesBase

getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrShapeSeriesBase

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.

getSeriesValueType(mode: string | ValueLayerValueMode): number[]

Parameters

mode: string | ValueLayerValueMode
- The type of value desired from the series axes.

Returns number[]

getSeriesValueTypePosition

Inherited from: IgrShapeSeriesBase

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrShapeSeriesBase

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrShapeSeriesBase

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

getUnscaledPosition(pos: IgPoint): IgPoint

Parameters

pos: IgPoint
- The viewport relative position

Returns IgPoint

hideToolTips

Inherited from: IgrShapeSeriesBase

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrShapeSeriesBase

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrShapeSeriesBase

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

moveCursorPoint(point: IgPoint): void

Parameters

point: IgPoint
- The cursor point, in world coordinates.
MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.
```
this.crosshair.moveCursorPoint({x:.5,y:.5});
```

Returns void

notifyIndexedPropertiesChanged

Inherited from: IgrShapeSeriesBase

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgrShapeSeriesBase

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrShapeSeriesBase

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrShapeSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrShapeSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrShapeSeriesBase

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrShapeSeriesBase

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrShapeSeriesBase

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrShapeSeriesBase

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

viewIdentifier: string
- The string identifier for the view to remove.

Returns void

removeAxes

Inherited from: IgrShapeSeriesBase

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrShapeSeriesBase

render(): any

Returns any

renderSeries

Inherited from: IgrShapeSeriesBase

Renders the series.

renderSeries(animate: boolean): void

Parameters

animate: boolean
- True if the change should be animated.
```
this.series.renderSeries(true);
```

Returns void

replayTransitionIn

Inherited from: IgrShapeSeriesBase

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrShapeSeriesBase

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrShapeSeriesBase

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

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to attempt to bring into view.
```
this.series.scrollIntoView(dataItem);
```

Returns boolean

setNegativeColors

Inherited from: IgrShapeSeriesBase

setNegativeColors(negativeBrush: string, negativeOutline: string): void

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrShapeSeriesBase

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrShapeSeriesBase

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

point: IgPoint
- The pointer position relative to the series viewport over which to hover.
When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.
```
this.series.simulateHover({x:250,y:250});
```

Returns void

styleUpdated

Inherited from: IgrShapeSeriesBase

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrShapeSeriesBase

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

toWorldPosition(seriesPoint: IgPoint): IgPoint

Parameters

seriesPoint: IgPoint
- The pixel location within the plot area of the series.
```
this.series.toWorldPosition({x:500,y:500});
```

Returns IgPoint

toWorldRect

Inherited from: IgrShapeSeriesBase

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

toWorldRect(rect: IgRect): IgRect

Parameters

rect: IgRect
- The pixel rect within the plot area of the series.

Returns IgRect

_createFromInternal

Inherited from: IgrShapeSeriesBase

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any