IgrCalloutLayer

Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.

Constructors

new IgrCalloutLayer(props: IIgrCalloutLayerProps): IgrCalloutLayer

Returns IgrCalloutLayer

Properties

actualAppearanceMode

Inherited from: IgrAnnotationLayer

actualAppearanceMode: AnnotationAppearanceMode

actualAreaFillOpacity

Inherited from: IgrAnnotationLayer

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrAnnotationLayer

actualBrush: string

actualDashArray

Inherited from: IgrAnnotationLayer

actualDashArray: number[]

actualDashCap

Inherited from: IgrAnnotationLayer

actualDashCap: PenLineCap

actualFocusBrush

Inherited from: IgrAnnotationLayer

actualFocusBrush: string

actualFocusMode

Inherited from: IgrAnnotationLayer

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrAnnotationLayer

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrAnnotationLayer

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrAnnotationLayer

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrAnnotationLayer

actualHitTestMode: SeriesHitTestMode

actualHorizontalAppearanceMode

Inherited from: IgrAnnotationLayer

actualHorizontalAppearanceMode: AnnotationAppearanceMode

actualHorizontalDashArray

Inherited from: IgrAnnotationLayer

actualHorizontalDashArray: number[]

actualHorizontalShiftAmount

Inherited from: IgrAnnotationLayer

actualHorizontalShiftAmount: number

actualLayers

Inherited from: IgrAnnotationLayer

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrAnnotationLayer

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrAnnotationLayer

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrAnnotationLayer

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Inherited from: IgrAnnotationLayer

actualMarkerFillOpacity: number

actualOutline

Inherited from: IgrAnnotationLayer

actualOutline: string

actualResolution

Inherited from: IgrAnnotationLayer

actualResolution: number

actualSelectionBrush

Inherited from: IgrAnnotationLayer

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrAnnotationLayer

actualSelectionMode: SeriesSelectionMode

actualShiftAmount

Inherited from: IgrAnnotationLayer

actualShiftAmount: number

actualThickness

Inherited from: IgrAnnotationLayer

actualThickness: number

actualVerticalAppearanceMode

Inherited from: IgrAnnotationLayer

actualVerticalAppearanceMode: AnnotationAppearanceMode

actualVerticalDashArray

Inherited from: IgrAnnotationLayer

actualVerticalDashArray: number[]

actualVerticalShiftAmount

Inherited from: IgrAnnotationLayer

actualVerticalShiftAmount: number

allowedPositions

allowedPositions: IgrCalloutPlacementPositionsCollection

appearanceMode

Inherited from: IgrAnnotationLayer

appearanceMode: AnnotationAppearanceMode

areaFillOpacity

Inherited from: IgrAnnotationLayer

areaFillOpacity: number

attachTooltipToRoot

Inherited from: IgrAnnotationLayer

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrAnnotationLayer

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrAnnotationLayer

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutLabelPrecision

autoCalloutLabelPrecision: number

autoCalloutValueLabelFormat

Inherited from: IgrAnnotationLayer

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrAnnotationLayer

autoCalloutValueLabelFormatSpecifiers: any[]

autoCalloutVisibilityMode

autoCalloutVisibilityMode: AutoCalloutVisibilityMode

brush

Inherited from: IgrAnnotationLayer

brush: string

calloutBackground

calloutBackground: string

calloutBadgeBackground

calloutBadgeBackground: string

calloutBadgeCorner

calloutBadgeCorner: number

calloutBadgeGap

calloutBadgeGap: number

calloutBadgeHeight

calloutBadgeHeight: number

calloutBadgeImageMemberPath

calloutBadgeImageMemberPath: string

calloutBadgeMatchSeries

calloutBadgeMatchSeries: boolean

calloutBadgeOutline

calloutBadgeOutline: string

calloutBadgeThickness

calloutBadgeThickness: number

calloutBadgeVisible

calloutBadgeVisible: boolean

calloutBadgeWidth

calloutBadgeWidth: number

calloutCollisionMode

calloutCollisionMode: CalloutCollisionMode

calloutContentUpdating

calloutContentUpdating: object

calloutCornerRadius

calloutCornerRadius: number

calloutDarkTextColor

calloutDarkTextColor: string

calloutExpandsAxisBufferEnabled

calloutExpandsAxisBufferEnabled: boolean

calloutExpandsAxisBufferMaxHeight

calloutExpandsAxisBufferMaxHeight: number

calloutExpandsAxisBufferMaxWidth

calloutExpandsAxisBufferMaxWidth: number

calloutExpandsAxisBufferMinHeight

calloutExpandsAxisBufferMinHeight: number

calloutExpandsAxisBufferMinWidth

calloutExpandsAxisBufferMinWidth: number

calloutExpandsAxisBufferOnInitialVisibility

calloutExpandsAxisBufferOnInitialVisibility: boolean

calloutExpandsAxisBufferOnlyWhenVisible

calloutExpandsAxisBufferOnlyWhenVisible: boolean

calloutInterpolatedValuePrecision

calloutInterpolatedValuePrecision: number

calloutLabelUpdating

calloutLabelUpdating: object

calloutLeaderBrush

calloutLeaderBrush: string

calloutLightTextColor

calloutLightTextColor: string

calloutOutline

calloutOutline: string

calloutPaddingBottom

calloutPaddingBottom: number

calloutPaddingLeft

calloutPaddingLeft: number

calloutPaddingRight

calloutPaddingRight: number

calloutPaddingTop

calloutPaddingTop: number

calloutPositionPadding

calloutPositionPadding: number

calloutRenderStyleUpdating

calloutRenderStyleUpdating: object

calloutSeriesSelecting

calloutSeriesSelecting: object

calloutStrokeThickness

calloutStrokeThickness: number

calloutStyleUpdating

calloutStyleUpdating: object

calloutSuspendedWhenShiftingToVisible

calloutSuspendedWhenShiftingToVisible: boolean

calloutTextColor

calloutTextColor: string

coercionMethods

Inherited from: IgrAnnotationLayer

coercionMethods: any

collisionChannel

collisionChannel: string

contentMemberPath

contentMemberPath: string

cursorPosition

Inherited from: IgrAnnotationLayer

cursorPosition: IgPoint

cursorPositionUpdatesOnMove

Inherited from: IgrAnnotationLayer

cursorPositionUpdatesOnMove: boolean

dashArray

Inherited from: IgrAnnotationLayer

dashArray: number[]

dataLegendGroup

Inherited from: IgrAnnotationLayer

dataLegendGroup: string

dataSource

Inherited from: IgrAnnotationLayer

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrAnnotationLayer

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrAnnotationLayer

expectFunctions: boolean

finalValue

Inherited from: IgrAnnotationLayer

finalValue: number

focusBrush

Inherited from: IgrAnnotationLayer

focusBrush: string

highlightedDataSource

Inherited from: IgrAnnotationLayer

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrAnnotationLayer

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgrAnnotationLayer

highlightedTitleSuffix: string

highlightedValueLabelMode

highlightedValueLabelMode: HighlightedValueLabelMode

highlightedValuesDataLegendGroup

Inherited from: IgrAnnotationLayer

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrAnnotationLayer

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrAnnotationLayer

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrAnnotationLayer

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgrAnnotationLayer

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrAnnotationLayer

hitTestMode: SeriesHitTestMode

horizontalAppearanceMode

Inherited from: IgrAnnotationLayer

horizontalAppearanceMode: AnnotationAppearanceMode

horizontalDashArray

Inherited from: IgrAnnotationLayer

horizontalDashArray: number[]

horizontalShiftAmount

Inherited from: IgrAnnotationLayer

horizontalShiftAmount: number

index

Inherited from: IgrAnnotationLayer

index: number

isActualLegendFinancial

Inherited from: IgrAnnotationLayer

isActualLegendFinancial: boolean

isAutoCalloutBehaviorEnabled

isAutoCalloutBehaviorEnabled: boolean

isCalloutOffsettingEnabled

isCalloutOffsettingEnabled: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrAnnotationLayer

isComponentHighlightingModeIgnored: boolean

isCustomCalloutRenderStyleEnabled

isCustomCalloutRenderStyleEnabled: boolean

isCustomCalloutStyleEnabled

isCustomCalloutStyleEnabled: boolean

isDefaultCrosshairDisabled

Inherited from: IgrAnnotationLayer

isDefaultCrosshairDisabled: boolean

isDefaultToolTipSelected

Inherited from: IgrAnnotationLayer

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrAnnotationLayer

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrAnnotationLayer

isHighlightingEnabled: boolean

keyMemberPath

keyMemberPath: string

labelFormat

labelFormat: string

labelFormatSpecifiers

labelFormatSpecifiers: any[]

labelMemberPath

labelMemberPath: string

layers

Inherited from: IgrAnnotationLayer

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrAnnotationLayer

legend: any

legendItemBadgeMode

Inherited from: IgrAnnotationLayer

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrAnnotationLayer

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrAnnotationLayer

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrAnnotationLayer

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrAnnotationLayer

legendItemVisibility: Visibility

lineCap

Inherited from: IgrAnnotationLayer

lineCap: PenLineCap

lineJoin

Inherited from: IgrAnnotationLayer

lineJoin: PenLineJoin

markerFillOpacity

Inherited from: IgrAnnotationLayer

markerFillOpacity: number

mouseOverEnabled

Inherited from: IgrAnnotationLayer

mouseOverEnabled: boolean

name

Inherited from: IgrAnnotationLayer

name: string

opacity

Inherited from: IgrAnnotationLayer

opacity: number

outline

Inherited from: IgrAnnotationLayer

outline: string

outlineMode

Inherited from: IgrAnnotationLayer

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrAnnotationLayer

percentChange: number

renderRequested

Inherited from: IgrAnnotationLayer

renderRequested: object

resolution

Inherited from: IgrAnnotationLayer

resolution: number

safeActualBrush

Inherited from: IgrAnnotationLayer

safeActualBrush: string

selectionBrush

Inherited from: IgrAnnotationLayer

selectionBrush: string

selectionThickness

Inherited from: IgrAnnotationLayer

selectionThickness: number

shadowBlur

Inherited from: IgrAnnotationLayer

shadowBlur: number

shadowColor

Inherited from: IgrAnnotationLayer

shadowColor: string

shadowOffsetX

Inherited from: IgrAnnotationLayer

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrAnnotationLayer

shadowOffsetY: number

shiftAmount

Inherited from: IgrAnnotationLayer

shiftAmount: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrAnnotationLayer

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrAnnotationLayer

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrAnnotationLayer

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldRenderAsOverlay

Inherited from: IgrAnnotationLayer

shouldRenderAsOverlay: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrAnnotationLayer

shouldShiftOpacityForSafeActualBrush: boolean

shouldTruncateOnBoundaryCollisions

shouldTruncateOnBoundaryCollisions: boolean

showDefaultTooltip

Inherited from: IgrAnnotationLayer

showDefaultTooltip: boolean

targetSeries

targetSeries: IgrSeries

targetSeriesName

targetSeriesName: string

textStyle

textStyle: string

thickness

Inherited from: IgrAnnotationLayer

thickness: number

title

Inherited from: IgrAnnotationLayer

title: any

tooltipContainerTemplate

Inherited from: IgrAnnotationLayer

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrAnnotationLayer

tooltipTemplate: any

transitionDuration

Inherited from: IgrAnnotationLayer

transitionDuration: number

transitionEasingFunction

Inherited from: IgrAnnotationLayer

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrAnnotationLayer

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrAnnotationLayer

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrAnnotationLayer

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrAnnotationLayer

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrAnnotationLayer

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrAnnotationLayer

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrAnnotationLayer

transitionOutSpeedType: TransitionOutSpeedType

useAutoContrastingLabelColors

useAutoContrastingLabelColors: boolean

useIndex

Inherited from: IgrAnnotationLayer

useIndex: boolean

useInterpolatedValueForAutoCalloutLabels

useInterpolatedValueForAutoCalloutLabels: boolean

useItemColorForFill

useItemColorForFill: boolean

useItemColorForOutline

useItemColorForOutline: boolean

useItemWiseColors

Inherited from: IgrAnnotationLayer

useItemWiseColors: boolean

useLegend

Inherited from: IgrAnnotationLayer

useLegend: boolean

useSeriesColorForOutline

useSeriesColorForOutline: boolean

useSingleShadow

Inherited from: IgrAnnotationLayer

useSingleShadow: boolean

useValueForAutoCalloutLabels

useValueForAutoCalloutLabels: boolean

verticalAppearanceMode

Inherited from: IgrAnnotationLayer

verticalAppearanceMode: AnnotationAppearanceMode

verticalDashArray

Inherited from: IgrAnnotationLayer

verticalDashArray: number[]

verticalShiftAmount

Inherited from: IgrAnnotationLayer

verticalShiftAmount: number

visibility

Inherited from: IgrAnnotationLayer

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrAnnotationLayer

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrAnnotationLayer

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrAnnotationLayer

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrAnnotationLayer

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrAnnotationLayer

visibleRangeMode: SeriesVisibleRangeMode

xMemberPath

xMemberPath: string

yMemberPath

yMemberPath: string

Accessors

actualCloseLabel

Inherited from: IgrAnnotationLayer

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrAnnotationLayer

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrAnnotationLayer

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrAnnotationLayer

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrAnnotationLayer

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrAnnotationLayer

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrAnnotationLayer

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrAnnotationLayer

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Inherited from: IgrAnnotationLayer

Returns whether the current series supports visual markers.

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgrAnnotationLayer

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrAnnotationLayer

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrAnnotationLayer

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrAnnotationLayer

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

Gets whether this series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrAnnotationLayer

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrAnnotationLayer

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrAnnotationLayer

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrAnnotationLayer

Gets whether or not the default crosshair behavior is disabled.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Inherited from: IgrAnnotationLayer

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrAnnotationLayer

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrAnnotationLayer

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrAnnotationLayer

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrAnnotationLayer

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrAnnotationLayer

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrAnnotationLayer

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrAnnotationLayer

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

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrAnnotationLayer

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrAnnotationLayer

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrAnnotationLayer

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrAnnotationLayer

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrAnnotationLayer

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrAnnotationLayer

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrAnnotationLayer

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrAnnotationLayer

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrAnnotationLayer

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrAnnotationLayer

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrAnnotationLayer

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrAnnotationLayer

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrAnnotationLayer

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrAnnotationLayer

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrAnnotationLayer

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrAnnotationLayer

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrAnnotationLayer

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrAnnotationLayer

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

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

componentDidMount

Inherited from: IgrAnnotationLayer

componentDidMount(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrAnnotationLayer

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

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrAnnotationLayer

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.

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

Returns any

getItemIndex

Inherited from: IgrAnnotationLayer

Gets the item index associated with the specified world position

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

Inherited from: IgrAnnotationLayer

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

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrAnnotationLayer

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrAnnotationLayer

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrAnnotationLayer

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrAnnotationLayer

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrAnnotationLayer

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrAnnotationLayer

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrAnnotationLayer

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

hideToolTipsImmediate(): void

Returns void

invalidateCalloutContent

Invalidates content of callout layer

invalidateCalloutContent(): void

Returns void

moveCursorPoint

Inherited from: IgrAnnotationLayer

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrAnnotationLayer

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrAnnotationLayer

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

recalculateAxisRangeBuffer

Resets actual visiable range margin

recalculateAxisRangeBuffer(): void

Returns void

refreshAxisBufferAndCalloutPositions

Refresh axis buffer and callouts rendering

refreshAxisBufferAndCalloutPositions(): void

Returns void

refreshLabelPositions

Force the callout labels to reevaluate their positions.

refreshLabelPositions(): void

Returns void

removeAllAlternateViews

Inherited from: IgrAnnotationLayer

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrAnnotationLayer

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrAnnotationLayer

render(): any

Returns any

renderSeries

Inherited from: IgrAnnotationLayer

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrAnnotationLayer

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrAnnotationLayer

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

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrAnnotationLayer

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrAnnotationLayer

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrAnnotationLayer

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

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

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any