Represents a base of annotation layers that render from start/end range

IgrDataAnnotationRangeLayer

new IgrDataAnnotationRangeLayer(props: P): IgrDataAnnotationRangeLayer

Returns IgrDataAnnotationRangeLayer

Inherited from: IgrDataAnnotationShapeLayer

actualAppearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

actualAreaFillOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

actualBrush: string

Inherited from: IgrDataAnnotationShapeLayer

actualDashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

actualDashCap: PenLineCap

Inherited from: IgrDataAnnotationShapeLayer

actualFocusBrush: string

Inherited from: IgrDataAnnotationShapeLayer

actualFocusMode: SeriesSelectionMode

Inherited from: IgrDataAnnotationShapeLayer

actualHighlightedValuesFadeOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

actualHighlightingFadeOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgrDataAnnotationShapeLayer

actualHitTestMode: SeriesHitTestMode

Inherited from: IgrDataAnnotationShapeLayer

actualHorizontalAppearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

actualHorizontalDashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

actualHorizontalShiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

actualLayers: IgrSeriesLayerCollection

Inherited from: IgrDataAnnotationShapeLayer

actualLegendItemBadgeBrush: string

Inherited from: IgrDataAnnotationShapeLayer

actualLegendItemBadgeOutline: string

Inherited from: IgrDataAnnotationShapeLayer

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrDataAnnotationShapeLayer

actualMarkerFillOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

actualOutline: string

Inherited from: IgrDataAnnotationShapeLayer

actualResolution: number

Inherited from: IgrDataAnnotationShapeLayer

actualSelectionBrush: string

Inherited from: IgrDataAnnotationShapeLayer

actualSelectionMode: SeriesSelectionMode

Inherited from: IgrDataAnnotationShapeLayer

actualShiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

actualThickness: number

Inherited from: IgrDataAnnotationShapeLayer

actualVerticalAppearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

actualVerticalDashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

actualVerticalShiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBackground: string

Inherited from: IgrDataAnnotationShapeLayer

annotationBackgroundMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationBackgroundMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

annotationBackgroundShift: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeBackground: string

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeCornerRadius: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeEnabled: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeImagePath: string

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeMargin: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeOutline: string

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeOutlineThickness: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBadgeSize: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderColor: string

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderRadius: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderShift: number

Inherited from: IgrDataAnnotationShapeLayer

annotationBorderThickness: number

Inherited from: IgrDataAnnotationShapeLayer

annotationLabelDisplayMode: DataAnnotationDisplayMode

Inherited from: IgrDataAnnotationShapeLayer

annotationLabelVisible: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationPaddingBottom: number

Inherited from: IgrDataAnnotationShapeLayer

annotationPaddingLeft: number

Inherited from: IgrDataAnnotationShapeLayer

annotationPaddingRight: number

Inherited from: IgrDataAnnotationShapeLayer

annotationPaddingTop: number

Inherited from: IgrDataAnnotationShapeLayer

annotationShapeVisible: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationTextColor: string

Inherited from: IgrDataAnnotationShapeLayer

annotationTextColorMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

annotationTextColorMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

annotationTextColorShift: number

Inherited from: IgrDataAnnotationShapeLayer

annotationValueMaxPrecision: number

Inherited from: IgrDataAnnotationShapeLayer

annotationValueMinPrecision: number

Inherited from: IgrDataAnnotationShapeLayer

appearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

areaFillOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

attachTooltipToRoot: boolean

Inherited from: IgrDataAnnotationShapeLayer

autoCalloutLabelFormat: string

Inherited from: IgrDataAnnotationShapeLayer

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgrDataAnnotationShapeLayer

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgrDataAnnotationShapeLayer

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgrDataAnnotationShapeLayer

brush: string
centerLabelBackground: string
centerLabelBorderColor: string
centerLabelTextColor: string

Inherited from: IgrDataAnnotationShapeLayer

coercionMethods: any

Inherited from: IgrDataAnnotationShapeLayer

cursorPosition: IgPoint

Inherited from: IgrDataAnnotationShapeLayer

cursorPositionUpdatesOnMove: boolean

Inherited from: IgrDataAnnotationShapeLayer

dashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

dataLegendGroup: string

Inherited from: IgrDataAnnotationShapeLayer

dataSource: any

Inherited from: IgrDataAnnotationShapeLayer

discreteLegendItemTemplate: IgDataTemplate
endLabelBackground: string
endLabelBorderColor: string
endLabelTextColor: string

Inherited from: IgrDataAnnotationShapeLayer

expectFunctions: boolean

Inherited from: IgrDataAnnotationShapeLayer

finalValue: number

Inherited from: IgrDataAnnotationShapeLayer

focusBrush: string

Inherited from: IgrDataAnnotationShapeLayer

highlightedDataSource: any

Inherited from: IgrDataAnnotationShapeLayer

highlightedLegendItemVisibility: Visibility

Inherited from: IgrDataAnnotationShapeLayer

highlightedTitleSuffix: string

Inherited from: IgrDataAnnotationShapeLayer

highlightedValuesDataLegendGroup: string

Inherited from: IgrDataAnnotationShapeLayer

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgrDataAnnotationShapeLayer

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

Inherited from: IgrDataAnnotationShapeLayer

highlightedValuesFadeOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

highlightingFadeOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

hitTestMode: SeriesHitTestMode

Inherited from: IgrDataAnnotationShapeLayer

horizontalAppearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

horizontalDashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

horizontalShiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

index: number

Inherited from: IgrDataAnnotationShapeLayer

isActualLegendFinancial: boolean

Inherited from: IgrDataAnnotationShapeLayer

isComponentHighlightingModeIgnored: boolean

Inherited from: IgrDataAnnotationShapeLayer

isDefaultCrosshairDisabled: boolean

Inherited from: IgrDataAnnotationShapeLayer

isDefaultToolTipSelected: boolean

Inherited from: IgrDataAnnotationShapeLayer

isDropShadowEnabled: boolean

Inherited from: IgrDataAnnotationShapeLayer

isHighlightingEnabled: boolean

Inherited from: IgrDataAnnotationShapeLayer

isTargetingHorizontalAxis: boolean

Inherited from: IgrDataAnnotationShapeLayer

itemsUseWorldCoordinates: boolean

Inherited from: IgrDataAnnotationShapeLayer

layers: IgrSeriesLayerCollection

Inherited from: IgrDataAnnotationShapeLayer

legend: any

Inherited from: IgrDataAnnotationShapeLayer

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgrDataAnnotationShapeLayer

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgrDataAnnotationShapeLayer

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrDataAnnotationShapeLayer

legendItemTemplate: IgDataTemplate

Inherited from: IgrDataAnnotationShapeLayer

legendItemVisibility: Visibility

Inherited from: IgrDataAnnotationShapeLayer

lineCap: PenLineCap

Inherited from: IgrDataAnnotationShapeLayer

lineJoin: PenLineJoin

Inherited from: IgrDataAnnotationShapeLayer

markerFillOpacity: number

Inherited from: IgrDataAnnotationShapeLayer

mouseOverEnabled: boolean

Inherited from: IgrDataAnnotationShapeLayer

name: string

Inherited from: IgrDataAnnotationShapeLayer

opacity: number

Inherited from: IgrDataAnnotationShapeLayer

outline: string

Inherited from: IgrDataAnnotationShapeLayer

outlineMode: SeriesOutlineMode

Inherited from: IgrDataAnnotationShapeLayer

overlayText: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextAngle: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBackground: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBackgroundMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBackgroundMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBackgroundShift: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderColor: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderRadius: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderShift: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextBorderThickness: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextColor: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextColorMatchLayer: boolean

Inherited from: IgrDataAnnotationShapeLayer

overlayTextColorMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

overlayTextColorShift: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextHorizontalMargin: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextHorizontalPadding: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextLocation: OverlayTextLocation

Inherited from: IgrDataAnnotationShapeLayer

overlayTextMemberPath: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextStyle: string

Inherited from: IgrDataAnnotationShapeLayer

overlayTextVerticalMargin: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextVerticalPadding: number

Inherited from: IgrDataAnnotationShapeLayer

overlayTextVisible: boolean

Inherited from: IgrDataAnnotationShapeLayer

percentChange: number

Inherited from: IgrDataAnnotationShapeLayer

renderRequested: object

Inherited from: IgrDataAnnotationShapeLayer

resolution: number

Inherited from: IgrDataAnnotationShapeLayer

safeActualBrush: string

Inherited from: IgrDataAnnotationShapeLayer

selectionBrush: string

Inherited from: IgrDataAnnotationShapeLayer

selectionThickness: number

Inherited from: IgrDataAnnotationShapeLayer

shadowBlur: number

Inherited from: IgrDataAnnotationShapeLayer

shadowColor: string

Inherited from: IgrDataAnnotationShapeLayer

shadowOffsetX: number

Inherited from: IgrDataAnnotationShapeLayer

shadowOffsetY: number

Inherited from: IgrDataAnnotationShapeLayer

shiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgrDataAnnotationShapeLayer

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgrDataAnnotationShapeLayer

shouldRemoveHighlightedDataOnLayerHidden: boolean

Inherited from: IgrDataAnnotationShapeLayer

shouldRenderAsOverlay: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgrDataAnnotationShapeLayer

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgrDataAnnotationShapeLayer

showDefaultTooltip: boolean
startLabelBackground: string
startLabelBorderColor: string
startLabelTextColor: string

Inherited from: IgrDataAnnotationShapeLayer

stylingAxisAnnotation: object

Inherited from: IgrDataAnnotationShapeLayer

stylingOverlayText: object

Inherited from: IgrDataAnnotationShapeLayer

stylingShapeAnnotation: object

Inherited from: IgrDataAnnotationShapeLayer

targetAxis: IgrAxis

Inherited from: IgrDataAnnotationShapeLayer

targetAxisName: string

Inherited from: IgrDataAnnotationShapeLayer

targetMode: DataAnnotationTargetMode

Inherited from: IgrDataAnnotationShapeLayer

thickness: number

Inherited from: IgrDataAnnotationShapeLayer

title: any

Inherited from: IgrDataAnnotationShapeLayer

tooltipContainerTemplate: any

Inherited from: IgrDataAnnotationShapeLayer

tooltipTemplate: any

Inherited from: IgrDataAnnotationShapeLayer

transitionDuration: number

Inherited from: IgrDataAnnotationShapeLayer

transitionEasingFunction: object

Inherited from: IgrDataAnnotationShapeLayer

transitionInDuration: number

Inherited from: IgrDataAnnotationShapeLayer

transitionInEasingFunction: object

Inherited from: IgrDataAnnotationShapeLayer

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgrDataAnnotationShapeLayer

transitionOutCompleted: object

Inherited from: IgrDataAnnotationShapeLayer

transitionOutDuration: number

Inherited from: IgrDataAnnotationShapeLayer

transitionOutEasingFunction: object

Inherited from: IgrDataAnnotationShapeLayer

transitionOutSpeedType: TransitionOutSpeedType

Inherited from: IgrDataAnnotationShapeLayer

useIndex: boolean

Inherited from: IgrDataAnnotationShapeLayer

useItemWiseColors: boolean

Inherited from: IgrDataAnnotationShapeLayer

useLegend: boolean

Inherited from: IgrDataAnnotationShapeLayer

useSingleShadow: boolean

Inherited from: IgrDataAnnotationShapeLayer

verticalAppearanceMode: AnnotationAppearanceMode

Inherited from: IgrDataAnnotationShapeLayer

verticalDashArray: number[]

Inherited from: IgrDataAnnotationShapeLayer

verticalShiftAmount: number

Inherited from: IgrDataAnnotationShapeLayer

visibility: Visibility

Inherited from: IgrDataAnnotationShapeLayer

visibleRangeMarginBottom: number

Inherited from: IgrDataAnnotationShapeLayer

visibleRangeMarginLeft: number

Inherited from: IgrDataAnnotationShapeLayer

visibleRangeMarginRight: number

Inherited from: IgrDataAnnotationShapeLayer

visibleRangeMarginTop: number

Inherited from: IgrDataAnnotationShapeLayer

visibleRangeMode: SeriesVisibleRangeMode

Inherited from: IgrDataAnnotationShapeLayer

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

get actualCloseLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualHighLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualLowLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualOpenLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualRadiusLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualValueLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

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

get actualVolumeLabel(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgrDataAnnotationShapeLayer

Returns whether the current series supports visual markers.

``

get hasMarkers(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

get isAnnotationDataLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

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

Inherited from: IgrDataAnnotationShapeLayer

Gets whether this series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

``

get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a category type series.

``

get isCategory(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether or not the default crosshair behavior is disabled.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a financial type series.

``

get isFinancial(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

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

Inherited from: IgrDataAnnotationShapeLayer

get isLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is a stacked type series.

``

get isStacked(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

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

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgrDataAnnotationShapeLayer

get seriesInternal(): any

Returns any

get i(): Series

Returns Series

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

Returns void

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

Returns void

Inherited from: IgrDataAnnotationShapeLayer

componentDidMount(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

ensureAnnotationPadding(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

findByName(name: string): any

Parameters

  • name: string

Returns any

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

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

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

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

Inherited from: IgrDataAnnotationShapeLayer

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

getEffectiveViewport(): IgRect

Returns IgRect

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

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

Inherited from: IgrDataAnnotationShapeLayer

Gets the item index associated with the specified world position

``

getItemIndex(world: IgPoint): number

Parameters

  • world: IgPoint

Returns number

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

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgrDataAnnotationShapeLayer

getMainContentViewport(): IgRect

Returns IgRect

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

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns number

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns IgPoint

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns number

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns IgPoint

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns number

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

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

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

Returns number

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

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

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

Returns number[]

Inherited from: IgrDataAnnotationShapeLayer

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgrDataAnnotationShapeLayer

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

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

Inherited from: IgrDataAnnotationShapeLayer

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

hideToolTips(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

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

hideToolTipsImmediate(): void

Returns void

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.

    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

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

Inherited from: IgrDataAnnotationShapeLayer

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

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrDataAnnotationShapeLayer

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

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

Inherited from: IgrDataAnnotationShapeLayer

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

render(): any

Returns any

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

Inherited from: IgrDataAnnotationShapeLayer

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

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

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgrDataAnnotationShapeLayer

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

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, SimulateHover can be used to automatically display the tooltip over a particular series item.

    this.series.simulateHover({x:250,y:250});

Returns void

Inherited from: IgrDataAnnotationShapeLayer

Called when this series' Style is updated.

styleUpdated(): void

Returns void

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

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

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

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

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

Inherited from: IgrDataAnnotationShapeLayer

_createFromInternal(internal: any): IgrSeries

Parameters

  • internal: any

Returns IgrSeries