IgrScatterContourSeries

Series class for rendering isarithmic contours based on a triangulation of X+Y+Value points in the ItemsSource.

Constructors

new IgrScatterContourSeries(props: IIgrScatterContourSeriesProps): IgrScatterContourSeries

Returns IgrScatterContourSeries

Properties

actualAreaFillOpacity

Inherited from: IgrScatterTriangulationSeries

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrScatterTriangulationSeries

actualBrush: string

actualFillScale

actualFillScale: IgrValueBrushScale

actualFocusBrush

Inherited from: IgrScatterTriangulationSeries

actualFocusBrush: string

actualFocusMode

Inherited from: IgrScatterTriangulationSeries

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrScatterTriangulationSeries

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrScatterTriangulationSeries

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrScatterTriangulationSeries

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrScatterTriangulationSeries

actualHitTestMode: SeriesHitTestMode

actualLayers

Inherited from: IgrScatterTriangulationSeries

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrScatterTriangulationSeries

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrScatterTriangulationSeries

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrScatterTriangulationSeries

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Inherited from: IgrScatterTriangulationSeries

actualMarkerFillOpacity: number

actualOutline

Inherited from: IgrScatterTriangulationSeries

actualOutline: string

actualResolution

Inherited from: IgrScatterTriangulationSeries

actualResolution: number

actualSelectionBrush

Inherited from: IgrScatterTriangulationSeries

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrScatterTriangulationSeries

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrScatterTriangulationSeries

actualThickness: number

areaFillOpacity

Inherited from: IgrScatterTriangulationSeries

areaFillOpacity: number

attachTooltipToRoot

Inherited from: IgrScatterTriangulationSeries

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrScatterTriangulationSeries

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrScatterTriangulationSeries

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgrScatterTriangulationSeries

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrScatterTriangulationSeries

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrScatterTriangulationSeries

brush: string

coercionMethods

Inherited from: IgrScatterTriangulationSeries

coercionMethods: any

dashArray

Inherited from: IgrScatterTriangulationSeries

dashArray: number[]

dataLegendGroup

Inherited from: IgrScatterTriangulationSeries

dataLegendGroup: string

dataSource

Inherited from: IgrScatterTriangulationSeries

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrScatterTriangulationSeries

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrScatterTriangulationSeries

expectFunctions: boolean

fillScale

fillScale: IgrValueBrushScale

finalValue

Inherited from: IgrScatterTriangulationSeries

finalValue: number

focusBrush

Inherited from: IgrScatterTriangulationSeries

focusBrush: string

highlightedDataSource

Inherited from: IgrScatterTriangulationSeries

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrScatterTriangulationSeries

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgrScatterTriangulationSeries

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgrScatterTriangulationSeries

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrScatterTriangulationSeries

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrScatterTriangulationSeries

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrScatterTriangulationSeries

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgrScatterTriangulationSeries

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrScatterTriangulationSeries

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrScatterTriangulationSeries

index: number

isActualLegendFinancial

Inherited from: IgrScatterTriangulationSeries

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrScatterTriangulationSeries

isComponentHighlightingModeIgnored: boolean

isDefaultToolTipSelected

Inherited from: IgrScatterTriangulationSeries

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrScatterTriangulationSeries

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrScatterTriangulationSeries

isHighlightingEnabled: boolean

layers

Inherited from: IgrScatterTriangulationSeries

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrScatterTriangulationSeries

legend: any

legendItemBadgeMode

Inherited from: IgrScatterTriangulationSeries

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrScatterTriangulationSeries

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrScatterTriangulationSeries

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrScatterTriangulationSeries

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrScatterTriangulationSeries

legendItemVisibility: Visibility

lineCap

Inherited from: IgrScatterTriangulationSeries

lineCap: PenLineCap

lineJoin

Inherited from: IgrScatterTriangulationSeries

lineJoin: PenLineJoin

markerFillOpacity

Inherited from: IgrScatterTriangulationSeries

markerFillOpacity: number

mouseOverEnabled

Inherited from: IgrScatterTriangulationSeries

mouseOverEnabled: boolean

name

Inherited from: IgrScatterTriangulationSeries

name: string

opacity

Inherited from: IgrScatterTriangulationSeries

opacity: number

outline

Inherited from: IgrScatterTriangulationSeries

outline: string

outlineMode

Inherited from: IgrScatterTriangulationSeries

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrScatterTriangulationSeries

percentChange: number

renderRequested

Inherited from: IgrScatterTriangulationSeries

renderRequested: object

resolution

Inherited from: IgrScatterTriangulationSeries

resolution: number

safeActualBrush

Inherited from: IgrScatterTriangulationSeries

safeActualBrush: string

selectionBrush

Inherited from: IgrScatterTriangulationSeries

selectionBrush: string

selectionThickness

Inherited from: IgrScatterTriangulationSeries

selectionThickness: number

shadowBlur

Inherited from: IgrScatterTriangulationSeries

shadowBlur: number

shadowColor

Inherited from: IgrScatterTriangulationSeries

shadowColor: string

shadowOffsetX

Inherited from: IgrScatterTriangulationSeries

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrScatterTriangulationSeries

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrScatterTriangulationSeries

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrScatterTriangulationSeries

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrScatterTriangulationSeries

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrScatterTriangulationSeries

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrScatterTriangulationSeries

showDefaultTooltip: boolean

thickness

Inherited from: IgrScatterTriangulationSeries

thickness: number

title

Inherited from: IgrScatterTriangulationSeries

title: any

tooltipContainerTemplate

Inherited from: IgrScatterTriangulationSeries

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrScatterTriangulationSeries

tooltipTemplate: any

transitionDuration

Inherited from: IgrScatterTriangulationSeries

transitionDuration: number

transitionEasingFunction

Inherited from: IgrScatterTriangulationSeries

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrScatterTriangulationSeries

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrScatterTriangulationSeries

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrScatterTriangulationSeries

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrScatterTriangulationSeries

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrScatterTriangulationSeries

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrScatterTriangulationSeries

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrScatterTriangulationSeries

transitionOutSpeedType: TransitionOutSpeedType

trianglesSource

Inherited from: IgrScatterTriangulationSeries

trianglesSource: any[]

triangleVertexMemberPath1

Inherited from: IgrScatterTriangulationSeries

triangleVertexMemberPath1: string

triangleVertexMemberPath2

Inherited from: IgrScatterTriangulationSeries

triangleVertexMemberPath2: string

triangleVertexMemberPath3

Inherited from: IgrScatterTriangulationSeries

triangleVertexMemberPath3: string

triangulationStatusChanged

Inherited from: IgrScatterTriangulationSeries

triangulationStatusChanged: object

useItemWiseColors

Inherited from: IgrScatterTriangulationSeries

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrScatterTriangulationSeries

useSingleShadow: boolean

valueMemberAsLegendLabel

valueMemberAsLegendLabel: string

valueMemberAsLegendUnit

valueMemberAsLegendUnit: string

valueMemberPath

valueMemberPath: string

valueResolver

valueResolver: IgrContourValueResolver

visibility

Inherited from: IgrScatterTriangulationSeries

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrScatterTriangulationSeries

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrScatterTriangulationSeries

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrScatterTriangulationSeries

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrScatterTriangulationSeries

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrScatterTriangulationSeries

visibleRangeMode: SeriesVisibleRangeMode

xAxis

Inherited from: IgrScatterTriangulationSeries

xAxis: IgrNumericXAxis

xAxisName

Inherited from: IgrScatterTriangulationSeries

xAxisName: string

xMemberAsLegendLabel

Inherited from: IgrScatterTriangulationSeries

xMemberAsLegendLabel: string

xMemberAsLegendUnit

Inherited from: IgrScatterTriangulationSeries

xMemberAsLegendUnit: string

xMemberPath

Inherited from: IgrScatterTriangulationSeries

xMemberPath: string

yAxis

Inherited from: IgrScatterTriangulationSeries

yAxis: IgrNumericYAxis

yAxisName

Inherited from: IgrScatterTriangulationSeries

yAxisName: string

yMemberAsLegendLabel

Inherited from: IgrScatterTriangulationSeries

yMemberAsLegendLabel: string

yMemberAsLegendUnit

Inherited from: IgrScatterTriangulationSeries

yMemberAsLegendUnit: string

yMemberPath

Inherited from: IgrScatterTriangulationSeries

yMemberPath: string

Accessors

actualCloseLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrScatterTriangulationSeries

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrScatterTriangulationSeries

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Inherited from: IgrScatterTriangulationSeries

Returns whether the current series supports visual markers.

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgrScatterTriangulationSeries

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrScatterTriangulationSeries

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrScatterTriangulationSeries

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrScatterTriangulationSeries

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

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrScatterTriangulationSeries

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrScatterTriangulationSeries

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrScatterTriangulationSeries

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

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrScatterTriangulationSeries

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrScatterTriangulationSeries

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

get isLayer(): boolean

Returns boolean

isLineContour

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrScatterTriangulationSeries

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrScatterTriangulationSeries

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrScatterTriangulationSeries

Gets whether or not this series is a shape series

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrScatterTriangulationSeries

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrScatterTriangulationSeries

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrScatterTriangulationSeries

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrScatterTriangulationSeries

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrScatterTriangulationSeries

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrScatterTriangulationSeries

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrScatterTriangulationSeries

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

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsXAxis

Inherited from: IgrScatterTriangulationSeries

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsYAxis

Inherited from: IgrScatterTriangulationSeries

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrScatterTriangulationSeries

componentDidMount(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrScatterTriangulationSeries

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

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrScatterTriangulationSeries

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

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.

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

Returns any

getItemIndex

Inherited from: IgrScatterTriangulationSeries

Gets the item index associated with the specified world position

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

Inherited from: IgrScatterTriangulationSeries

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

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrScatterTriangulationSeries

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrScatterTriangulationSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrScatterTriangulationSeries

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrScatterTriangulationSeries

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrScatterTriangulationSeries

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrScatterTriangulationSeries

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrScatterTriangulationSeries

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrScatterTriangulationSeries

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrScatterTriangulationSeries

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrScatterTriangulationSeries

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrScatterTriangulationSeries

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrScatterTriangulationSeries

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrScatterTriangulationSeries

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrScatterTriangulationSeries

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrScatterTriangulationSeries

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrScatterTriangulationSeries

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrScatterTriangulationSeries

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrScatterTriangulationSeries

render(): any

Returns any

renderSeries

Inherited from: IgrScatterTriangulationSeries

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrScatterTriangulationSeries

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrScatterTriangulationSeries

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

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrScatterTriangulationSeries

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrScatterTriangulationSeries

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrScatterTriangulationSeries

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

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

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any