IgrScatterBase

Represents the base class for all DataChartComponent scatter series

Constructors

new IgrScatterBase(props: P): IgrScatterBase

Returns IgrScatterBase

Properties

actualAreaFillOpacity

Inherited from: IgrMarkerSeries

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrMarkerSeries

actualBrush: string

actualFocusBrush

Inherited from: IgrMarkerSeries

actualFocusBrush: string

actualFocusMode

Inherited from: IgrMarkerSeries

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrMarkerSeries

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrMarkerSeries

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrMarkerSeries

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrMarkerSeries

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

actualItemSearchMode: ScatterItemSearchMode

actualLayers

Inherited from: IgrMarkerSeries

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrMarkerSeries

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrMarkerSeries

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrMarkerSeries

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgrMarkerSeries

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgrMarkerSeries

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgrMarkerSeries

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgrMarkerSeries

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgrMarkerSeries

actualMarkerType: MarkerType

actualOutline

Inherited from: IgrMarkerSeries

actualOutline: string

actualResolution

Inherited from: IgrMarkerSeries

actualResolution: number

actualSelectionBrush

Inherited from: IgrMarkerSeries

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrMarkerSeries

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrMarkerSeries

actualThickness: number

actualTrendLineBrush

actualTrendLineBrush: string

areaFillOpacity

Inherited from: IgrMarkerSeries

areaFillOpacity: number

assigningScatterMarkerStyle

assigningScatterMarkerStyle: object

assigningScatterStyle

assigningScatterStyle: object

attachTooltipToRoot

Inherited from: IgrMarkerSeries

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrMarkerSeries

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrMarkerSeries

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgrMarkerSeries

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrMarkerSeries

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrMarkerSeries

brush: string

coercionMethods

Inherited from: IgrMarkerSeries

coercionMethods: any

dashArray

Inherited from: IgrMarkerSeries

dashArray: number[]

dataLegendGroup

Inherited from: IgrMarkerSeries

dataLegendGroup: string

dataSource

Inherited from: IgrMarkerSeries

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrMarkerSeries

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrMarkerSeries

expectFunctions: boolean

finalValue

Inherited from: IgrMarkerSeries

finalValue: number

focusBrush

Inherited from: IgrMarkerSeries

focusBrush: string

highlightedDataSource

Inherited from: IgrMarkerSeries

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrMarkerSeries

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgrMarkerSeries

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgrMarkerSeries

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrMarkerSeries

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrMarkerSeries

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrMarkerSeries

highlightedValuesFadeOpacity: number

highlightedXMemberPath

highlightedXMemberPath: string

highlightedYMemberPath

highlightedYMemberPath: string

highlightingFadeOpacity

Inherited from: IgrMarkerSeries

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrMarkerSeries

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrMarkerSeries

index: number

isActualLegendFinancial

Inherited from: IgrMarkerSeries

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrMarkerSeries

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgrMarkerSeries

isCustomMarkerCircular: boolean

isCustomScatterMarkerStyleAllowed

isCustomScatterMarkerStyleAllowed: boolean

isCustomScatterStyleAllowed

isCustomScatterStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgrMarkerSeries

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrMarkerSeries

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrMarkerSeries

isHighlightingEnabled: boolean

itemSearchMode

itemSearchMode: ScatterItemSearchMode

itemSearchThreshold

itemSearchThreshold: number

layers

Inherited from: IgrMarkerSeries

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrMarkerSeries

legend: any

legendItemBadgeMode

Inherited from: IgrMarkerSeries

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrMarkerSeries

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrMarkerSeries

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrMarkerSeries

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrMarkerSeries

legendItemVisibility: Visibility

lineCap

Inherited from: IgrMarkerSeries

lineCap: PenLineCap

lineJoin

Inherited from: IgrMarkerSeries

lineJoin: PenLineJoin

markerBrush

Inherited from: IgrMarkerSeries

markerBrush: string

markerCollisionAvoidance

markerCollisionAvoidance: CollisionAvoidanceType

markerFillMode

Inherited from: IgrMarkerSeries

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgrMarkerSeries

markerFillOpacity: number

markerOutline

Inherited from: IgrMarkerSeries

markerOutline: string

markerOutlineMode

Inherited from: IgrMarkerSeries

markerOutlineMode: MarkerOutlineMode

markerTemplate

Inherited from: IgrMarkerSeries

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgrMarkerSeries

markerThickness: number

markerType

Inherited from: IgrMarkerSeries

markerType: MarkerType

maximumMarkers

maximumMarkers: number

mouseOverEnabled

Inherited from: IgrMarkerSeries

mouseOverEnabled: boolean

name

Inherited from: IgrMarkerSeries

name: string

opacity

Inherited from: IgrMarkerSeries

opacity: number

outline

Inherited from: IgrMarkerSeries

outline: string

outlineMode

Inherited from: IgrMarkerSeries

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrMarkerSeries

percentChange: number

renderRequested

Inherited from: IgrMarkerSeries

renderRequested: object

resolution

Inherited from: IgrMarkerSeries

resolution: number

safeActualBrush

Inherited from: IgrMarkerSeries

safeActualBrush: string

selectionBrush

Inherited from: IgrMarkerSeries

selectionBrush: string

selectionThickness

Inherited from: IgrMarkerSeries

selectionThickness: number

shadowBlur

Inherited from: IgrMarkerSeries

shadowBlur: number

shadowColor

Inherited from: IgrMarkerSeries

shadowColor: string

shadowOffsetX

Inherited from: IgrMarkerSeries

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrMarkerSeries

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrMarkerSeries

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrMarkerSeries

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrMarkerSeries

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrMarkerSeries

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrMarkerSeries

showDefaultTooltip: boolean

thickness

Inherited from: IgrMarkerSeries

thickness: number

title

Inherited from: IgrMarkerSeries

title: any

tooltipContainerTemplate

Inherited from: IgrMarkerSeries

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrMarkerSeries

tooltipTemplate: any

transitionDuration

Inherited from: IgrMarkerSeries

transitionDuration: number

transitionEasingFunction

Inherited from: IgrMarkerSeries

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrMarkerSeries

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrMarkerSeries

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrMarkerSeries

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrMarkerSeries

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrMarkerSeries

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrMarkerSeries

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrMarkerSeries

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

trendLineBrush: string

trendLineDashArray

trendLineDashArray: number[]

trendLinePeriod

trendLinePeriod: number

trendLineThickness

trendLineThickness: number

trendLineType

trendLineType: TrendLineType

trendLineZIndex

trendLineZIndex: number

useItemWiseColors

Inherited from: IgrMarkerSeries

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrMarkerSeries

useSingleShadow: boolean

visibility

Inherited from: IgrMarkerSeries

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrMarkerSeries

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrMarkerSeries

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrMarkerSeries

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrMarkerSeries

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrMarkerSeries

visibleRangeMode: SeriesVisibleRangeMode

xAxis

xAxis: IgrNumericXAxis

xAxisName

xAxisName: string

xMemberAsLegendLabel

xMemberAsLegendLabel: string

xMemberAsLegendUnit

xMemberAsLegendUnit: string

xMemberPath

xMemberPath: string

yAxis

yAxis: IgrNumericYAxis

yAxisName

yAxisName: string

yMemberAsLegendLabel

yMemberAsLegendLabel: string

yMemberAsLegendUnit

yMemberAsLegendUnit: string

yMemberPath

yMemberPath: string

Accessors

actualCloseLabel

Inherited from: IgrMarkerSeries

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrMarkerSeries

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrMarkerSeries

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrMarkerSeries

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrMarkerSeries

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrMarkerSeries

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrMarkerSeries

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrMarkerSeries

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgrMarkerSeries

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgrMarkerSeries

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

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrMarkerSeries

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrMarkerSeries

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrMarkerSeries

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrMarkerSeries

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrMarkerSeries

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrMarkerSeries

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

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrMarkerSeries

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrMarkerSeries

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrMarkerSeries

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrMarkerSeries

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrMarkerSeries

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrMarkerSeries

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrMarkerSeries

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrMarkerSeries

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

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrMarkerSeries

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrMarkerSeries

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrMarkerSeries

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrMarkerSeries

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrMarkerSeries

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrMarkerSeries

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrMarkerSeries

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrMarkerSeries

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrMarkerSeries

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

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrMarkerSeries

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrMarkerSeries

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrMarkerSeries

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrMarkerSeries

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrMarkerSeries

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrMarkerSeries

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrMarkerSeries

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrMarkerSeries

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrMarkerSeries

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrMarkerSeries

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrMarkerSeries

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Checks if this series is a scatter series

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrMarkerSeries

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrMarkerSeries

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrMarkerSeries

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrMarkerSeries

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrMarkerSeries

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrMarkerSeries

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrMarkerSeries

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrMarkerSeries

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrMarkerSeries

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrMarkerSeries

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrMarkerSeries

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrMarkerSeries

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrMarkerSeries

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrMarkerSeries

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrMarkerSeries

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrMarkerSeries

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrMarkerSeries

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

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsXAxis

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsYAxis

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrMarkerSeries

componentDidMount(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrMarkerSeries

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

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

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

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

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

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

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrMarkerSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrMarkerSeries

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrMarkerSeries

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrMarkerSeries

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrMarkerSeries

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrMarkerSeries

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrMarkerSeries

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrMarkerSeries

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrMarkerSeries

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrMarkerSeries

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrMarkerSeries

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrMarkerSeries

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrMarkerSeries

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrMarkerSeries

render(): any

Returns any

renderSeries

Inherited from: IgrMarkerSeries

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrMarkerSeries

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

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

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrMarkerSeries

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrMarkerSeries

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrMarkerSeries

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

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

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any