Represents a DataChartComponent Bollinger Bands financial overlay series. Default required members: High, Low, Close

You can use the BollingerBandsOverlay class represents a DataChartComponent Bollinger Bands financial overlay series.

``

``

Constructors

Section titled "Constructors"

IgrBollingerBandsOverlay

new IgrBollingerBandsOverlay(props: IIgrBollingerBandsOverlayProps): IgrBollingerBandsOverlay

Returns IgrBollingerBandsOverlay

Properties

Section titled "Properties"

actualAreaFillOpacity

Section titled "actualAreaFillOpacity"

Inherited from: IgrFinancialOverlay 

actualAreaFillOpacity: number

actualBrush

Section titled "actualBrush"

Inherited from: IgrFinancialOverlay 

actualBrush: string

actualFocusBrush

Section titled "actualFocusBrush"

Inherited from: IgrFinancialOverlay 

actualFocusBrush: string

actualFocusMode

Section titled "actualFocusMode"

Inherited from: IgrFinancialOverlay 

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Section titled "actualHighlightedValuesFadeOpacity"

Inherited from: IgrFinancialOverlay 

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Section titled "actualHighlightingFadeOpacity"

Inherited from: IgrFinancialOverlay 

actualHighlightingFadeOpacity: number

actualHighlightingMode

Section titled "actualHighlightingMode"

Inherited from: IgrFinancialOverlay 

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Section titled "actualHitTestMode"

Inherited from: IgrFinancialOverlay 

actualHitTestMode: SeriesHitTestMode

actualLayers

Section titled "actualLayers"

Inherited from: IgrFinancialOverlay 

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Section titled "actualLegendItemBadgeBrush"

Inherited from: IgrFinancialOverlay 

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Section titled "actualLegendItemBadgeOutline"

Inherited from: IgrFinancialOverlay 

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Section titled "actualLegendItemBadgeTemplate"

Inherited from: IgrFinancialOverlay 

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Section titled "actualMarkerFillOpacity"

Inherited from: IgrFinancialOverlay 

actualMarkerFillOpacity: number

actualOutline

Section titled "actualOutline"

Inherited from: IgrFinancialOverlay 

actualOutline: string

actualResolution

Section titled "actualResolution"

Inherited from: IgrFinancialOverlay 

actualResolution: number

actualSelectionBrush

Section titled "actualSelectionBrush"

Inherited from: IgrFinancialOverlay 

actualSelectionBrush: string

actualSelectionMode

Section titled "actualSelectionMode"

Inherited from: IgrFinancialOverlay 

actualSelectionMode: SeriesSelectionMode

actualThickness

Section titled "actualThickness"

Inherited from: IgrFinancialOverlay 

actualThickness: number

areaFillOpacity

Section titled "areaFillOpacity"

Inherited from: IgrFinancialOverlay 

areaFillOpacity: number

assigningCategoryStyle

Section titled "assigningCategoryStyle"

Inherited from: IgrFinancialOverlay 

assigningCategoryStyle: object

attachTooltipToRoot

Section titled "attachTooltipToRoot"

Inherited from: IgrFinancialOverlay 

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Section titled "autoCalloutLabelFormat"

Inherited from: IgrFinancialOverlay 

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Section titled "autoCalloutLabelFormatSpecifiers"

Inherited from: IgrFinancialOverlay 

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Section titled "autoCalloutValueLabelFormat"

Inherited from: IgrFinancialOverlay 

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgrFinancialOverlay 

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Section titled "brush"

Inherited from: IgrFinancialOverlay 

brush: string

closeMemberPath

Section titled "closeMemberPath"

Inherited from: IgrFinancialOverlay 

closeMemberPath: string

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrFinancialOverlay 

coercionMethods: any

dashArray

Section titled "dashArray"

Inherited from: IgrFinancialOverlay 

dashArray: number[]

dataLegendGroup

Section titled "dataLegendGroup"

Inherited from: IgrFinancialOverlay 

dataLegendGroup: string

dataSource

Section titled "dataSource"

Inherited from: IgrFinancialOverlay 

dataSource: any

discreteLegendItemTemplate

Section titled "discreteLegendItemTemplate"

Inherited from: IgrFinancialOverlay 

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Section titled "expectFunctions"

Inherited from: IgrFinancialOverlay 

expectFunctions: boolean

finalValue

Section titled "finalValue"

Inherited from: IgrFinancialOverlay 

finalValue: number

focusBrush

Section titled "focusBrush"

Inherited from: IgrFinancialOverlay 

focusBrush: string

highlightedCloseMemberPath

Section titled "highlightedCloseMemberPath"

Inherited from: IgrFinancialOverlay 

highlightedCloseMemberPath: string

highlightedDataSource

Section titled "highlightedDataSource"

Inherited from: IgrFinancialOverlay 

highlightedDataSource: any

highlightedHighMemberPath

Section titled "highlightedHighMemberPath"

Inherited from: IgrFinancialOverlay 

highlightedHighMemberPath: string

highlightedLegendItemVisibility

Section titled "highlightedLegendItemVisibility"

Inherited from: IgrFinancialOverlay 

highlightedLegendItemVisibility: Visibility

highlightedLowMemberPath

Section titled "highlightedLowMemberPath"

Inherited from: IgrFinancialOverlay 

highlightedLowMemberPath: string

highlightedOpenMemberPath

Section titled "highlightedOpenMemberPath"

Inherited from: IgrFinancialOverlay 

highlightedOpenMemberPath: string

highlightedTitleSuffix

Section titled "highlightedTitleSuffix"

Inherited from: IgrFinancialOverlay 

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Section titled "highlightedValuesDataLegendGroup"

Inherited from: IgrFinancialOverlay 

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Section titled "highlightedValuesDisplayMode"

Inherited from: IgrFinancialOverlay 

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgrFinancialOverlay 

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Section titled "highlightedValuesFadeOpacity"

Inherited from: IgrFinancialOverlay 

highlightedValuesFadeOpacity: number

highlightedVolumeMemberPath

Section titled "highlightedVolumeMemberPath"

Inherited from: IgrFinancialOverlay 

highlightedVolumeMemberPath: string

highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Inherited from: IgrFinancialOverlay 

highlightingFadeOpacity: number

highMemberPath

Section titled "highMemberPath"

Inherited from: IgrFinancialOverlay 

highMemberPath: string

hitTestMode

Section titled "hitTestMode"

Inherited from: IgrFinancialOverlay 

hitTestMode: SeriesHitTestMode

ignoreFirst

Section titled "ignoreFirst"

Inherited from: IgrFinancialOverlay 

ignoreFirst: number

index

Section titled "index"

Inherited from: IgrFinancialOverlay 

index: number

isActualLegendFinancial

Section titled "isActualLegendFinancial"

Inherited from: IgrFinancialOverlay 

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Section titled "isComponentHighlightingModeIgnored"

Inherited from: IgrFinancialOverlay 

isComponentHighlightingModeIgnored: boolean

isCustomCategoryStyleAllowed

Section titled "isCustomCategoryStyleAllowed"

Inherited from: IgrFinancialOverlay 

isCustomCategoryStyleAllowed: boolean

isDefaultToolTipSelected

Section titled "isDefaultToolTipSelected"

Inherited from: IgrFinancialOverlay 

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Section titled "isDropShadowEnabled"

Inherited from: IgrFinancialOverlay 

isDropShadowEnabled: boolean

isHighlightingEnabled

Section titled "isHighlightingEnabled"

Inherited from: IgrFinancialOverlay 

isHighlightingEnabled: boolean

isTransitionInEnabled

Section titled "isTransitionInEnabled"

Inherited from: IgrFinancialOverlay 

isTransitionInEnabled: boolean

layers

Section titled "layers"

Inherited from: IgrFinancialOverlay 

layers: IgrSeriesLayerCollection

legend

Section titled "legend"

Inherited from: IgrFinancialOverlay 

legend: any

legendItemBadgeMode

Section titled "legendItemBadgeMode"

Inherited from: IgrFinancialOverlay 

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Section titled "legendItemBadgeShape"

Inherited from: IgrFinancialOverlay 

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Section titled "legendItemBadgeTemplate"

Inherited from: IgrFinancialOverlay 

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Section titled "legendItemTemplate"

Inherited from: IgrFinancialOverlay 

legendItemTemplate: IgDataTemplate

legendItemVisibility

Section titled "legendItemVisibility"

Inherited from: IgrFinancialOverlay 

legendItemVisibility: Visibility

lineCap

Section titled "lineCap"

Inherited from: IgrFinancialOverlay 

lineCap: PenLineCap

lineJoin

Section titled "lineJoin"

Inherited from: IgrFinancialOverlay 

lineJoin: PenLineJoin

lowMemberPath

Section titled "lowMemberPath"

Inherited from: IgrFinancialOverlay 

lowMemberPath: string

markerFillOpacity

Section titled "markerFillOpacity"

Inherited from: IgrFinancialOverlay 

markerFillOpacity: number

mouseOverEnabled

Section titled "mouseOverEnabled"

Inherited from: IgrFinancialOverlay 

mouseOverEnabled: boolean

multiplier

Section titled "multiplier" 
multiplier: number

name

Section titled "name"

Inherited from: IgrFinancialOverlay 

name: string

negativeBrush

Section titled "negativeBrush"

Inherited from: IgrFinancialOverlay 

negativeBrush: string

opacity

Section titled "opacity"

Inherited from: IgrFinancialOverlay 

opacity: number

openMemberPath

Section titled "openMemberPath"

Inherited from: IgrFinancialOverlay 

openMemberPath: string

outline

Section titled "outline"

Inherited from: IgrFinancialOverlay 

outline: string

outlineMode

Section titled "outlineMode"

Inherited from: IgrFinancialOverlay 

outlineMode: SeriesOutlineMode

percentChange

Section titled "percentChange"

Inherited from: IgrFinancialOverlay 

percentChange: number

period

Section titled "period" 
period: number

renderRequested

Section titled "renderRequested"

Inherited from: IgrFinancialOverlay 

renderRequested: object

resolution

Section titled "resolution"

Inherited from: IgrFinancialOverlay 

resolution: number

safeActualBrush

Section titled "safeActualBrush"

Inherited from: IgrFinancialOverlay 

safeActualBrush: string

selectionBrush

Section titled "selectionBrush"

Inherited from: IgrFinancialOverlay 

selectionBrush: string

selectionThickness

Section titled "selectionThickness"

Inherited from: IgrFinancialOverlay 

selectionThickness: number

shadowBlur

Section titled "shadowBlur"

Inherited from: IgrFinancialOverlay 

shadowBlur: number

shadowColor

Section titled "shadowColor"

Inherited from: IgrFinancialOverlay 

shadowColor: string

shadowOffsetX

Section titled "shadowOffsetX"

Inherited from: IgrFinancialOverlay 

shadowOffsetX: number

shadowOffsetY

Section titled "shadowOffsetY"

Inherited from: IgrFinancialOverlay 

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Section titled "shouldAnimateOnDataSourceSwap"

Inherited from: IgrFinancialOverlay 

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Section titled "shouldHideAutoCallouts"

Inherited from: IgrFinancialOverlay 

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgrFinancialOverlay 

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgrFinancialOverlay 

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Section titled "showDefaultTooltip"

Inherited from: IgrFinancialOverlay 

showDefaultTooltip: boolean

thickness

Section titled "thickness"

Inherited from: IgrFinancialOverlay 

thickness: number

title

Section titled "title"

Inherited from: IgrFinancialOverlay 

title: any

tooltipContainerTemplate

Section titled "tooltipContainerTemplate"

Inherited from: IgrFinancialOverlay 

tooltipContainerTemplate: any

tooltipTemplate

Section titled "tooltipTemplate"

Inherited from: IgrFinancialOverlay 

tooltipTemplate: any

transitionDuration

Section titled "transitionDuration"

Inherited from: IgrFinancialOverlay 

transitionDuration: number

transitionEasingFunction

Section titled "transitionEasingFunction"

Inherited from: IgrFinancialOverlay 

transitionEasingFunction: object

transitionInDuration

Section titled "transitionInDuration"

Inherited from: IgrFinancialOverlay 

transitionInDuration: number

transitionInEasingFunction

Section titled "transitionInEasingFunction"

Inherited from: IgrFinancialOverlay 

transitionInEasingFunction: object

transitionInMode

Section titled "transitionInMode"

Inherited from: IgrFinancialOverlay 

transitionInMode: CategoryTransitionInMode

transitionInSpeedType

Section titled "transitionInSpeedType"

Inherited from: IgrFinancialOverlay 

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Section titled "transitionOutCompleted"

Inherited from: IgrFinancialOverlay 

transitionOutCompleted: object

transitionOutDuration

Section titled "transitionOutDuration"

Inherited from: IgrFinancialOverlay 

transitionOutDuration: number

transitionOutEasingFunction

Section titled "transitionOutEasingFunction"

Inherited from: IgrFinancialOverlay 

transitionOutEasingFunction: object

transitionOutSpeedType

Section titled "transitionOutSpeedType"

Inherited from: IgrFinancialOverlay 

transitionOutSpeedType: TransitionOutSpeedType

typical

Section titled "typical"

Inherited from: IgrFinancialOverlay 

typical: object

typicalBasedOn

Section titled "typicalBasedOn"

Inherited from: IgrFinancialOverlay 

typicalBasedOn: object

useItemWiseColors

Section titled "useItemWiseColors"

Inherited from: IgrFinancialOverlay 

useItemWiseColors: boolean

useSingleShadow

Section titled "useSingleShadow"

Inherited from: IgrFinancialOverlay 

useSingleShadow: boolean

visibility

Section titled "visibility"

Inherited from: IgrFinancialOverlay 

visibility: Visibility

visibleRangeMarginBottom

Section titled "visibleRangeMarginBottom"

Inherited from: IgrFinancialOverlay 

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Section titled "visibleRangeMarginLeft"

Inherited from: IgrFinancialOverlay 

visibleRangeMarginLeft: number

visibleRangeMarginRight

Section titled "visibleRangeMarginRight"

Inherited from: IgrFinancialOverlay 

visibleRangeMarginRight: number

visibleRangeMarginTop

Section titled "visibleRangeMarginTop"

Inherited from: IgrFinancialOverlay 

visibleRangeMarginTop: number

visibleRangeMode

Section titled "visibleRangeMode"

Inherited from: IgrFinancialOverlay 

visibleRangeMode: SeriesVisibleRangeMode

volumeMemberPath

Section titled "volumeMemberPath"

Inherited from: IgrFinancialOverlay 

volumeMemberPath: string

xAxis

Section titled "xAxis"

Inherited from: IgrFinancialOverlay 

xAxis: IgrCategoryAxisBase

xAxisName

Section titled "xAxisName"

Inherited from: IgrFinancialOverlay 

xAxisName: string

yAxis

Section titled "yAxis"

Inherited from: IgrFinancialOverlay 

yAxis: IgrNumericYAxis

yAxisName

Section titled "yAxisName"

Inherited from: IgrFinancialOverlay 

yAxisName: string

Accessors

Section titled "Accessors"

actualCloseLabel

Section titled "actualCloseLabel"

Inherited from: IgrFinancialOverlay

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Section titled "actualHighLabel"

Inherited from: IgrFinancialOverlay

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

get actualHighLabel(): string

Returns string

actualLowLabel

Section titled "actualLowLabel"

Inherited from: IgrFinancialOverlay

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Section titled "actualOpenLabel"

Inherited from: IgrFinancialOverlay

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Section titled "actualRadiusLabel"

Inherited from: IgrFinancialOverlay

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Section titled "actualValueLabel"

Inherited from: IgrFinancialOverlay

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Section titled "actualVolumeLabel"

Inherited from: IgrFinancialOverlay

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Section titled "dataLegendKey"

Inherited from: IgrFinancialOverlay

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Section titled "hasMarkers"

Inherited from: IgrFinancialOverlay

Returns whether the current series supports visual markers.

``

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Section titled "hasOnlyMarkers"

Inherited from: IgrFinancialOverlay

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Section titled "hasValueAxis"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Section titled "hasVisibleMarkers"

Inherited from: IgrFinancialOverlay

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Section titled "isAnnotationCalloutLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Section titled "isAnnotationCrosshairLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Section titled "isAnnotationDataLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is a data annotation layer that support binding to data source DataAnnotationShapeLayer, DataAnnotationSliceLayer, DataAnnotationStripLayer

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Section titled "isAnnotationFinalValue"

Inherited from: IgrFinancialOverlay

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Section titled "isAnnotationHoverLayer"

Inherited from: IgrFinancialOverlay

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

Gets whether the series is an annotation layer.

``

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Section titled "isAnnotationValueLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Section titled "isArea"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Section titled "isAreaOrLine"

Inherited from: IgrFinancialOverlay

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

``

get isAreaOrLine(): boolean

Returns boolean

isBar

Section titled "isBar"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Section titled "isCategory"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a category type series.

``

get isCategory(): boolean

Returns boolean

isColoredItemwise

Section titled "isColoredItemwise"

Inherited from: IgrFinancialOverlay 

get isColoredItemwise(): boolean

Returns boolean

isColumn

Section titled "isColumn"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Section titled "isDefaultCrosshairBehaviorDisabled"

Inherited from: IgrFinancialOverlay

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

IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

``

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Section titled "isDefaultTooltipBehaviorDisabled"

Inherited from: IgrFinancialOverlay

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

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Section titled "isFinancialIndicator"

Inherited from: IgrFinancialOverlay

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Section titled "isFinancialOverlay"

Inherited from: IgrFinancialOverlay

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Section titled "isFinancialSeries"

Inherited from: IgrFinancialOverlay

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Section titled "isFinancialWaterfall"

Inherited from: IgrFinancialOverlay

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Section titled "isFragment"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

isGeographic

Section titled "isGeographic"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Section titled "isHighlightOverlay"

Inherited from: IgrFinancialOverlay

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Section titled "isIndexed"

Inherited from: IgrFinancialOverlay

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

get isLayer(): boolean

Returns boolean

isLineContour

Section titled "isLineContour"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Section titled "isLineOnly"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Section titled "isMarkerlessDisplayPreferred"

Inherited from: IgrFinancialOverlay

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

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

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Section titled "isPixel"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Section titled "isPolar"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

isPolygon

Section titled "isPolygon"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Section titled "isPolyline"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Section titled "isRadial"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

isRange

Section titled "isRange"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

isScatter

Section titled "isScatter"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

isShape

Section titled "isShape"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Section titled "isShapeControl"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Section titled "isSpline"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Section titled "isStacked"

Inherited from: IgrFinancialOverlay

Gets whether the current series is a stacked type series.

``

get isStacked(): boolean

Returns boolean

isStep

Section titled "isStep"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Section titled "isSummarizationSupported"

Inherited from: IgrFinancialOverlay

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Section titled "isTile"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Section titled "isToolTipLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Section titled "isUsableInLegend"

Inherited from: IgrFinancialOverlay

Gets if the series should appear in any legends.

``

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Section titled "isUserAnnotationLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Section titled "isUserAnnotationToolTipLayer"

Inherited from: IgrFinancialOverlay

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Section titled "isValueAxisInverted"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Section titled "isValueOverlay"

Inherited from: IgrFinancialOverlay

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Section titled "isVertical"

Inherited from: IgrFinancialOverlay

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

isWaterfall

Section titled "isWaterfall"

Inherited from: IgrFinancialOverlay

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Section titled "seriesInternal"

Inherited from: IgrFinancialOverlay 

get seriesInternal(): any

Returns any

i

Section titled "i" 
get i(): Series

Returns Series

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrFinancialOverlay 

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

Parameters

Returns void

bindSeries

Section titled "bindSeries"

Inherited from: IgrFinancialOverlay 

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

Parameters

Returns void

canUseAsXAxis

Section titled "canUseAsXAxis"

Inherited from: IgrFinancialOverlay

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    Use CanUseAsXAxis method to determine if the object can be used as XAxis.

    boolean canX =series.canUseAsXAxis(xAxis);

Returns boolean

canUseAsYAxis

Section titled "canUseAsYAxis"

Inherited from: IgrFinancialOverlay

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    Use CanUseAsYAxis method to determine if the object can be used as YAxis.

    boolean canY =series.canUseAsYAxis(yAxis);

Returns boolean

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrFinancialOverlay 

componentDidMount(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrFinancialOverlay 

findByName(name: string): any

Parameters

  • name: string

Returns any

fromWorldPosition

Section titled "fromWorldPosition"

Inherited from: IgrFinancialOverlay

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

getCategoryWidth

Section titled "getCategoryWidth"

Inherited from: IgrFinancialOverlay

Returns the width of the category grouping this series is in.

The GetCategoryWidth method returns the width of the category grouping this series is in.

``

getCategoryWidth(): number

Returns number

getEffectiveViewport

Section titled "getEffectiveViewport"

Inherited from: IgrFinancialOverlay

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Section titled "getExactItemIndex"

Inherited from: IgrFinancialOverlay

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.

    The GetExactItemIndex method 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.

    number index = series.getExactItemIndex(world);

Returns number

getItem

Section titled "getItem"

Inherited from: IgrFinancialOverlay

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.

    The GetItem method gets the item that is the best match for the specified world coordinates.

Returns any

getItemIndex

Section titled "getItemIndex"

Inherited from: IgrFinancialOverlay

Gets the index of the item that resides at the provided world coordinates.

getItemIndex(world: IgPoint): number

Parameters

  • world: IgPoint
    • The world coordinates of the requested item.

    The GetItemIndex method gets the index of the item that resides at the provided world coordinates.

    number itemindex= series.getItemIndex(world);

Returns number

getItemSpan

Section titled "getItemSpan"

Inherited from: IgrFinancialOverlay

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMainContentViewport

Section titled "getMainContentViewport"

Inherited from: IgrFinancialOverlay 

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgrFinancialOverlay

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" 
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getOffsetValue

Section titled "getOffsetValue"

Inherited from: IgrFinancialOverlay

Returns the offset value for this series if grouped on a category axis.

The GetOffsetValue method returns the offset value for this series if grouped on a category axis.

``

getOffsetValue(): number

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex" 
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesCloseValue

Section titled "getSeriesCloseValue"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns number

getSeriesCloseValuePosition

Section titled "getSeriesCloseValuePosition"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getSeriesOpenValue

Section titled "getSeriesOpenValue"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns number

getSeriesOpenValuePosition

Section titled "getSeriesOpenValuePosition"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue" 
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgrFinancialOverlay

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

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgrFinancialOverlay

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getSeriesValueType

Section titled "getSeriesValueType"

Inherited from: IgrFinancialOverlay

Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN.

getSeriesValueType(mode: string | ValueLayerValueMode): number[]

Parameters

Returns number[]

getSeriesValueTypePosition

Section titled "getSeriesValueTypePosition"

Inherited from: IgrFinancialOverlay

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgrFinancialOverlay 

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

getSeriesVolumeValue

Section titled "getSeriesVolumeValue"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns number

getSeriesVolumeValuePosition

Section titled "getSeriesVolumeValuePosition"

Inherited from: IgrFinancialOverlay 

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

Parameters

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

Returns IgPoint

getUnscaledPosition

Section titled "getUnscaledPosition"

Inherited from: IgrFinancialOverlay

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Section titled "hideToolTipsImmediate"

Inherited from: IgrFinancialOverlay

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Section titled "moveCursorPoint"

Inherited from: IgrFinancialOverlay

Moves the cursor point to the provided world position. Some series may react to the current cursor position.

moveCursorPoint(point: IgPoint): void

Parameters

  • point: IgPoint
    • The cursor point, in world coordinates.

    MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.

    this.crosshair.moveCursorPoint({x:.5,y:.5});

Returns void

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgrFinancialOverlay

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Section titled "playTransitionIn"

Inherited from: IgrFinancialOverlay

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Section titled "playTransitionOut"

Inherited from: IgrFinancialOverlay

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Section titled "playTransitionOutAndRemove"

Inherited from: IgrFinancialOverlay

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Section titled "provideData"

Inherited from: IgrFinancialOverlay 

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

provideHighlightedData

Section titled "provideHighlightedData"

Inherited from: IgrFinancialOverlay 

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

removeAllAlternateViews

Section titled "removeAllAlternateViews"

Inherited from: IgrFinancialOverlay

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Section titled "removeAlternateView"

Inherited from: IgrFinancialOverlay

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Section titled "render"

Inherited from: IgrFinancialOverlay 

render(): any

Returns any

renderSeries

Section titled "renderSeries"

Inherited from: IgrFinancialOverlay

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

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Section titled "resolveTooltipBrush"

Inherited from: IgrFinancialOverlay

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Section titled "scrollIntoView"

Inherited from: IgrFinancialOverlay

Scrolls the series to display the item for the specified data item. The series is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.

scrollIntoView(item: any): boolean

Parameters

  • item: any
    • The data item (item) to scroll to.

    Use the ScrollIntoView method to scrolls the series to display the item for the specified data item.

Returns boolean

setNegativeColors

Section titled "setNegativeColors"

Inherited from: IgrFinancialOverlay 

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrFinancialOverlay 

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateHover

Section titled "simulateHover"

Inherited from: IgrFinancialOverlay

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

  • point: IgPoint
    • The pointer position relative to the series viewport over which to hover.

    When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.

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

Returns void

styleUpdated

Section titled "styleUpdated"

Inherited from: IgrFinancialOverlay

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Section titled "toWorldPosition"

Inherited from: IgrFinancialOverlay

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

Converts a rect from coordinates within the series plot area to a world position within axis space.

toWorldRect(rect: IgRect): IgRect

Parameters

  • rect: IgRect
    • The pixel rect within the plot area of the series.

Returns IgRect

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrFinancialOverlay 

_createFromInternal(internal: any): IgrSeries

Parameters

  • internal: any

Returns IgrSeries