IgrScatterLineSeries

Represents a DataChartComponent scatter line series

Constructors

new IgrScatterLineSeries(props: IIgrScatterLineSeriesProps): IgrScatterLineSeries

Returns IgrScatterLineSeries

Properties

actualAreaFillOpacity

Inherited from: IgrScatterBase

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrScatterBase

actualBrush: string

actualFocusBrush

Inherited from: IgrScatterBase

actualFocusBrush: string

actualFocusMode

Inherited from: IgrScatterBase

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrScatterBase

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrScatterBase

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrScatterBase

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrScatterBase

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

Inherited from: IgrScatterBase

actualItemSearchMode: ScatterItemSearchMode

actualLayers

Inherited from: IgrScatterBase

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrScatterBase

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrScatterBase

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrScatterBase

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgrScatterBase

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgrScatterBase

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgrScatterBase

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgrScatterBase

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgrScatterBase

actualMarkerType: MarkerType

actualOutline

Inherited from: IgrScatterBase

actualOutline: string

actualResolution

Inherited from: IgrScatterBase

actualResolution: number

actualSelectionBrush

Inherited from: IgrScatterBase

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrScatterBase

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrScatterBase

actualThickness: number

actualTrendLineBrush

Inherited from: IgrScatterBase

actualTrendLineBrush: string

areaFillOpacity

Inherited from: IgrScatterBase

areaFillOpacity: number

assigningScatterMarkerStyle

Inherited from: IgrScatterBase

assigningScatterMarkerStyle: object

assigningScatterStyle

Inherited from: IgrScatterBase

assigningScatterStyle: object

attachTooltipToRoot

Inherited from: IgrScatterBase

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrScatterBase

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrScatterBase

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgrScatterBase

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrScatterBase

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrScatterBase

brush: string

coercionMethods

Inherited from: IgrScatterBase

coercionMethods: any

dashArray

Inherited from: IgrScatterBase

dashArray: number[]

dataLegendGroup

Inherited from: IgrScatterBase

dataLegendGroup: string

dataSource

Inherited from: IgrScatterBase

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrScatterBase

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrScatterBase

expectFunctions: boolean

finalValue

Inherited from: IgrScatterBase

finalValue: number

focusBrush

Inherited from: IgrScatterBase

focusBrush: string

highlightedDataSource

Inherited from: IgrScatterBase

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrScatterBase

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgrScatterBase

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgrScatterBase

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrScatterBase

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrScatterBase

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrScatterBase

highlightedValuesFadeOpacity: number

highlightedXMemberPath

Inherited from: IgrScatterBase

highlightedXMemberPath: string

highlightedYMemberPath

Inherited from: IgrScatterBase

highlightedYMemberPath: string

highlightingFadeOpacity

Inherited from: IgrScatterBase

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrScatterBase

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrScatterBase

index: number

isActualLegendFinancial

Inherited from: IgrScatterBase

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrScatterBase

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgrScatterBase

isCustomMarkerCircular: boolean

isCustomScatterMarkerStyleAllowed

Inherited from: IgrScatterBase

isCustomScatterMarkerStyleAllowed: boolean

isCustomScatterStyleAllowed

Inherited from: IgrScatterBase

isCustomScatterStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgrScatterBase

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrScatterBase

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrScatterBase

isHighlightingEnabled: boolean

itemSearchMode

Inherited from: IgrScatterBase

itemSearchMode: ScatterItemSearchMode

itemSearchThreshold

Inherited from: IgrScatterBase

itemSearchThreshold: number

layers

Inherited from: IgrScatterBase

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrScatterBase

legend: any

legendItemBadgeMode

Inherited from: IgrScatterBase

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrScatterBase

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrScatterBase

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrScatterBase

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrScatterBase

legendItemVisibility: Visibility

lineCap

Inherited from: IgrScatterBase

lineCap: PenLineCap

lineJoin

Inherited from: IgrScatterBase

lineJoin: PenLineJoin

markerBrush

Inherited from: IgrScatterBase

markerBrush: string

markerCollisionAvoidance

Inherited from: IgrScatterBase

markerCollisionAvoidance: CollisionAvoidanceType

markerFillMode

Inherited from: IgrScatterBase

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgrScatterBase

markerFillOpacity: number

markerOutline

Inherited from: IgrScatterBase

markerOutline: string

markerOutlineMode

Inherited from: IgrScatterBase

markerOutlineMode: MarkerOutlineMode

markerTemplate

Inherited from: IgrScatterBase

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgrScatterBase

markerThickness: number

markerType

Inherited from: IgrScatterBase

markerType: MarkerType

maximumMarkers

Inherited from: IgrScatterBase

maximumMarkers: number

mouseOverEnabled

Inherited from: IgrScatterBase

mouseOverEnabled: boolean

name

Inherited from: IgrScatterBase

name: string

opacity

Inherited from: IgrScatterBase

opacity: number

outline

Inherited from: IgrScatterBase

outline: string

outlineMode

Inherited from: IgrScatterBase

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrScatterBase

percentChange: number

renderRequested

Inherited from: IgrScatterBase

renderRequested: object

resolution

Inherited from: IgrScatterBase

resolution: number

safeActualBrush

Inherited from: IgrScatterBase

safeActualBrush: string

selectionBrush

Inherited from: IgrScatterBase

selectionBrush: string

selectionThickness

Inherited from: IgrScatterBase

selectionThickness: number

shadowBlur

Inherited from: IgrScatterBase

shadowBlur: number

shadowColor

Inherited from: IgrScatterBase

shadowColor: string

shadowOffsetX

Inherited from: IgrScatterBase

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrScatterBase

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrScatterBase

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrScatterBase

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrScatterBase

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrScatterBase

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrScatterBase

showDefaultTooltip: boolean

thickness

Inherited from: IgrScatterBase

thickness: number

title

Inherited from: IgrScatterBase

title: any

tooltipContainerTemplate

Inherited from: IgrScatterBase

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrScatterBase

tooltipTemplate: any

transitionDuration

Inherited from: IgrScatterBase

transitionDuration: number

transitionEasingFunction

Inherited from: IgrScatterBase

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrScatterBase

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrScatterBase

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrScatterBase

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrScatterBase

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrScatterBase

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrScatterBase

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrScatterBase

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

Inherited from: IgrScatterBase

trendLineBrush: string

trendLineDashArray

Inherited from: IgrScatterBase

trendLineDashArray: number[]

trendLinePeriod

Inherited from: IgrScatterBase

trendLinePeriod: number

trendLineThickness

Inherited from: IgrScatterBase

trendLineThickness: number

trendLineType

Inherited from: IgrScatterBase

trendLineType: TrendLineType

trendLineZIndex

Inherited from: IgrScatterBase

trendLineZIndex: number

unknownValuePlotting

unknownValuePlotting: UnknownValuePlotting

useItemWiseColors

Inherited from: IgrScatterBase

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrScatterBase

useSingleShadow: boolean

visibility

Inherited from: IgrScatterBase

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrScatterBase

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrScatterBase

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrScatterBase

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrScatterBase

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrScatterBase

visibleRangeMode: SeriesVisibleRangeMode

xAxis

Inherited from: IgrScatterBase

xAxis: IgrNumericXAxis

xAxisName

Inherited from: IgrScatterBase

xAxisName: string

xMemberAsLegendLabel

Inherited from: IgrScatterBase

xMemberAsLegendLabel: string

xMemberAsLegendUnit

Inherited from: IgrScatterBase

xMemberAsLegendUnit: string

xMemberPath

Inherited from: IgrScatterBase

xMemberPath: string

yAxis

Inherited from: IgrScatterBase

yAxis: IgrNumericYAxis

yAxisName

Inherited from: IgrScatterBase

yAxisName: string

yMemberAsLegendLabel

Inherited from: IgrScatterBase

yMemberAsLegendLabel: string

yMemberAsLegendUnit

Inherited from: IgrScatterBase

yMemberAsLegendUnit: string

yMemberPath

Inherited from: IgrScatterBase

yMemberPath: string

Accessors

actualCloseLabel

Inherited from: IgrScatterBase

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrScatterBase

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrScatterBase

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrScatterBase

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrScatterBase

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrScatterBase

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrScatterBase

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrScatterBase

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgrScatterBase

Gets whether the markers for the current series are in circular shape

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgrScatterBase

Returns whether the current series supports visual markers.

HasMarkers property is overriden, it returns whether the current series supports visual markers. You can use it like this:

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgrScatterBase

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrScatterBase

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrScatterBase

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrScatterBase

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrScatterBase

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrScatterBase

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrScatterBase

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

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrScatterBase

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrScatterBase

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrScatterBase

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrScatterBase

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrScatterBase

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrScatterBase

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrScatterBase

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrScatterBase

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

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrScatterBase

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrScatterBase

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrScatterBase

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrScatterBase

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrScatterBase

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrScatterBase

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrScatterBase

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrScatterBase

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrScatterBase

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

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrScatterBase

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrScatterBase

Overridden by derived series classes to indicate when markerless display is preferred or not.

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrScatterBase

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrScatterBase

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrScatterBase

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrScatterBase

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrScatterBase

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrScatterBase

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrScatterBase

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrScatterBase

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrScatterBase

Checks if this series is a scatter series

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrScatterBase

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrScatterBase

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrScatterBase

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrScatterBase

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrScatterBase

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrScatterBase

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrScatterBase

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrScatterBase

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrScatterBase

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrScatterBase

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrScatterBase

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrScatterBase

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrScatterBase

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrScatterBase

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrScatterBase

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrScatterBase

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrScatterBase

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrScatterBase

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

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsXAxis

Inherited from: IgrScatterBase

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsYAxis

Inherited from: IgrScatterBase

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrScatterBase

componentDidMount(): void

Returns void

findByName

Inherited from: IgrScatterBase

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrScatterBase

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

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrScatterBase

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

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

Gets the index of the item that resides at the provided world coordinates.

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint
- The world coordinates of the requested item.

Returns number

getItemSpan

Inherited from: IgrScatterBase

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

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrScatterBase

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgrScatterBase

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrScatterBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrScatterBase

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrScatterBase

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrScatterBase

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrScatterBase

Gets the numeric values from the X and Y axis associated with this scatter series that matches the desired value mode.

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

Parameters

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

Returns number[]

getSeriesValueTypePosition

Inherited from: IgrScatterBase

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrScatterBase

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrScatterBase

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrScatterBase

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrScatterBase

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrScatterBase

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrScatterBase

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrScatterBase

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrScatterBase

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrScatterBase

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrScatterBase

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrScatterBase

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrScatterBase

render(): any

Returns any

renderSeries

Inherited from: IgrScatterBase

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrScatterBase

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrScatterBase

Scrolls the series to display the item for the specified data item. The series is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.

scrollIntoView(item: any): boolean

Parameters

item: any
- The data item (item) to scroll to.

Returns boolean

setNegativeColors

Inherited from: IgrScatterBase

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrScatterBase

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrScatterBase

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrScatterBase

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

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

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any