Represents an annotation layer that renders bands (line with breadth) at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath AnnotationBreadthMemberPath

Constructors

Section titled "Constructors"

IgrDataAnnotationBandLayer

new IgrDataAnnotationBandLayer(props: IIgrDataAnnotationBandLayerProps): IgrDataAnnotationBandLayer

Returns IgrDataAnnotationBandLayer

Properties

Section titled "Properties"

actualAppearanceMode

Section titled "actualAppearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

actualAppearanceMode: AnnotationAppearanceMode

actualAreaFillOpacity

Section titled "actualAreaFillOpacity"

Inherited from: IgrDataAnnotationPointLayer 

actualAreaFillOpacity: number

actualBrush

Section titled "actualBrush"

Inherited from: IgrDataAnnotationPointLayer 

actualBrush: string

actualDashArray

Section titled "actualDashArray"

Inherited from: IgrDataAnnotationPointLayer 

actualDashArray: number[]

actualDashCap

Section titled "actualDashCap"

Inherited from: IgrDataAnnotationPointLayer 

actualDashCap: PenLineCap

actualFocusBrush

Section titled "actualFocusBrush"

Inherited from: IgrDataAnnotationPointLayer 

actualFocusBrush: string

actualFocusMode

Section titled "actualFocusMode"

Inherited from: IgrDataAnnotationPointLayer 

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Section titled "actualHighlightedValuesFadeOpacity"

Inherited from: IgrDataAnnotationPointLayer 

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Section titled "actualHighlightingFadeOpacity"

Inherited from: IgrDataAnnotationPointLayer 

actualHighlightingFadeOpacity: number

actualHighlightingMode

Section titled "actualHighlightingMode"

Inherited from: IgrDataAnnotationPointLayer 

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Section titled "actualHitTestMode"

Inherited from: IgrDataAnnotationPointLayer 

actualHitTestMode: SeriesHitTestMode

actualHorizontalAppearanceMode

Section titled "actualHorizontalAppearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

actualHorizontalAppearanceMode: AnnotationAppearanceMode

actualHorizontalDashArray

Section titled "actualHorizontalDashArray"

Inherited from: IgrDataAnnotationPointLayer 

actualHorizontalDashArray: number[]

actualHorizontalShiftAmount

Section titled "actualHorizontalShiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

actualHorizontalShiftAmount: number

actualLayers

Section titled "actualLayers"

Inherited from: IgrDataAnnotationPointLayer 

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Section titled "actualLegendItemBadgeBrush"

Inherited from: IgrDataAnnotationPointLayer 

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Section titled "actualLegendItemBadgeOutline"

Inherited from: IgrDataAnnotationPointLayer 

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Section titled "actualLegendItemBadgeTemplate"

Inherited from: IgrDataAnnotationPointLayer 

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Section titled "actualMarkerFillOpacity"

Inherited from: IgrDataAnnotationPointLayer 

actualMarkerFillOpacity: number

actualOutline

Section titled "actualOutline"

Inherited from: IgrDataAnnotationPointLayer 

actualOutline: string

actualResolution

Section titled "actualResolution"

Inherited from: IgrDataAnnotationPointLayer 

actualResolution: number

actualSelectionBrush

Section titled "actualSelectionBrush"

Inherited from: IgrDataAnnotationPointLayer 

actualSelectionBrush: string

actualSelectionMode

Section titled "actualSelectionMode"

Inherited from: IgrDataAnnotationPointLayer 

actualSelectionMode: SeriesSelectionMode

actualShiftAmount

Section titled "actualShiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

actualShiftAmount: number

actualThickness

Section titled "actualThickness"

Inherited from: IgrDataAnnotationPointLayer 

actualThickness: number

actualVerticalAppearanceMode

Section titled "actualVerticalAppearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

actualVerticalAppearanceMode: AnnotationAppearanceMode

actualVerticalDashArray

Section titled "actualVerticalDashArray"

Inherited from: IgrDataAnnotationPointLayer 

actualVerticalDashArray: number[]

actualVerticalShiftAmount

Section titled "actualVerticalShiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

actualVerticalShiftAmount: number

annotationBackground

Section titled "annotationBackground"

Inherited from: IgrDataAnnotationPointLayer 

annotationBackground: string

annotationBackgroundMatchLayer

Section titled "annotationBackgroundMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

annotationBackgroundMatchLayer: boolean

annotationBackgroundMode

Section titled "annotationBackgroundMode"

Inherited from: IgrDataAnnotationPointLayer 

annotationBackgroundMode: AnnotationAppearanceMode

annotationBackgroundShift

Section titled "annotationBackgroundShift"

Inherited from: IgrDataAnnotationPointLayer 

annotationBackgroundShift: number

annotationBadgeBackground

Section titled "annotationBadgeBackground"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeBackground: string

annotationBadgeBackgroundXMemberPath

Section titled "annotationBadgeBackgroundXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeBackgroundXMemberPath: string

annotationBadgeBackgroundYMemberPath

Section titled "annotationBadgeBackgroundYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeBackgroundYMemberPath: string

annotationBadgeCornerRadius

Section titled "annotationBadgeCornerRadius"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeCornerRadius: number

annotationBadgeEnabled

Section titled "annotationBadgeEnabled"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeEnabled: boolean

annotationBadgeEnabledXMemberPath

Section titled "annotationBadgeEnabledXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeEnabledXMemberPath: string

annotationBadgeEnabledYMemberPath

Section titled "annotationBadgeEnabledYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeEnabledYMemberPath: string

annotationBadgeImagePath

Section titled "annotationBadgeImagePath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeImagePath: string

annotationBadgeImageXMemberPath

Section titled "annotationBadgeImageXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeImageXMemberPath: string

annotationBadgeImageYMemberPath

Section titled "annotationBadgeImageYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeImageYMemberPath: string

annotationBadgeMargin

Section titled "annotationBadgeMargin"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeMargin: number

annotationBadgeOutline

Section titled "annotationBadgeOutline"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeOutline: string

annotationBadgeOutlineThickness

Section titled "annotationBadgeOutlineThickness"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeOutlineThickness: number

annotationBadgeOutlineXMemberPath

Section titled "annotationBadgeOutlineXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeOutlineXMemberPath: string

annotationBadgeOutlineYMemberPath

Section titled "annotationBadgeOutlineYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeOutlineYMemberPath: string

annotationBadgeSize

Section titled "annotationBadgeSize"

Inherited from: IgrDataAnnotationPointLayer 

annotationBadgeSize: number

annotationBorderColor

Section titled "annotationBorderColor"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderColor: string

annotationBorderMatchLayer

Section titled "annotationBorderMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderMatchLayer: boolean

annotationBorderMode

Section titled "annotationBorderMode"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderMode: AnnotationAppearanceMode

annotationBorderRadius

Section titled "annotationBorderRadius"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderRadius: number

annotationBorderShift

Section titled "annotationBorderShift"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderShift: number

annotationBorderThickness

Section titled "annotationBorderThickness"

Inherited from: IgrDataAnnotationPointLayer 

annotationBorderThickness: number

annotationBreadthMemberPath

Section titled "annotationBreadthMemberPath" 
annotationBreadthMemberPath: string

annotationLabelDisplayMode

Section titled "annotationLabelDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

annotationLabelDisplayMode: DataAnnotationDisplayMode

annotationLabelVisible

Section titled "annotationLabelVisible"

Inherited from: IgrDataAnnotationPointLayer 

annotationLabelVisible: boolean

annotationPaddingBottom

Section titled "annotationPaddingBottom"

Inherited from: IgrDataAnnotationPointLayer 

annotationPaddingBottom: number

annotationPaddingLeft

Section titled "annotationPaddingLeft"

Inherited from: IgrDataAnnotationPointLayer 

annotationPaddingLeft: number

annotationPaddingRight

Section titled "annotationPaddingRight"

Inherited from: IgrDataAnnotationPointLayer 

annotationPaddingRight: number

annotationPaddingTop

Section titled "annotationPaddingTop"

Inherited from: IgrDataAnnotationPointLayer 

annotationPaddingTop: number

annotationShapeVisible

Section titled "annotationShapeVisible"

Inherited from: IgrDataAnnotationPointLayer 

annotationShapeVisible: boolean

annotationTextColor

Section titled "annotationTextColor"

Inherited from: IgrDataAnnotationPointLayer 

annotationTextColor: string

annotationTextColorMatchLayer

Section titled "annotationTextColorMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

annotationTextColorMatchLayer: boolean

annotationTextColorMode

Section titled "annotationTextColorMode"

Inherited from: IgrDataAnnotationPointLayer 

annotationTextColorMode: AnnotationAppearanceMode

annotationTextColorShift

Section titled "annotationTextColorShift"

Inherited from: IgrDataAnnotationPointLayer 

annotationTextColorShift: number

annotationValueMaxPrecision

Section titled "annotationValueMaxPrecision"

Inherited from: IgrDataAnnotationPointLayer 

annotationValueMaxPrecision: number

annotationValueMinPrecision

Section titled "annotationValueMinPrecision"

Inherited from: IgrDataAnnotationPointLayer 

annotationValueMinPrecision: number

appearanceMode

Section titled "appearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

appearanceMode: AnnotationAppearanceMode

areaFillOpacity

Section titled "areaFillOpacity"

Inherited from: IgrDataAnnotationPointLayer 

areaFillOpacity: number

attachTooltipToRoot

Section titled "attachTooltipToRoot"

Inherited from: IgrDataAnnotationPointLayer 

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Section titled "autoCalloutLabelFormat"

Inherited from: IgrDataAnnotationPointLayer 

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Section titled "autoCalloutLabelFormatSpecifiers"

Inherited from: IgrDataAnnotationPointLayer 

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Section titled "autoCalloutValueLabelFormat"

Inherited from: IgrDataAnnotationPointLayer 

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgrDataAnnotationPointLayer 

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Section titled "brush"

Inherited from: IgrDataAnnotationPointLayer 

brush: string

centerLabelBackground

Section titled "centerLabelBackground"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelBackground: string

centerLabelBorderColor

Section titled "centerLabelBorderColor"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelBorderColor: string

centerLabelTextColor

Section titled "centerLabelTextColor"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelTextColor: string

centerLabelXDisplayMode

Section titled "centerLabelXDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelXDisplayMode: DataAnnotationDisplayMode

centerLabelXMemberPath

Section titled "centerLabelXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelXMemberPath: string

centerLabelYDisplayMode

Section titled "centerLabelYDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelYDisplayMode: DataAnnotationDisplayMode

centerLabelYMemberPath

Section titled "centerLabelYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

centerLabelYMemberPath: string

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrDataAnnotationPointLayer 

coercionMethods: any

cursorPosition

Section titled "cursorPosition"

Inherited from: IgrDataAnnotationPointLayer 

cursorPosition: IgPoint

cursorPositionUpdatesOnMove

Section titled "cursorPositionUpdatesOnMove"

Inherited from: IgrDataAnnotationPointLayer 

cursorPositionUpdatesOnMove: boolean

dashArray

Section titled "dashArray"

Inherited from: IgrDataAnnotationPointLayer 

dashArray: number[]

dataLegendGroup

Section titled "dataLegendGroup"

Inherited from: IgrDataAnnotationPointLayer 

dataLegendGroup: string

dataSource

Section titled "dataSource"

Inherited from: IgrDataAnnotationPointLayer 

dataSource: any

discreteLegendItemTemplate

Section titled "discreteLegendItemTemplate"

Inherited from: IgrDataAnnotationPointLayer 

discreteLegendItemTemplate: IgDataTemplate

endLabelBackground

Section titled "endLabelBackground"

Inherited from: IgrDataAnnotationPointLayer 

endLabelBackground: string

endLabelBorderColor

Section titled "endLabelBorderColor"

Inherited from: IgrDataAnnotationPointLayer 

endLabelBorderColor: string

endLabelTextColor

Section titled "endLabelTextColor"

Inherited from: IgrDataAnnotationPointLayer 

endLabelTextColor: string

endLabelXDisplayMode

Section titled "endLabelXDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

endLabelXDisplayMode: DataAnnotationDisplayMode

endLabelXMemberPath

Section titled "endLabelXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

endLabelXMemberPath: string

endLabelYDisplayMode

Section titled "endLabelYDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

endLabelYDisplayMode: DataAnnotationDisplayMode

endLabelYMemberPath

Section titled "endLabelYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

endLabelYMemberPath: string

endValueXMemberPath

Section titled "endValueXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

endValueXMemberPath: string

endValueYMemberPath

Section titled "endValueYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

endValueYMemberPath: string

expectFunctions

Section titled "expectFunctions"

Inherited from: IgrDataAnnotationPointLayer 

expectFunctions: boolean

finalValue

Section titled "finalValue"

Inherited from: IgrDataAnnotationPointLayer 

finalValue: number

focusBrush

Section titled "focusBrush"

Inherited from: IgrDataAnnotationPointLayer 

focusBrush: string

highlightedDataSource

Section titled "highlightedDataSource"

Inherited from: IgrDataAnnotationPointLayer 

highlightedDataSource: any

highlightedLegendItemVisibility

Section titled "highlightedLegendItemVisibility"

Inherited from: IgrDataAnnotationPointLayer 

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Section titled "highlightedTitleSuffix"

Inherited from: IgrDataAnnotationPointLayer 

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Section titled "highlightedValuesDataLegendGroup"

Inherited from: IgrDataAnnotationPointLayer 

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Section titled "highlightedValuesDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgrDataAnnotationPointLayer 

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Section titled "highlightedValuesFadeOpacity"

Inherited from: IgrDataAnnotationPointLayer 

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Inherited from: IgrDataAnnotationPointLayer 

highlightingFadeOpacity: number

hitTestMode

Section titled "hitTestMode"

Inherited from: IgrDataAnnotationPointLayer 

hitTestMode: SeriesHitTestMode

horizontalAppearanceMode

Section titled "horizontalAppearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

horizontalAppearanceMode: AnnotationAppearanceMode

horizontalDashArray

Section titled "horizontalDashArray"

Inherited from: IgrDataAnnotationPointLayer 

horizontalDashArray: number[]

horizontalShiftAmount

Section titled "horizontalShiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

horizontalShiftAmount: number

index

Section titled "index"

Inherited from: IgrDataAnnotationPointLayer 

index: number

isActualLegendFinancial

Section titled "isActualLegendFinancial"

Inherited from: IgrDataAnnotationPointLayer 

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Section titled "isComponentHighlightingModeIgnored"

Inherited from: IgrDataAnnotationPointLayer 

isComponentHighlightingModeIgnored: boolean

isDefaultCrosshairDisabled

Section titled "isDefaultCrosshairDisabled"

Inherited from: IgrDataAnnotationPointLayer 

isDefaultCrosshairDisabled: boolean

isDefaultToolTipSelected

Section titled "isDefaultToolTipSelected"

Inherited from: IgrDataAnnotationPointLayer 

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Section titled "isDropShadowEnabled"

Inherited from: IgrDataAnnotationPointLayer 

isDropShadowEnabled: boolean

isHighlightingEnabled

Section titled "isHighlightingEnabled"

Inherited from: IgrDataAnnotationPointLayer 

isHighlightingEnabled: boolean

isTargetingHorizontalAxis

Section titled "isTargetingHorizontalAxis"

Inherited from: IgrDataAnnotationPointLayer 

isTargetingHorizontalAxis: boolean

itemsUseWorldCoordinates

Section titled "itemsUseWorldCoordinates"

Inherited from: IgrDataAnnotationPointLayer 

itemsUseWorldCoordinates: boolean

layers

Section titled "layers"

Inherited from: IgrDataAnnotationPointLayer 

layers: IgrSeriesLayerCollection

legend

Section titled "legend"

Inherited from: IgrDataAnnotationPointLayer 

legend: any

legendItemBadgeMode

Section titled "legendItemBadgeMode"

Inherited from: IgrDataAnnotationPointLayer 

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Section titled "legendItemBadgeShape"

Inherited from: IgrDataAnnotationPointLayer 

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Section titled "legendItemBadgeTemplate"

Inherited from: IgrDataAnnotationPointLayer 

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Section titled "legendItemTemplate"

Inherited from: IgrDataAnnotationPointLayer 

legendItemTemplate: IgDataTemplate

legendItemVisibility

Section titled "legendItemVisibility"

Inherited from: IgrDataAnnotationPointLayer 

legendItemVisibility: Visibility

lineCap

Section titled "lineCap"

Inherited from: IgrDataAnnotationPointLayer 

lineCap: PenLineCap

lineJoin

Section titled "lineJoin"

Inherited from: IgrDataAnnotationPointLayer 

lineJoin: PenLineJoin

markerFillOpacity

Section titled "markerFillOpacity"

Inherited from: IgrDataAnnotationPointLayer 

markerFillOpacity: number

mouseOverEnabled

Section titled "mouseOverEnabled"

Inherited from: IgrDataAnnotationPointLayer 

mouseOverEnabled: boolean

name

Section titled "name"

Inherited from: IgrDataAnnotationPointLayer 

name: string

opacity

Section titled "opacity"

Inherited from: IgrDataAnnotationPointLayer 

opacity: number

outline

Section titled "outline"

Inherited from: IgrDataAnnotationPointLayer 

outline: string

outlineMode

Section titled "outlineMode"

Inherited from: IgrDataAnnotationPointLayer 

outlineMode: SeriesOutlineMode

overlayText

Section titled "overlayText"

Inherited from: IgrDataAnnotationPointLayer 

overlayText: string

overlayTextAngle

Section titled "overlayTextAngle"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextAngle: number

overlayTextBackground

Section titled "overlayTextBackground"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBackground: string

overlayTextBackgroundMatchLayer

Section titled "overlayTextBackgroundMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBackgroundMatchLayer: boolean

overlayTextBackgroundMode

Section titled "overlayTextBackgroundMode"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBackgroundMode: AnnotationAppearanceMode

overlayTextBackgroundShift

Section titled "overlayTextBackgroundShift"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBackgroundShift: number

overlayTextBorderColor

Section titled "overlayTextBorderColor"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderColor: string

overlayTextBorderMatchLayer

Section titled "overlayTextBorderMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderMatchLayer: boolean

overlayTextBorderMode

Section titled "overlayTextBorderMode"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderMode: AnnotationAppearanceMode

overlayTextBorderRadius

Section titled "overlayTextBorderRadius"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderRadius: number

overlayTextBorderShift

Section titled "overlayTextBorderShift"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderShift: number

overlayTextBorderThickness

Section titled "overlayTextBorderThickness"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextBorderThickness: number

overlayTextColor

Section titled "overlayTextColor"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextColor: string

overlayTextColorMatchLayer

Section titled "overlayTextColorMatchLayer"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextColorMatchLayer: boolean

overlayTextColorMode

Section titled "overlayTextColorMode"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextColorMode: AnnotationAppearanceMode

overlayTextColorShift

Section titled "overlayTextColorShift"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextColorShift: number

overlayTextHorizontalMargin

Section titled "overlayTextHorizontalMargin"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextHorizontalMargin: number

overlayTextHorizontalPadding

Section titled "overlayTextHorizontalPadding"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextHorizontalPadding: number

overlayTextLocation

Section titled "overlayTextLocation"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextLocation: OverlayTextLocation

overlayTextMemberPath

Section titled "overlayTextMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextMemberPath: string

overlayTextStyle

Section titled "overlayTextStyle"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextStyle: string

overlayTextVerticalMargin

Section titled "overlayTextVerticalMargin"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextVerticalMargin: number

overlayTextVerticalPadding

Section titled "overlayTextVerticalPadding"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextVerticalPadding: number

overlayTextVisible

Section titled "overlayTextVisible"

Inherited from: IgrDataAnnotationPointLayer 

overlayTextVisible: boolean

percentChange

Section titled "percentChange"

Inherited from: IgrDataAnnotationPointLayer 

percentChange: number

renderRequested

Section titled "renderRequested"

Inherited from: IgrDataAnnotationPointLayer 

renderRequested: object

resolution

Section titled "resolution"

Inherited from: IgrDataAnnotationPointLayer 

resolution: number

safeActualBrush

Section titled "safeActualBrush"

Inherited from: IgrDataAnnotationPointLayer 

safeActualBrush: string

selectionBrush

Section titled "selectionBrush"

Inherited from: IgrDataAnnotationPointLayer 

selectionBrush: string

selectionThickness

Section titled "selectionThickness"

Inherited from: IgrDataAnnotationPointLayer 

selectionThickness: number

shadowBlur

Section titled "shadowBlur"

Inherited from: IgrDataAnnotationPointLayer 

shadowBlur: number

shadowColor

Section titled "shadowColor"

Inherited from: IgrDataAnnotationPointLayer 

shadowColor: string

shadowOffsetX

Section titled "shadowOffsetX"

Inherited from: IgrDataAnnotationPointLayer 

shadowOffsetX: number

shadowOffsetY

Section titled "shadowOffsetY"

Inherited from: IgrDataAnnotationPointLayer 

shadowOffsetY: number

shiftAmount

Section titled "shiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

shiftAmount: number

shouldAnimateOnDataSourceSwap

Section titled "shouldAnimateOnDataSourceSwap"

Inherited from: IgrDataAnnotationPointLayer 

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Section titled "shouldHideAutoCallouts"

Inherited from: IgrDataAnnotationPointLayer 

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgrDataAnnotationPointLayer 

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldRenderAsOverlay

Section titled "shouldRenderAsOverlay"

Inherited from: IgrDataAnnotationPointLayer 

shouldRenderAsOverlay: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgrDataAnnotationPointLayer 

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Section titled "showDefaultTooltip"

Inherited from: IgrDataAnnotationPointLayer 

showDefaultTooltip: boolean

startLabelBackground

Section titled "startLabelBackground"

Inherited from: IgrDataAnnotationPointLayer 

startLabelBackground: string

startLabelBorderColor

Section titled "startLabelBorderColor"

Inherited from: IgrDataAnnotationPointLayer 

startLabelBorderColor: string

startLabelTextColor

Section titled "startLabelTextColor"

Inherited from: IgrDataAnnotationPointLayer 

startLabelTextColor: string

startLabelXDisplayMode

Section titled "startLabelXDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

startLabelXDisplayMode: DataAnnotationDisplayMode

startLabelXMemberPath

Section titled "startLabelXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

startLabelXMemberPath: string

startLabelYDisplayMode

Section titled "startLabelYDisplayMode"

Inherited from: IgrDataAnnotationPointLayer 

startLabelYDisplayMode: DataAnnotationDisplayMode

startLabelYMemberPath

Section titled "startLabelYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

startLabelYMemberPath: string

startValueXMemberPath

Section titled "startValueXMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

startValueXMemberPath: string

startValueYMemberPath

Section titled "startValueYMemberPath"

Inherited from: IgrDataAnnotationPointLayer 

startValueYMemberPath: string

stylingAxisAnnotation

Section titled "stylingAxisAnnotation"

Inherited from: IgrDataAnnotationPointLayer 

stylingAxisAnnotation: object

stylingOverlayText

Section titled "stylingOverlayText"

Inherited from: IgrDataAnnotationPointLayer 

stylingOverlayText: object

stylingShapeAnnotation

Section titled "stylingShapeAnnotation"

Inherited from: IgrDataAnnotationPointLayer 

stylingShapeAnnotation: object

targetAxis

Section titled "targetAxis"

Inherited from: IgrDataAnnotationPointLayer 

targetAxis: IgrAxis

targetAxisName

Section titled "targetAxisName"

Inherited from: IgrDataAnnotationPointLayer 

targetAxisName: string

targetMode

Section titled "targetMode"

Inherited from: IgrDataAnnotationPointLayer 

targetMode: DataAnnotationTargetMode

thickness

Section titled "thickness"

Inherited from: IgrDataAnnotationPointLayer 

thickness: number

title

Section titled "title"

Inherited from: IgrDataAnnotationPointLayer 

title: any

tooltipContainerTemplate

Section titled "tooltipContainerTemplate"

Inherited from: IgrDataAnnotationPointLayer 

tooltipContainerTemplate: any

tooltipTemplate

Section titled "tooltipTemplate"

Inherited from: IgrDataAnnotationPointLayer 

tooltipTemplate: any

transitionDuration

Section titled "transitionDuration"

Inherited from: IgrDataAnnotationPointLayer 

transitionDuration: number

transitionEasingFunction

Section titled "transitionEasingFunction"

Inherited from: IgrDataAnnotationPointLayer 

transitionEasingFunction: object

transitionInDuration

Section titled "transitionInDuration"

Inherited from: IgrDataAnnotationPointLayer 

transitionInDuration: number

transitionInEasingFunction

Section titled "transitionInEasingFunction"

Inherited from: IgrDataAnnotationPointLayer 

transitionInEasingFunction: object

transitionInSpeedType

Section titled "transitionInSpeedType"

Inherited from: IgrDataAnnotationPointLayer 

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Section titled "transitionOutCompleted"

Inherited from: IgrDataAnnotationPointLayer 

transitionOutCompleted: object

transitionOutDuration

Section titled "transitionOutDuration"

Inherited from: IgrDataAnnotationPointLayer 

transitionOutDuration: number

transitionOutEasingFunction

Section titled "transitionOutEasingFunction"

Inherited from: IgrDataAnnotationPointLayer 

transitionOutEasingFunction: object

transitionOutSpeedType

Section titled "transitionOutSpeedType"

Inherited from: IgrDataAnnotationPointLayer 

transitionOutSpeedType: TransitionOutSpeedType

useIndex

Section titled "useIndex"

Inherited from: IgrDataAnnotationPointLayer 

useIndex: boolean

useItemWiseColors

Section titled "useItemWiseColors"

Inherited from: IgrDataAnnotationPointLayer 

useItemWiseColors: boolean

useLegend

Section titled "useLegend"

Inherited from: IgrDataAnnotationPointLayer 

useLegend: boolean

useSingleShadow

Section titled "useSingleShadow"

Inherited from: IgrDataAnnotationPointLayer 

useSingleShadow: boolean

verticalAppearanceMode

Section titled "verticalAppearanceMode"

Inherited from: IgrDataAnnotationPointLayer 

verticalAppearanceMode: AnnotationAppearanceMode

verticalDashArray

Section titled "verticalDashArray"

Inherited from: IgrDataAnnotationPointLayer 

verticalDashArray: number[]

verticalShiftAmount

Section titled "verticalShiftAmount"

Inherited from: IgrDataAnnotationPointLayer 

verticalShiftAmount: number

visibility

Section titled "visibility"

Inherited from: IgrDataAnnotationPointLayer 

visibility: Visibility

visibleRangeMarginBottom

Section titled "visibleRangeMarginBottom"

Inherited from: IgrDataAnnotationPointLayer 

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Section titled "visibleRangeMarginLeft"

Inherited from: IgrDataAnnotationPointLayer 

visibleRangeMarginLeft: number

visibleRangeMarginRight

Section titled "visibleRangeMarginRight"

Inherited from: IgrDataAnnotationPointLayer 

visibleRangeMarginRight: number

visibleRangeMarginTop

Section titled "visibleRangeMarginTop"

Inherited from: IgrDataAnnotationPointLayer 

visibleRangeMarginTop: number

visibleRangeMode

Section titled "visibleRangeMode"

Inherited from: IgrDataAnnotationPointLayer 

visibleRangeMode: SeriesVisibleRangeMode

Accessors

Section titled "Accessors"

actualCloseLabel

Section titled "actualCloseLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Section titled "actualHighLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualHighLabel(): string

Returns string

actualLowLabel

Section titled "actualLowLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Section titled "actualOpenLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Section titled "actualRadiusLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Section titled "actualValueLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Section titled "actualVolumeLabel"

Inherited from: IgrDataAnnotationPointLayer

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Section titled "dataLegendKey"

Inherited from: IgrDataAnnotationPointLayer

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Section titled "hasMarkers"

Inherited from: IgrDataAnnotationPointLayer

Returns whether the current series supports visual markers.

``

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Section titled "hasOnlyMarkers"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Section titled "hasValueAxis"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Section titled "hasVisibleMarkers"

Inherited from: IgrDataAnnotationPointLayer

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Section titled "isAnnotationCalloutLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Section titled "isAnnotationCrosshairLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Section titled "isAnnotationDataLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is a data annotation layer that support binding to data source

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Section titled "isAnnotationFinalValue"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Section titled "isAnnotationHoverLayer"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "isAnnotationLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether this series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Section titled "isAnnotationValueLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Section titled "isArea"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Section titled "isAreaOrLine"

Inherited from: IgrDataAnnotationPointLayer

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

``

get isAreaOrLine(): boolean

Returns boolean

isBar

Section titled "isBar"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Section titled "isCategory"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a category type series.

``

get isCategory(): boolean

Returns boolean

isColoredItemwise

Section titled "isColoredItemwise"

Inherited from: IgrDataAnnotationPointLayer 

get isColoredItemwise(): boolean

Returns boolean

isColumn

Section titled "isColumn"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Section titled "isDefaultCrosshairBehaviorDisabled"

Inherited from: IgrDataAnnotationPointLayer

Gets whether or not the default crosshair behavior is disabled.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Section titled "isDefaultTooltipBehaviorDisabled"

Inherited from: IgrDataAnnotationPointLayer

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

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Section titled "isFinancial"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a financial type series.

``

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Section titled "isFinancialIndicator"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Section titled "isFinancialOverlay"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Section titled "isFinancialSeries"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Section titled "isFinancialWaterfall"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Section titled "isFragment"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

isGeographic

Section titled "isGeographic"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Section titled "isHighlightOverlay"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Section titled "isIndexed"

Inherited from: IgrDataAnnotationPointLayer

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

get isIndexed(): boolean

Returns boolean

isLayer

Section titled "isLayer"

Inherited from: IgrDataAnnotationPointLayer 

get isLayer(): boolean

Returns boolean

isLineContour

Section titled "isLineContour"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Section titled "isLineOnly"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Section titled "isMarkerlessDisplayPreferred"

Inherited from: IgrDataAnnotationPointLayer

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Section titled "isNegativeColorSupported"

Inherited from: IgrDataAnnotationPointLayer

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Section titled "isPie"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Section titled "isPixel"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Section titled "isPolar"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

isPolygon

Section titled "isPolygon"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Section titled "isPolyline"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Section titled "isRadial"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

isRange

Section titled "isRange"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

isScatter

Section titled "isScatter"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

isShape

Section titled "isShape"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Section titled "isShapeControl"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Section titled "isSpline"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Section titled "isStacked"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is a stacked type series.

``

get isStacked(): boolean

Returns boolean

isStep

Section titled "isStep"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Section titled "isSummarizationSupported"

Inherited from: IgrDataAnnotationPointLayer

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Section titled "isTile"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Section titled "isToolTipLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Section titled "isUsableInLegend"

Inherited from: IgrDataAnnotationPointLayer

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Section titled "isUserAnnotationLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Section titled "isUserAnnotationToolTipLayer"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Section titled "isValueAxisInverted"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Section titled "isValueOverlay"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Section titled "isVertical"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

isWaterfall

Section titled "isWaterfall"

Inherited from: IgrDataAnnotationPointLayer

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Section titled "seriesInternal"

Inherited from: IgrDataAnnotationPointLayer 

get seriesInternal(): any

Returns any

i

Section titled "i" 
get i(): Series

Returns Series

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

Returns void

bindSeries

Section titled "bindSeries"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

Returns void

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrDataAnnotationPointLayer 

componentDidMount(): void

Returns void

ensureAnnotationPadding

Section titled "ensureAnnotationPadding"

Inherited from: IgrDataAnnotationPointLayer 

ensureAnnotationPadding(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrDataAnnotationPointLayer 

findByName(name: string): any

Parameters

  • name: string

Returns any

fromWorld

Section titled "fromWorld"

Inherited from: IgrDataAnnotationPointLayer

Converts world coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's size

fromWorld(world: IgPoint): IgPoint

Parameters

  • world: IgPoint

Returns IgPoint

fromWorldPosition

Section titled "fromWorldPosition"

Inherited from: IgrDataAnnotationPointLayer

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

fromWorldX

Section titled "fromWorldX"

Inherited from: IgrDataAnnotationPointLayer

Converts world X coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's width

fromWorldX(x: number): number

Parameters

  • x: number

Returns number

fromWorldY

Section titled "fromWorldY"

Inherited from: IgrDataAnnotationPointLayer

Converts world Y coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's height

fromWorldY(y: number): number

Parameters

  • y: number

Returns number

getEffectiveViewport

Section titled "getEffectiveViewport"

Inherited from: IgrDataAnnotationPointLayer

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Section titled "getExactItemIndex"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getItem"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getItemIndex"

Inherited from: IgrDataAnnotationPointLayer

Gets the item index associated with the specified world position

``

getItemIndex(world: IgPoint): number

Parameters

  • world: IgPoint

Returns number

getItemSpan

Section titled "getItemSpan"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getItemValue"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMainContentViewport

Section titled "getMainContentViewport"

Inherited from: IgrDataAnnotationPointLayer 

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getNextOrExactIndex"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getSeriesValueFromSeriesPixel"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "getSeriesValuePosition"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Section titled "getSeriesValueType"

Inherited from: IgrDataAnnotationPointLayer

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

Returns number[]

getSeriesValueTypePosition

Section titled "getSeriesValueTypePosition"

Inherited from: IgrDataAnnotationPointLayer

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgrDataAnnotationPointLayer 

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

getUnscaledPosition

Section titled "getUnscaledPosition"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "hideToolTips"

Inherited from: IgrDataAnnotationPointLayer

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Section titled "hideToolTipsImmediate"

Inherited from: IgrDataAnnotationPointLayer

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Section titled "moveCursorPoint"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgrDataAnnotationPointLayer

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Section titled "notifyVisualPropertiesChanged"

Inherited from: IgrDataAnnotationPointLayer

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Section titled "playTransitionIn"

Inherited from: IgrDataAnnotationPointLayer

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Section titled "playTransitionOut"

Inherited from: IgrDataAnnotationPointLayer

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Section titled "playTransitionOutAndRemove"

Inherited from: IgrDataAnnotationPointLayer

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Section titled "provideData"

Inherited from: IgrDataAnnotationPointLayer 

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

provideHighlightedData

Section titled "provideHighlightedData"

Inherited from: IgrDataAnnotationPointLayer 

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

removeAllAlternateViews

Section titled "removeAllAlternateViews"

Inherited from: IgrDataAnnotationPointLayer

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Section titled "removeAlternateView"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "removeAxes"

Inherited from: IgrDataAnnotationPointLayer

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Section titled "render"

Inherited from: IgrDataAnnotationPointLayer 

render(): any

Returns any

renderSeries

Section titled "renderSeries"

Inherited from: IgrDataAnnotationPointLayer

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Section titled "replayTransitionIn"

Inherited from: IgrDataAnnotationPointLayer

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Section titled "resolveTooltipBrush"

Inherited from: IgrDataAnnotationPointLayer

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Section titled "scrollIntoView"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "setNegativeColors"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrDataAnnotationPointLayer 

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateHover

Section titled "simulateHover"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "styleUpdated"

Inherited from: IgrDataAnnotationPointLayer

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorld

Section titled "toWorld"

Inherited from: IgrDataAnnotationPointLayer

Converts pixel coordinate (relative to component's size) to world coordinate (0.0 - 1.0)

toWorld(pixel: IgPoint): IgPoint

Parameters

  • pixel: IgPoint

Returns IgPoint

toWorldPosition

Section titled "toWorldPosition"

Inherited from: IgrDataAnnotationPointLayer

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

Section titled "toWorldRect"

Inherited from: IgrDataAnnotationPointLayer

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

toWorldX

Section titled "toWorldX"

Inherited from: IgrDataAnnotationPointLayer

Converts pixel X coordinate (relative to component's width) to world coordinate (0.0 - 1.0)

toWorldX(x: number): number

Parameters

  • x: number

Returns number

toWorldY

Section titled "toWorldY"

Inherited from: IgrDataAnnotationPointLayer

Converts pixel Y coordinate (relative to component's height) to world coordinate (0.0 - 1.0)

toWorldY(y: number): number

Parameters

  • y: number

Returns number

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrDataAnnotationPointLayer 

_createFromInternal(internal: any): IgrSeries

Parameters

  • internal: any

Returns IgrSeries