Represents a base of annotation layers that render from start/end range
Constructors
Section titled "Constructors"IgrDataAnnotationRangeLayer
new IgrDataAnnotationRangeLayer(props: P): IgrDataAnnotationRangeLayer Returns IgrDataAnnotationRangeLayer
Properties
Section titled "Properties"actualAppearanceMode
Section titled "actualAppearanceMode"Inherited from: IgrDataAnnotationShapeLayer
actualAppearanceMode: AnnotationAppearanceMode actualAreaFillOpacity
Section titled "actualAreaFillOpacity"Inherited from: IgrDataAnnotationShapeLayer
actualAreaFillOpacity: number actualBrush
Section titled "actualBrush"Inherited from: IgrDataAnnotationShapeLayer
actualBrush: string actualDashArray
Section titled "actualDashArray"Inherited from: IgrDataAnnotationShapeLayer
actualDashArray: number[] actualDashCap
Section titled "actualDashCap"Inherited from: IgrDataAnnotationShapeLayer
actualDashCap: PenLineCap actualFocusBrush
Section titled "actualFocusBrush"Inherited from: IgrDataAnnotationShapeLayer
actualFocusBrush: string actualFocusMode
Section titled "actualFocusMode"Inherited from: IgrDataAnnotationShapeLayer
actualFocusMode: SeriesSelectionMode actualHighlightedValuesFadeOpacity
Section titled "actualHighlightedValuesFadeOpacity"Inherited from: IgrDataAnnotationShapeLayer
actualHighlightedValuesFadeOpacity: number actualHighlightingFadeOpacity
Section titled "actualHighlightingFadeOpacity"Inherited from: IgrDataAnnotationShapeLayer
actualHighlightingFadeOpacity: number actualHighlightingMode
Section titled "actualHighlightingMode"Inherited from: IgrDataAnnotationShapeLayer
actualHighlightingMode: SeriesHighlightingMode actualHitTestMode
Section titled "actualHitTestMode"Inherited from: IgrDataAnnotationShapeLayer
actualHitTestMode: SeriesHitTestMode actualHorizontalAppearanceMode
Section titled "actualHorizontalAppearanceMode"Inherited from: IgrDataAnnotationShapeLayer
actualHorizontalAppearanceMode: AnnotationAppearanceMode actualHorizontalDashArray
Section titled "actualHorizontalDashArray"Inherited from: IgrDataAnnotationShapeLayer
actualHorizontalDashArray: number[] actualHorizontalShiftAmount
Section titled "actualHorizontalShiftAmount"Inherited from: IgrDataAnnotationShapeLayer
actualHorizontalShiftAmount: number actualLayers
Section titled "actualLayers"Inherited from: IgrDataAnnotationShapeLayer
actualLayers: IgrSeriesLayerCollection actualLegendItemBadgeBrush
Section titled "actualLegendItemBadgeBrush"Inherited from: IgrDataAnnotationShapeLayer
actualLegendItemBadgeBrush: string actualLegendItemBadgeOutline
Section titled "actualLegendItemBadgeOutline"Inherited from: IgrDataAnnotationShapeLayer
actualLegendItemBadgeOutline: string actualLegendItemBadgeTemplate
Section titled "actualLegendItemBadgeTemplate"Inherited from: IgrDataAnnotationShapeLayer
actualLegendItemBadgeTemplate: IgDataTemplate actualMarkerFillOpacity
Section titled "actualMarkerFillOpacity"Inherited from: IgrDataAnnotationShapeLayer
actualMarkerFillOpacity: number actualOutline
Section titled "actualOutline"Inherited from: IgrDataAnnotationShapeLayer
actualOutline: string actualResolution
Section titled "actualResolution"Inherited from: IgrDataAnnotationShapeLayer
actualResolution: number actualSelectionBrush
Section titled "actualSelectionBrush"Inherited from: IgrDataAnnotationShapeLayer
actualSelectionBrush: string actualSelectionMode
Section titled "actualSelectionMode"Inherited from: IgrDataAnnotationShapeLayer
actualSelectionMode: SeriesSelectionMode actualShiftAmount
Section titled "actualShiftAmount"Inherited from: IgrDataAnnotationShapeLayer
actualShiftAmount: number actualThickness
Section titled "actualThickness"Inherited from: IgrDataAnnotationShapeLayer
actualThickness: number actualVerticalAppearanceMode
Section titled "actualVerticalAppearanceMode"Inherited from: IgrDataAnnotationShapeLayer
actualVerticalAppearanceMode: AnnotationAppearanceMode actualVerticalDashArray
Section titled "actualVerticalDashArray"Inherited from: IgrDataAnnotationShapeLayer
actualVerticalDashArray: number[] actualVerticalShiftAmount
Section titled "actualVerticalShiftAmount"Inherited from: IgrDataAnnotationShapeLayer
actualVerticalShiftAmount: number annotationBackground
Section titled "annotationBackground"Inherited from: IgrDataAnnotationShapeLayer
annotationBackground: string annotationBackgroundMatchLayer
Section titled "annotationBackgroundMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
annotationBackgroundMatchLayer: boolean annotationBackgroundMode
Section titled "annotationBackgroundMode"Inherited from: IgrDataAnnotationShapeLayer
annotationBackgroundMode: AnnotationAppearanceMode annotationBackgroundShift
Section titled "annotationBackgroundShift"Inherited from: IgrDataAnnotationShapeLayer
annotationBackgroundShift: number annotationBadgeBackground
Section titled "annotationBadgeBackground"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeBackground: string annotationBadgeCornerRadius
Section titled "annotationBadgeCornerRadius"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeCornerRadius: number annotationBadgeEnabled
Section titled "annotationBadgeEnabled"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeEnabled: boolean annotationBadgeImagePath
Section titled "annotationBadgeImagePath"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeImagePath: string annotationBadgeMargin
Section titled "annotationBadgeMargin"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeMargin: number annotationBadgeOutline
Section titled "annotationBadgeOutline"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeOutline: string annotationBadgeOutlineThickness
Section titled "annotationBadgeOutlineThickness"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeOutlineThickness: number annotationBadgeSize
Section titled "annotationBadgeSize"Inherited from: IgrDataAnnotationShapeLayer
annotationBadgeSize: number annotationBorderColor
Section titled "annotationBorderColor"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderColor: string annotationBorderMatchLayer
Section titled "annotationBorderMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderMatchLayer: boolean annotationBorderMode
Section titled "annotationBorderMode"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderMode: AnnotationAppearanceMode annotationBorderRadius
Section titled "annotationBorderRadius"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderRadius: number annotationBorderShift
Section titled "annotationBorderShift"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderShift: number annotationBorderThickness
Section titled "annotationBorderThickness"Inherited from: IgrDataAnnotationShapeLayer
annotationBorderThickness: number annotationLabelDisplayMode
Section titled "annotationLabelDisplayMode"Inherited from: IgrDataAnnotationShapeLayer
annotationLabelDisplayMode: DataAnnotationDisplayMode annotationLabelVisible
Section titled "annotationLabelVisible"Inherited from: IgrDataAnnotationShapeLayer
annotationLabelVisible: boolean annotationPaddingBottom
Section titled "annotationPaddingBottom"Inherited from: IgrDataAnnotationShapeLayer
annotationPaddingBottom: number annotationPaddingLeft
Section titled "annotationPaddingLeft"Inherited from: IgrDataAnnotationShapeLayer
annotationPaddingLeft: number annotationPaddingRight
Section titled "annotationPaddingRight"Inherited from: IgrDataAnnotationShapeLayer
annotationPaddingRight: number annotationPaddingTop
Section titled "annotationPaddingTop"Inherited from: IgrDataAnnotationShapeLayer
annotationPaddingTop: number annotationShapeVisible
Section titled "annotationShapeVisible"Inherited from: IgrDataAnnotationShapeLayer
annotationShapeVisible: boolean annotationTextColor
Section titled "annotationTextColor"Inherited from: IgrDataAnnotationShapeLayer
annotationTextColor: string annotationTextColorMatchLayer
Section titled "annotationTextColorMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
annotationTextColorMatchLayer: boolean annotationTextColorMode
Section titled "annotationTextColorMode"Inherited from: IgrDataAnnotationShapeLayer
annotationTextColorMode: AnnotationAppearanceMode annotationTextColorShift
Section titled "annotationTextColorShift"Inherited from: IgrDataAnnotationShapeLayer
annotationTextColorShift: number annotationValueMaxPrecision
Section titled "annotationValueMaxPrecision"Inherited from: IgrDataAnnotationShapeLayer
annotationValueMaxPrecision: number annotationValueMinPrecision
Section titled "annotationValueMinPrecision"Inherited from: IgrDataAnnotationShapeLayer
annotationValueMinPrecision: number appearanceMode
Section titled "appearanceMode"Inherited from: IgrDataAnnotationShapeLayer
appearanceMode: AnnotationAppearanceMode areaFillOpacity
Section titled "areaFillOpacity"Inherited from: IgrDataAnnotationShapeLayer
areaFillOpacity: number attachTooltipToRoot
Section titled "attachTooltipToRoot"Inherited from: IgrDataAnnotationShapeLayer
attachTooltipToRoot: boolean autoCalloutLabelFormat
Section titled "autoCalloutLabelFormat"Inherited from: IgrDataAnnotationShapeLayer
autoCalloutLabelFormat: string autoCalloutLabelFormatSpecifiers
Section titled "autoCalloutLabelFormatSpecifiers"Inherited from: IgrDataAnnotationShapeLayer
autoCalloutLabelFormatSpecifiers: any[] autoCalloutValueLabelFormat
Section titled "autoCalloutValueLabelFormat"Inherited from: IgrDataAnnotationShapeLayer
autoCalloutValueLabelFormat: string autoCalloutValueLabelFormatSpecifiers
Section titled "autoCalloutValueLabelFormatSpecifiers"Inherited from: IgrDataAnnotationShapeLayer
autoCalloutValueLabelFormatSpecifiers: any[] brush
Section titled "brush"Inherited from: IgrDataAnnotationShapeLayer
brush: string centerLabelBackground
Section titled "centerLabelBackground"centerLabelBackground: string centerLabelBorderColor
Section titled "centerLabelBorderColor"centerLabelBorderColor: string centerLabelTextColor
Section titled "centerLabelTextColor"centerLabelTextColor: string coercionMethods
Section titled "coercionMethods"Inherited from: IgrDataAnnotationShapeLayer
coercionMethods: any cursorPosition
Section titled "cursorPosition"Inherited from: IgrDataAnnotationShapeLayer
cursorPosition: IgPoint cursorPositionUpdatesOnMove
Section titled "cursorPositionUpdatesOnMove"Inherited from: IgrDataAnnotationShapeLayer
cursorPositionUpdatesOnMove: boolean dashArray
Section titled "dashArray"Inherited from: IgrDataAnnotationShapeLayer
dashArray: number[] dataLegendGroup
Section titled "dataLegendGroup"Inherited from: IgrDataAnnotationShapeLayer
dataLegendGroup: string dataSource
Section titled "dataSource"Inherited from: IgrDataAnnotationShapeLayer
dataSource: any discreteLegendItemTemplate
Section titled "discreteLegendItemTemplate"Inherited from: IgrDataAnnotationShapeLayer
discreteLegendItemTemplate: IgDataTemplate endLabelBackground
Section titled "endLabelBackground"endLabelBackground: string endLabelBorderColor
Section titled "endLabelBorderColor"endLabelBorderColor: string endLabelTextColor
Section titled "endLabelTextColor"endLabelTextColor: string expectFunctions
Section titled "expectFunctions"Inherited from: IgrDataAnnotationShapeLayer
expectFunctions: boolean finalValue
Section titled "finalValue"Inherited from: IgrDataAnnotationShapeLayer
finalValue: number focusBrush
Section titled "focusBrush"Inherited from: IgrDataAnnotationShapeLayer
focusBrush: string highlightedDataSource
Section titled "highlightedDataSource"Inherited from: IgrDataAnnotationShapeLayer
highlightedDataSource: any highlightedLegendItemVisibility
Section titled "highlightedLegendItemVisibility"Inherited from: IgrDataAnnotationShapeLayer
highlightedLegendItemVisibility: Visibility highlightedTitleSuffix
Section titled "highlightedTitleSuffix"Inherited from: IgrDataAnnotationShapeLayer
highlightedTitleSuffix: string highlightedValuesDataLegendGroup
Section titled "highlightedValuesDataLegendGroup"Inherited from: IgrDataAnnotationShapeLayer
highlightedValuesDataLegendGroup: string highlightedValuesDisplayMode
Section titled "highlightedValuesDisplayMode"Inherited from: IgrDataAnnotationShapeLayer
highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode highlightedValuesExtraPropertyOverlays
Section titled "highlightedValuesExtraPropertyOverlays"Inherited from: IgrDataAnnotationShapeLayer
highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection highlightedValuesFadeOpacity
Section titled "highlightedValuesFadeOpacity"Inherited from: IgrDataAnnotationShapeLayer
highlightedValuesFadeOpacity: number highlightingFadeOpacity
Section titled "highlightingFadeOpacity"Inherited from: IgrDataAnnotationShapeLayer
highlightingFadeOpacity: number hitTestMode
Section titled "hitTestMode"Inherited from: IgrDataAnnotationShapeLayer
hitTestMode: SeriesHitTestMode horizontalAppearanceMode
Section titled "horizontalAppearanceMode"Inherited from: IgrDataAnnotationShapeLayer
horizontalAppearanceMode: AnnotationAppearanceMode horizontalDashArray
Section titled "horizontalDashArray"Inherited from: IgrDataAnnotationShapeLayer
horizontalDashArray: number[] horizontalShiftAmount
Section titled "horizontalShiftAmount"Inherited from: IgrDataAnnotationShapeLayer
horizontalShiftAmount: number index
Section titled "index"Inherited from: IgrDataAnnotationShapeLayer
index: number isActualLegendFinancial
Section titled "isActualLegendFinancial"Inherited from: IgrDataAnnotationShapeLayer
isActualLegendFinancial: boolean isComponentHighlightingModeIgnored
Section titled "isComponentHighlightingModeIgnored"Inherited from: IgrDataAnnotationShapeLayer
isComponentHighlightingModeIgnored: boolean isDefaultCrosshairDisabled
Section titled "isDefaultCrosshairDisabled"Inherited from: IgrDataAnnotationShapeLayer
isDefaultCrosshairDisabled: boolean isDefaultToolTipSelected
Section titled "isDefaultToolTipSelected"Inherited from: IgrDataAnnotationShapeLayer
isDefaultToolTipSelected: boolean isDropShadowEnabled
Section titled "isDropShadowEnabled"Inherited from: IgrDataAnnotationShapeLayer
isDropShadowEnabled: boolean isHighlightingEnabled
Section titled "isHighlightingEnabled"Inherited from: IgrDataAnnotationShapeLayer
isHighlightingEnabled: boolean isTargetingHorizontalAxis
Section titled "isTargetingHorizontalAxis"Inherited from: IgrDataAnnotationShapeLayer
isTargetingHorizontalAxis: boolean itemsUseWorldCoordinates
Section titled "itemsUseWorldCoordinates"Inherited from: IgrDataAnnotationShapeLayer
itemsUseWorldCoordinates: boolean layers
Section titled "layers"Inherited from: IgrDataAnnotationShapeLayer
layers: IgrSeriesLayerCollection legend
Section titled "legend"Inherited from: IgrDataAnnotationShapeLayer
legend: any legendItemBadgeMode
Section titled "legendItemBadgeMode"Inherited from: IgrDataAnnotationShapeLayer
legendItemBadgeMode: LegendItemBadgeMode legendItemBadgeShape
Section titled "legendItemBadgeShape"Inherited from: IgrDataAnnotationShapeLayer
legendItemBadgeShape: LegendItemBadgeShape legendItemBadgeTemplate
Section titled "legendItemBadgeTemplate"Inherited from: IgrDataAnnotationShapeLayer
legendItemBadgeTemplate: IgDataTemplate legendItemTemplate
Section titled "legendItemTemplate"Inherited from: IgrDataAnnotationShapeLayer
legendItemTemplate: IgDataTemplate legendItemVisibility
Section titled "legendItemVisibility"Inherited from: IgrDataAnnotationShapeLayer
legendItemVisibility: Visibility lineCap
Section titled "lineCap"Inherited from: IgrDataAnnotationShapeLayer
lineCap: PenLineCap lineJoin
Section titled "lineJoin"Inherited from: IgrDataAnnotationShapeLayer
lineJoin: PenLineJoin markerFillOpacity
Section titled "markerFillOpacity"Inherited from: IgrDataAnnotationShapeLayer
markerFillOpacity: number mouseOverEnabled
Section titled "mouseOverEnabled"Inherited from: IgrDataAnnotationShapeLayer
mouseOverEnabled: boolean Inherited from: IgrDataAnnotationShapeLayer
name: string opacity
Section titled "opacity"Inherited from: IgrDataAnnotationShapeLayer
opacity: number outline
Section titled "outline"Inherited from: IgrDataAnnotationShapeLayer
outline: string outlineMode
Section titled "outlineMode"Inherited from: IgrDataAnnotationShapeLayer
outlineMode: SeriesOutlineMode overlayText
Section titled "overlayText"Inherited from: IgrDataAnnotationShapeLayer
overlayText: string overlayTextAngle
Section titled "overlayTextAngle"Inherited from: IgrDataAnnotationShapeLayer
overlayTextAngle: number overlayTextBackground
Section titled "overlayTextBackground"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBackground: string overlayTextBackgroundMatchLayer
Section titled "overlayTextBackgroundMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBackgroundMatchLayer: boolean overlayTextBackgroundMode
Section titled "overlayTextBackgroundMode"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBackgroundMode: AnnotationAppearanceMode overlayTextBackgroundShift
Section titled "overlayTextBackgroundShift"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBackgroundShift: number overlayTextBorderColor
Section titled "overlayTextBorderColor"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderColor: string overlayTextBorderMatchLayer
Section titled "overlayTextBorderMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderMatchLayer: boolean overlayTextBorderMode
Section titled "overlayTextBorderMode"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderMode: AnnotationAppearanceMode overlayTextBorderRadius
Section titled "overlayTextBorderRadius"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderRadius: number overlayTextBorderShift
Section titled "overlayTextBorderShift"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderShift: number overlayTextBorderThickness
Section titled "overlayTextBorderThickness"Inherited from: IgrDataAnnotationShapeLayer
overlayTextBorderThickness: number overlayTextColor
Section titled "overlayTextColor"Inherited from: IgrDataAnnotationShapeLayer
overlayTextColor: string overlayTextColorMatchLayer
Section titled "overlayTextColorMatchLayer"Inherited from: IgrDataAnnotationShapeLayer
overlayTextColorMatchLayer: boolean overlayTextColorMode
Section titled "overlayTextColorMode"Inherited from: IgrDataAnnotationShapeLayer
overlayTextColorMode: AnnotationAppearanceMode overlayTextColorShift
Section titled "overlayTextColorShift"Inherited from: IgrDataAnnotationShapeLayer
overlayTextColorShift: number overlayTextHorizontalMargin
Section titled "overlayTextHorizontalMargin"Inherited from: IgrDataAnnotationShapeLayer
overlayTextHorizontalMargin: number overlayTextHorizontalPadding
Section titled "overlayTextHorizontalPadding"Inherited from: IgrDataAnnotationShapeLayer
overlayTextHorizontalPadding: number overlayTextLocation
Section titled "overlayTextLocation"Inherited from: IgrDataAnnotationShapeLayer
overlayTextLocation: OverlayTextLocation overlayTextMemberPath
Section titled "overlayTextMemberPath"Inherited from: IgrDataAnnotationShapeLayer
overlayTextMemberPath: string overlayTextStyle
Section titled "overlayTextStyle"Inherited from: IgrDataAnnotationShapeLayer
overlayTextStyle: string overlayTextVerticalMargin
Section titled "overlayTextVerticalMargin"Inherited from: IgrDataAnnotationShapeLayer
overlayTextVerticalMargin: number overlayTextVerticalPadding
Section titled "overlayTextVerticalPadding"Inherited from: IgrDataAnnotationShapeLayer
overlayTextVerticalPadding: number overlayTextVisible
Section titled "overlayTextVisible"Inherited from: IgrDataAnnotationShapeLayer
overlayTextVisible: boolean percentChange
Section titled "percentChange"Inherited from: IgrDataAnnotationShapeLayer
percentChange: number renderRequested
Section titled "renderRequested"Inherited from: IgrDataAnnotationShapeLayer
renderRequested: object resolution
Section titled "resolution"Inherited from: IgrDataAnnotationShapeLayer
resolution: number safeActualBrush
Section titled "safeActualBrush"Inherited from: IgrDataAnnotationShapeLayer
safeActualBrush: string selectionBrush
Section titled "selectionBrush"Inherited from: IgrDataAnnotationShapeLayer
selectionBrush: string selectionThickness
Section titled "selectionThickness"Inherited from: IgrDataAnnotationShapeLayer
selectionThickness: number shadowBlur
Section titled "shadowBlur"Inherited from: IgrDataAnnotationShapeLayer
shadowBlur: number shadowColor
Section titled "shadowColor"Inherited from: IgrDataAnnotationShapeLayer
shadowColor: string shadowOffsetX
Section titled "shadowOffsetX"Inherited from: IgrDataAnnotationShapeLayer
shadowOffsetX: number shadowOffsetY
Section titled "shadowOffsetY"Inherited from: IgrDataAnnotationShapeLayer
shadowOffsetY: number shiftAmount
Section titled "shiftAmount"Inherited from: IgrDataAnnotationShapeLayer
shiftAmount: number shouldAnimateOnDataSourceSwap
Section titled "shouldAnimateOnDataSourceSwap"Inherited from: IgrDataAnnotationShapeLayer
shouldAnimateOnDataSourceSwap: boolean shouldHideAutoCallouts
Section titled "shouldHideAutoCallouts"Inherited from: IgrDataAnnotationShapeLayer
shouldHideAutoCallouts: boolean shouldRemoveHighlightedDataOnLayerHidden
Section titled "shouldRemoveHighlightedDataOnLayerHidden"Inherited from: IgrDataAnnotationShapeLayer
shouldRemoveHighlightedDataOnLayerHidden: boolean shouldRenderAsOverlay
Section titled "shouldRenderAsOverlay"Inherited from: IgrDataAnnotationShapeLayer
shouldRenderAsOverlay: boolean shouldShiftOpacityForSafeActualBrush
Section titled "shouldShiftOpacityForSafeActualBrush"Inherited from: IgrDataAnnotationShapeLayer
shouldShiftOpacityForSafeActualBrush: boolean showDefaultTooltip
Section titled "showDefaultTooltip"Inherited from: IgrDataAnnotationShapeLayer
showDefaultTooltip: boolean startLabelBackground
Section titled "startLabelBackground"startLabelBackground: string startLabelBorderColor
Section titled "startLabelBorderColor"startLabelBorderColor: string startLabelTextColor
Section titled "startLabelTextColor"startLabelTextColor: string stylingAxisAnnotation
Section titled "stylingAxisAnnotation"Inherited from: IgrDataAnnotationShapeLayer
stylingAxisAnnotation: object stylingOverlayText
Section titled "stylingOverlayText"Inherited from: IgrDataAnnotationShapeLayer
stylingOverlayText: object stylingShapeAnnotation
Section titled "stylingShapeAnnotation"Inherited from: IgrDataAnnotationShapeLayer
stylingShapeAnnotation: object targetAxis
Section titled "targetAxis"Inherited from: IgrDataAnnotationShapeLayer
targetAxis: IgrAxis targetAxisName
Section titled "targetAxisName"Inherited from: IgrDataAnnotationShapeLayer
targetAxisName: string targetMode
Section titled "targetMode"Inherited from: IgrDataAnnotationShapeLayer
targetMode: DataAnnotationTargetMode thickness
Section titled "thickness"Inherited from: IgrDataAnnotationShapeLayer
thickness: number title
Section titled "title"Inherited from: IgrDataAnnotationShapeLayer
title: any tooltipContainerTemplate
Section titled "tooltipContainerTemplate"Inherited from: IgrDataAnnotationShapeLayer
tooltipContainerTemplate: any tooltipTemplate
Section titled "tooltipTemplate"Inherited from: IgrDataAnnotationShapeLayer
tooltipTemplate: any transitionDuration
Section titled "transitionDuration"Inherited from: IgrDataAnnotationShapeLayer
transitionDuration: number transitionEasingFunction
Section titled "transitionEasingFunction"Inherited from: IgrDataAnnotationShapeLayer
transitionEasingFunction: object transitionInDuration
Section titled "transitionInDuration"Inherited from: IgrDataAnnotationShapeLayer
transitionInDuration: number transitionInEasingFunction
Section titled "transitionInEasingFunction"Inherited from: IgrDataAnnotationShapeLayer
transitionInEasingFunction: object transitionInSpeedType
Section titled "transitionInSpeedType"Inherited from: IgrDataAnnotationShapeLayer
transitionInSpeedType: TransitionInSpeedType transitionOutCompleted
Section titled "transitionOutCompleted"Inherited from: IgrDataAnnotationShapeLayer
transitionOutCompleted: object transitionOutDuration
Section titled "transitionOutDuration"Inherited from: IgrDataAnnotationShapeLayer
transitionOutDuration: number transitionOutEasingFunction
Section titled "transitionOutEasingFunction"Inherited from: IgrDataAnnotationShapeLayer
transitionOutEasingFunction: object transitionOutSpeedType
Section titled "transitionOutSpeedType"Inherited from: IgrDataAnnotationShapeLayer
transitionOutSpeedType: TransitionOutSpeedType useIndex
Section titled "useIndex"Inherited from: IgrDataAnnotationShapeLayer
useIndex: boolean useItemWiseColors
Section titled "useItemWiseColors"Inherited from: IgrDataAnnotationShapeLayer
useItemWiseColors: boolean useLegend
Section titled "useLegend"Inherited from: IgrDataAnnotationShapeLayer
useLegend: boolean useSingleShadow
Section titled "useSingleShadow"Inherited from: IgrDataAnnotationShapeLayer
useSingleShadow: boolean verticalAppearanceMode
Section titled "verticalAppearanceMode"Inherited from: IgrDataAnnotationShapeLayer
verticalAppearanceMode: AnnotationAppearanceMode verticalDashArray
Section titled "verticalDashArray"Inherited from: IgrDataAnnotationShapeLayer
verticalDashArray: number[] verticalShiftAmount
Section titled "verticalShiftAmount"Inherited from: IgrDataAnnotationShapeLayer
verticalShiftAmount: number visibility
Section titled "visibility"Inherited from: IgrDataAnnotationShapeLayer
visibility: Visibility visibleRangeMarginBottom
Section titled "visibleRangeMarginBottom"Inherited from: IgrDataAnnotationShapeLayer
visibleRangeMarginBottom: number visibleRangeMarginLeft
Section titled "visibleRangeMarginLeft"Inherited from: IgrDataAnnotationShapeLayer
visibleRangeMarginLeft: number visibleRangeMarginRight
Section titled "visibleRangeMarginRight"Inherited from: IgrDataAnnotationShapeLayer
visibleRangeMarginRight: number visibleRangeMarginTop
Section titled "visibleRangeMarginTop"Inherited from: IgrDataAnnotationShapeLayer
visibleRangeMarginTop: number visibleRangeMode
Section titled "visibleRangeMode"Inherited from: IgrDataAnnotationShapeLayer
visibleRangeMode: SeriesVisibleRangeMode Accessors
Section titled "Accessors"actualCloseLabel
Section titled "actualCloseLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Close label in the tooltip.
get actualCloseLabel(): string Returns string
actualHighLabel
Section titled "actualHighLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the High label in the tooltip.
get actualHighLabel(): string Returns string
actualLowLabel
Section titled "actualLowLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Low label in the tooltip.
get actualLowLabel(): string Returns string
actualOpenLabel
Section titled "actualOpenLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Open label in the tooltip.
get actualOpenLabel(): string Returns string
actualRadiusLabel
Section titled "actualRadiusLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Value label in the tooltip.
get actualRadiusLabel(): string Returns string
actualValueLabel
Section titled "actualValueLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Value label in the tooltip.
get actualValueLabel(): string Returns string
actualVolumeLabel
Section titled "actualVolumeLabel"Inherited from: IgrDataAnnotationShapeLayer
Gets the text that is displayed for the Volume label in the tooltip.
get actualVolumeLabel(): string Returns string
dataLegendKey
Section titled "dataLegendKey"Inherited from: IgrDataAnnotationShapeLayer
Gets unique key used to identify the series in data legend
get dataLegendKey(): string Returns string
hasMarkers
Section titled "hasMarkers"Inherited from: IgrDataAnnotationShapeLayer
Returns whether the current series supports visual markers.
``
get hasMarkers(): boolean Returns boolean
hasOnlyMarkers
Section titled "hasOnlyMarkers"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series has only marker as visuals
get hasOnlyMarkers(): boolean Returns boolean
hasValueAxis
Section titled "hasValueAxis"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows an area shape.
get hasValueAxis(): boolean Returns boolean
hasVisibleMarkers
Section titled "hasVisibleMarkers"Inherited from: IgrDataAnnotationShapeLayer
Returns whether the current series has a visible marker style.
get hasVisibleMarkers(): boolean Returns boolean
isAnnotationCalloutLayer
Section titled "isAnnotationCalloutLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is an callout annotation layer.
get isAnnotationCalloutLayer(): boolean Returns boolean
isAnnotationCrosshairLayer
Section titled "isAnnotationCrosshairLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is an crosshair annotation layer.
get isAnnotationCrosshairLayer(): boolean Returns boolean
isAnnotationDataLayer
Section titled "isAnnotationDataLayer"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Gets whether the series is final value annotation layer.
get isAnnotationFinalValue(): boolean Returns boolean
isAnnotationHoverLayer
Section titled "isAnnotationHoverLayer"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Gets whether this series is an annotation layer.
get isAnnotationLayer(): boolean Returns boolean
isAnnotationValueLayer
Section titled "isAnnotationValueLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is a value annotation layer.
get isAnnotationValueLayer(): boolean Returns boolean
isArea
Section titled "isArea"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows an area shape.
get isArea(): boolean Returns boolean
isAreaOrLine
Section titled "isAreaOrLine"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows an area or line shape.
``
get isAreaOrLine(): boolean Returns boolean
isBar
Section titled "isBar"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a horizontal column shape.
get isBar(): boolean Returns boolean
isCategory
Section titled "isCategory"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a category type series.
``
get isCategory(): boolean Returns boolean
isColoredItemwise
Section titled "isColoredItemwise"Inherited from: IgrDataAnnotationShapeLayer
get isColoredItemwise(): boolean Returns boolean
isColumn
Section titled "isColumn"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a column shape.
get isColumn(): boolean Returns boolean
isDefaultCrosshairBehaviorDisabled
Section titled "isDefaultCrosshairBehaviorDisabled"Inherited from: IgrDataAnnotationShapeLayer
Gets whether or not the default crosshair behavior is disabled.
get isDefaultCrosshairBehaviorDisabled(): boolean Returns boolean
isDefaultTooltipBehaviorDisabled
Section titled "isDefaultTooltipBehaviorDisabled"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Gets whether the current series is a financial type series.
``
get isFinancial(): boolean Returns boolean
isFinancialIndicator
Section titled "isFinancialIndicator"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is financial indicator
get isFinancialIndicator(): boolean Returns boolean
isFinancialOverlay
Section titled "isFinancialOverlay"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is financial overlay
get isFinancialOverlay(): boolean Returns boolean
isFinancialSeries
Section titled "isFinancialSeries"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series has financial OHLC/candlestick visuals
get isFinancialSeries(): boolean Returns boolean
isFinancialWaterfall
Section titled "isFinancialWaterfall"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is financial waterfall
get isFinancialWaterfall(): boolean Returns boolean
isFragment
Section titled "isFragment"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a stack fragment.
``
get isFragment(): boolean Returns boolean
isGeographic
Section titled "isGeographic"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a geographic series.
``
get isGeographic(): boolean Returns boolean
isHighlightOverlay
Section titled "isHighlightOverlay"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is a highlight overlay.
get isHighlightOverlay(): boolean Returns boolean
isIndexed
Section titled "isIndexed"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
get isLayer(): boolean Returns boolean
isLineContour
Section titled "isLineContour"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a line contour shape.
get isLineContour(): boolean Returns boolean
isLineOnly
Section titled "isLineOnly"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows only line shapes.
get isLineOnly(): boolean Returns boolean
isMarkerlessDisplayPreferred
Section titled "isMarkerlessDisplayPreferred"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Gets whether the current series shows a pie shape.
get isPie(): boolean Returns boolean
isPixel
Section titled "isPixel"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows pixels.
get isPixel(): boolean Returns boolean
isPolar
Section titled "isPolar"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a polar type series.
``
get isPolar(): boolean Returns boolean
isPolygon
Section titled "isPolygon"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a polygon shape.
get isPolygon(): boolean Returns boolean
isPolyline
Section titled "isPolyline"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a polyline shape.
get isPolyline(): boolean Returns boolean
isRadial
Section titled "isRadial"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a radial type series.
``
get isRadial(): boolean Returns boolean
isRange
Section titled "isRange"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a range type series.
``
get isRange(): boolean Returns boolean
isScatter
Section titled "isScatter"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a scatter type series.
``
get isScatter(): boolean Returns boolean
isShape
Section titled "isShape"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a shape type series.
get isShape(): boolean Returns boolean
isShapeControl
Section titled "isShapeControl"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows interactive shape controls.
get isShapeControl(): boolean Returns boolean
isSpline
Section titled "isSpline"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a spline shape.
get isSpline(): boolean Returns boolean
isStacked
Section titled "isStacked"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is a stacked type series.
``
get isStacked(): boolean Returns boolean
isStep
Section titled "isStep"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows step shapes.
get isStep(): boolean Returns boolean
isSummarizationSupported
Section titled "isSummarizationSupported"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series supports summarization in Data Legend and Data Tooltip.
get isSummarizationSupported(): boolean Returns boolean
isTile
Section titled "isTile"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a tile imagery.
get isTile(): boolean Returns boolean
isToolTipLayer
Section titled "isToolTipLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is an annotation layer.
get isToolTipLayer(): boolean Returns boolean
isUsableInLegend
Section titled "isUsableInLegend"Inherited from: IgrDataAnnotationShapeLayer
Gets if the series should appear in any legends.
get isUsableInLegend(): boolean Returns boolean
isUserAnnotationLayer
Section titled "isUserAnnotationLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is final value annotation layer.
get isUserAnnotationLayer(): boolean Returns boolean
isUserAnnotationToolTipLayer
Section titled "isUserAnnotationToolTipLayer"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is final user annotation tooltip layer.
get isUserAnnotationToolTipLayer(): boolean Returns boolean
isValueAxisInverted
Section titled "isValueAxisInverted"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows an area shape.
get isValueAxisInverted(): boolean Returns boolean
isValueOverlay
Section titled "isValueOverlay"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the series is a value overlay.
get isValueOverlay(): boolean Returns boolean
isVertical
Section titled "isVertical"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series is oriented vertically.
``
get isVertical(): boolean Returns boolean
isWaterfall
Section titled "isWaterfall"Inherited from: IgrDataAnnotationShapeLayer
Gets whether the current series shows a waterfall column shape.
get isWaterfall(): boolean Returns boolean
seriesInternal
Section titled "seriesInternal"Inherited from: IgrDataAnnotationShapeLayer
get seriesInternal(): any Returns any
get i(): Series Returns Series
Methods
Section titled "Methods"bindAxes
Section titled "bindAxes"Inherited from: IgrDataAnnotationShapeLayer
bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void Parameters
- axes:
IgrAxis<IIgrAxisProps>[]
Returns void
bindSeries
Section titled "bindSeries"Inherited from: IgrDataAnnotationShapeLayer
bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void Parameters
- series:
IgrSeries<IIgrSeriesProps>[]
Returns void
componentDidMount
Section titled "componentDidMount"Inherited from: IgrDataAnnotationShapeLayer
componentDidMount(): void Returns void
ensureAnnotationPadding
Section titled "ensureAnnotationPadding"Inherited from: IgrDataAnnotationShapeLayer
ensureAnnotationPadding(): void Returns void
findByName
Section titled "findByName"Inherited from: IgrDataAnnotationShapeLayer
findByName(name: string): any Parameters
- name:
string
Returns any
fromWorld
Section titled "fromWorld"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Gets the effective viewport, adjusted to account for margins and other factors.
getEffectiveViewport(): IgRect Returns IgRect
getExactItemIndex
Section titled "getExactItemIndex"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
getItemValue(item: any, memberPathName: string): any Parameters
- item:
any - memberPathName:
string
Returns any
getMainContentViewport
Section titled "getMainContentViewport"Inherited from: IgrDataAnnotationShapeLayer
getMainContentViewport(): IgRect Returns IgRect
getMemberPathValue
Section titled "getMemberPathValue"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getPreviousOrExactIndex
Section titled "getPreviousOrExactIndex"Inherited from: IgrDataAnnotationShapeLayer
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getSeriesHighValue
Section titled "getSeriesHighValue"Inherited from: IgrDataAnnotationShapeLayer
getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesHighValuePosition
Section titled "getSeriesHighValuePosition"Inherited from: IgrDataAnnotationShapeLayer
getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesLowValue
Section titled "getSeriesLowValue"Inherited from: IgrDataAnnotationShapeLayer
getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesLowValuePosition
Section titled "getSeriesLowValuePosition"Inherited from: IgrDataAnnotationShapeLayer
getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValue
Section titled "getSeriesValue"Inherited from: IgrDataAnnotationShapeLayer
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueBoundingBox
Section titled "getSeriesValueBoundingBox"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueMarkerBoundingBox
Section titled "getSeriesValueMarkerBoundingBox"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValuePositionFromSeriesPixel
Section titled "getSeriesValuePositionFromSeriesPixel"Inherited from: IgrDataAnnotationShapeLayer
getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValueType
Section titled "getSeriesValueType"Inherited from: IgrDataAnnotationShapeLayer
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
Section titled "getSeriesValueTypePosition"Inherited from: IgrDataAnnotationShapeLayer
Gets position of series value for specified layer value mode
getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint Parameters
- mode:
string | ValueLayerValueMode
Returns IgPoint
getSeriesValueTypePositionFromValue
Section titled "getSeriesValueTypePositionFromValue"Inherited from: IgrDataAnnotationShapeLayer
getSeriesValueTypePositionFromValue(values: number[]): IgPoint Parameters
- values:
number[]
Returns IgPoint
getUnscaledPosition
Section titled "getUnscaledPosition"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Hides any internal tooltips presented by the series, if any.
hideToolTips(): void Returns void
hideToolTipsImmediate
Section titled "hideToolTipsImmediate"Inherited from: IgrDataAnnotationShapeLayer
Hides any internal tooltips presented by the series, if any.
hideToolTipsImmediate(): void Returns void
moveCursorPoint
Section titled "moveCursorPoint"Inherited from: IgrDataAnnotationShapeLayer
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.
MoveCursorPointcan 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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Notifies the series that a visual property has changed, requiring a visual update.
notifyVisualPropertiesChanged(): void Returns void
playTransitionIn
Section titled "playTransitionIn"Inherited from: IgrDataAnnotationShapeLayer
Plays the assigned transition out animation, if any.
playTransitionIn(): void Returns void
playTransitionOut
Section titled "playTransitionOut"Inherited from: IgrDataAnnotationShapeLayer
Plays the assigned transition out animation, if any.
playTransitionOut(): void Returns void
playTransitionOutAndRemove
Section titled "playTransitionOutAndRemove"Inherited from: IgrDataAnnotationShapeLayer
Plays the assigned transition out animation, if any.
playTransitionOutAndRemove(): void Returns void
provideData
Section titled "provideData"Inherited from: IgrDataAnnotationShapeLayer
provideData(data: any[]): void Parameters
- data:
any[]
Returns void
provideHighlightedData
Section titled "provideHighlightedData"Inherited from: IgrDataAnnotationShapeLayer
provideHighlightedData(data: any[]): void Parameters
- data:
any[]
Returns void
removeAllAlternateViews
Section titled "removeAllAlternateViews"Inherited from: IgrDataAnnotationShapeLayer
Removes all alternate views of this series.
removeAllAlternateViews(): void Returns void
removeAlternateView
Section titled "removeAlternateView"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Call to null out the axes of the series;
removeAxes(): void Returns void
render
Section titled "render"Inherited from: IgrDataAnnotationShapeLayer
render(): any Returns any
renderSeries
Section titled "renderSeries"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
Replays the assigned transition in animation, if any.
``
replayTransitionIn(): void Returns void
resolveTooltipBrush
Section titled "resolveTooltipBrush"Inherited from: IgrDataAnnotationShapeLayer
Gets the brush for tooltip labels.
resolveTooltipBrush(): string Returns string
scrollIntoView
Section titled "scrollIntoView"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
setNegativeColors(negativeBrush: string, negativeOutline: string): void Parameters
- negativeBrush:
string - negativeOutline:
string
Returns void
shouldComponentUpdate
Section titled "shouldComponentUpdate"Inherited from: IgrDataAnnotationShapeLayer
shouldComponentUpdate(nextProps: any, nextState: any): boolean Parameters
- nextProps:
any - nextState:
any
Returns boolean
simulateHover
Section titled "simulateHover"Inherited from: IgrDataAnnotationShapeLayer
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,
SimulateHovercan 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: IgrDataAnnotationShapeLayer
Called when this series' Style is updated.
styleUpdated(): void Returns void
toWorld
Section titled "toWorld"Inherited from: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
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: IgrDataAnnotationShapeLayer
_createFromInternal(internal: any): IgrSeries Parameters
- internal:
any