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

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

<igx-data-chart
	#chart
    [dataSource]="data" >
    <igx-category-x-axis
		label="label"
		#xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
		#yAxis>
    </igx-numeric-y-axis>
    <igx-bollinger-band-overlay
		[xAxis]="xAxis"
		[yAxis]="yAxis"
		openMemberPath="open"
		highMemberPath="high"
		lowMemberPath="low"
		closeMemberPath="close">
    </igx-bollinger-band-overlay>
</igx-data-chart>
let series = new IgxBollingerBandOverlayComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
this.chart.series.add(series);

IgxBollingerBandsOverlayComponent

new IgxBollingerBandsOverlayComponent(): IgxBollingerBandsOverlayComponent

Returns IgxBollingerBandsOverlayComponent

ngAcceptInputType_actualAreaFillOpacity

Section titled "ngAcceptInputType_actualAreaFillOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualAreaFillOpacity: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualFocusMode: string | SeriesSelectionMode

ngAcceptInputType_actualHighlightedValuesFadeOpacity

Section titled "ngAcceptInputType_actualHighlightedValuesFadeOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualHighlightedValuesFadeOpacity: string | number

ngAcceptInputType_actualHighlightingFadeOpacity

Section titled "ngAcceptInputType_actualHighlightingFadeOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualHighlightingFadeOpacity: string | number

ngAcceptInputType_actualHighlightingMode

Section titled "ngAcceptInputType_actualHighlightingMode"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualHighlightingMode: string | SeriesHighlightingMode

ngAcceptInputType_actualHitTestMode

Section titled "ngAcceptInputType_actualHitTestMode"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualHitTestMode: string | SeriesHitTestMode

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualLayers: string | IgxSeriesLayerCollection

ngAcceptInputType_actualMarkerFillOpacity

Section titled "ngAcceptInputType_actualMarkerFillOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualMarkerFillOpacity: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualResolution: string | number

ngAcceptInputType_actualSelectionMode

Section titled "ngAcceptInputType_actualSelectionMode"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualSelectionMode: string | SeriesSelectionMode

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_actualThickness: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_areaFillOpacity: string | number

ngAcceptInputType_attachTooltipToRoot

Section titled "ngAcceptInputType_attachTooltipToRoot"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_attachTooltipToRoot: string | boolean

ngAcceptInputType_autoCalloutLabelFormatSpecifiers

Section titled "ngAcceptInputType_autoCalloutLabelFormatSpecifiers"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_autoCalloutLabelFormatSpecifiers: string | any[]

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers

Section titled "ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers: string | any[]

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_dashArray: string | number[]

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_expectFunctions: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_finalValue: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_hasMarkers: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_hasOnlyMarkers: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_hasValueAxis: string | boolean

ngAcceptInputType_hasVisibleMarkers

Section titled "ngAcceptInputType_hasVisibleMarkers"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_hasVisibleMarkers: string | boolean

ngAcceptInputType_highlightedLegendItemVisibility

Section titled "ngAcceptInputType_highlightedLegendItemVisibility"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_highlightedLegendItemVisibility: any

ngAcceptInputType_highlightedValuesDisplayMode

Section titled "ngAcceptInputType_highlightedValuesDisplayMode"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_highlightedValuesDisplayMode: any

ngAcceptInputType_highlightedValuesExtraPropertyOverlays

Section titled "ngAcceptInputType_highlightedValuesExtraPropertyOverlays"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_highlightedValuesExtraPropertyOverlays: string | IgxSeriesLayerPropertyOverlayCollection

ngAcceptInputType_highlightedValuesFadeOpacity

Section titled "ngAcceptInputType_highlightedValuesFadeOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_highlightedValuesFadeOpacity: string | number

ngAcceptInputType_highlightingFadeOpacity

Section titled "ngAcceptInputType_highlightingFadeOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_highlightingFadeOpacity: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_hitTestMode: string | SeriesHitTestMode

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_ignoreFirst: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_index: string | number

ngAcceptInputType_isActualLegendFinancial

Section titled "ngAcceptInputType_isActualLegendFinancial"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isActualLegendFinancial: string | boolean

ngAcceptInputType_isAnnotationCalloutLayer

Section titled "ngAcceptInputType_isAnnotationCalloutLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationCalloutLayer: string | boolean

ngAcceptInputType_isAnnotationCrosshairLayer

Section titled "ngAcceptInputType_isAnnotationCrosshairLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationCrosshairLayer: string | boolean

ngAcceptInputType_isAnnotationDataLayer

Section titled "ngAcceptInputType_isAnnotationDataLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationDataLayer: string | boolean

ngAcceptInputType_isAnnotationFinalValue

Section titled "ngAcceptInputType_isAnnotationFinalValue"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationFinalValue: string | boolean

ngAcceptInputType_isAnnotationHoverLayer

Section titled "ngAcceptInputType_isAnnotationHoverLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationHoverLayer: string | boolean

ngAcceptInputType_isAnnotationLayer

Section titled "ngAcceptInputType_isAnnotationLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationLayer: string | boolean

ngAcceptInputType_isAnnotationValueLayer

Section titled "ngAcceptInputType_isAnnotationValueLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAnnotationValueLayer: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isArea: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isAreaOrLine: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isBar: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isColoredItemwise

Section titled "ngAcceptInputType_isColoredItemwise"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isColoredItemwise: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isColumn: string | boolean

ngAcceptInputType_isComponentHighlightingModeIgnored

Section titled "ngAcceptInputType_isComponentHighlightingModeIgnored"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isComponentHighlightingModeIgnored: string | boolean

ngAcceptInputType_isCustomCategoryStyleAllowed

Section titled "ngAcceptInputType_isCustomCategoryStyleAllowed"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isCustomCategoryStyleAllowed: string | boolean

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled

Section titled "ngAcceptInputType_isDefaultCrosshairBehaviorDisabled"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultTooltipBehaviorDisabled

Section titled "ngAcceptInputType_isDefaultTooltipBehaviorDisabled"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isDefaultTooltipBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultToolTipSelected

Section titled "ngAcceptInputType_isDefaultToolTipSelected"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isDefaultToolTipSelected: string | boolean

ngAcceptInputType_isDropShadowEnabled

Section titled "ngAcceptInputType_isDropShadowEnabled"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isDropShadowEnabled: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFinancial: string | boolean

ngAcceptInputType_isFinancialIndicator

Section titled "ngAcceptInputType_isFinancialIndicator"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFinancialIndicator: string | boolean

ngAcceptInputType_isFinancialOverlay

Section titled "ngAcceptInputType_isFinancialOverlay"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFinancialOverlay: string | boolean

ngAcceptInputType_isFinancialSeries

Section titled "ngAcceptInputType_isFinancialSeries"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFinancialSeries: string | boolean

ngAcceptInputType_isFinancialWaterfall

Section titled "ngAcceptInputType_isFinancialWaterfall"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFinancialWaterfall: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isFragment: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_isHighlightingEnabled

Section titled "ngAcceptInputType_isHighlightingEnabled"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isHighlightingEnabled: string | boolean

ngAcceptInputType_isHighlightOverlay

Section titled "ngAcceptInputType_isHighlightOverlay"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isHighlightOverlay: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isIndexed: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isLayer: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isLineContour: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isLineOnly: string | boolean

ngAcceptInputType_isMarkerlessDisplayPreferred

Section titled "ngAcceptInputType_isMarkerlessDisplayPreferred"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isMarkerlessDisplayPreferred: string | boolean

ngAcceptInputType_isNegativeColorSupported

Section titled "ngAcceptInputType_isNegativeColorSupported"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isNegativeColorSupported: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isPie: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isPixel: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isPolar: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isPolygon: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isPolyline: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isRadial: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isRange: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isScatter: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isShape: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isShapeControl: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isSpline: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isStacked: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isStep: string | boolean

ngAcceptInputType_isSummarizationSupported

Section titled "ngAcceptInputType_isSummarizationSupported"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isSummarizationSupported: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isTile: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isToolTipLayer: string | boolean

ngAcceptInputType_isTransitionInEnabled

Section titled "ngAcceptInputType_isTransitionInEnabled"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isTransitionInEnabled: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isUsableInLegend: string | boolean

ngAcceptInputType_isUserAnnotationLayer

Section titled "ngAcceptInputType_isUserAnnotationLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isUserAnnotationLayer: string | boolean

ngAcceptInputType_isUserAnnotationToolTipLayer

Section titled "ngAcceptInputType_isUserAnnotationToolTipLayer"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isUserAnnotationToolTipLayer: string | boolean

ngAcceptInputType_isValueAxisInverted

Section titled "ngAcceptInputType_isValueAxisInverted"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isValueAxisInverted: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isValueOverlay: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isVertical: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_isWaterfall: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_layers: string | IgxSeriesLayerCollection

ngAcceptInputType_legendItemBadgeMode

Section titled "ngAcceptInputType_legendItemBadgeMode"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_legendItemBadgeMode: any

ngAcceptInputType_legendItemBadgeShape

Section titled "ngAcceptInputType_legendItemBadgeShape"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_legendItemBadgeShape: any

ngAcceptInputType_legendItemVisibility

Section titled "ngAcceptInputType_legendItemVisibility"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_legendItemVisibility: any

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_lineCap: any

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_lineJoin: any

ngAcceptInputType_markerFillOpacity

Section titled "ngAcceptInputType_markerFillOpacity"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_markerFillOpacity: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_mouseOverEnabled: string | boolean
ngAcceptInputType_multiplier: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_opacity: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_outlineMode: string | SeriesOutlineMode

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_percentChange: string | number
ngAcceptInputType_period: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_resolution: string | number

ngAcceptInputType_selectionThickness

Section titled "ngAcceptInputType_selectionThickness"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_selectionThickness: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shadowBlur: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shadowOffsetX: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shadowOffsetY: string | number

ngAcceptInputType_shouldAnimateOnDataSourceSwap

Section titled "ngAcceptInputType_shouldAnimateOnDataSourceSwap"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shouldAnimateOnDataSourceSwap: string | boolean

ngAcceptInputType_shouldHideAutoCallouts

Section titled "ngAcceptInputType_shouldHideAutoCallouts"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shouldHideAutoCallouts: string | boolean

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden

Section titled "ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden: string | boolean

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush

Section titled "ngAcceptInputType_shouldShiftOpacityForSafeActualBrush"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush: string | boolean

ngAcceptInputType_showDefaultTooltip

Section titled "ngAcceptInputType_showDefaultTooltip"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_showDefaultTooltip: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_thickness: string | number

ngAcceptInputType_transitionDuration

Section titled "ngAcceptInputType_transitionDuration"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionDuration: string | number

ngAcceptInputType_transitionInDuration

Section titled "ngAcceptInputType_transitionInDuration"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionInDuration: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionInMode: string | CategoryTransitionInMode

ngAcceptInputType_transitionInSpeedType

Section titled "ngAcceptInputType_transitionInSpeedType"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType

ngAcceptInputType_transitionOutDuration

Section titled "ngAcceptInputType_transitionOutDuration"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionOutDuration: string | number

ngAcceptInputType_transitionOutSpeedType

Section titled "ngAcceptInputType_transitionOutSpeedType"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_transitionOutSpeedType: string | TransitionOutSpeedType

ngAcceptInputType_useItemWiseColors

Section titled "ngAcceptInputType_useItemWiseColors"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_useItemWiseColors: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_useSingleShadow: string | boolean

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibility: any

ngAcceptInputType_visibleRangeMarginBottom

Section titled "ngAcceptInputType_visibleRangeMarginBottom"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibleRangeMarginBottom: string | number

ngAcceptInputType_visibleRangeMarginLeft

Section titled "ngAcceptInputType_visibleRangeMarginLeft"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibleRangeMarginLeft: string | number

ngAcceptInputType_visibleRangeMarginRight

Section titled "ngAcceptInputType_visibleRangeMarginRight"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibleRangeMarginRight: string | number

ngAcceptInputType_visibleRangeMarginTop

Section titled "ngAcceptInputType_visibleRangeMarginTop"

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibleRangeMarginTop: string | number

Inherited from: IgxFinancialOverlayComponent

ngAcceptInputType_visibleRangeMode: string | SeriesVisibleRangeMode
ɵcmp: ɵɵComponentDeclaration<IgxBollingerBandsOverlayComponent, "igx-bollinger-bands-overlay", never, object, object, never, never>
ɵfac: ɵɵFactoryDeclaration<IgxBollingerBandsOverlayComponent, never>

Inherited from: IgxFinancialOverlayComponent

actualAreaFillOpacity: number

Inherited from: IgxFinancialOverlayComponent

actualBrush: string

Inherited from: IgxFinancialOverlayComponent

actualFocusBrush: string

Inherited from: IgxFinancialOverlayComponent

actualFocusMode: SeriesSelectionMode

Inherited from: IgxFinancialOverlayComponent

actualHighlightedValuesFadeOpacity: number

Inherited from: IgxFinancialOverlayComponent

actualHighlightingFadeOpacity: number

Inherited from: IgxFinancialOverlayComponent

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgxFinancialOverlayComponent

actualHitTestMode: SeriesHitTestMode

Inherited from: IgxFinancialOverlayComponent

actualLayers: IgxSeriesLayerCollection

Inherited from: IgxFinancialOverlayComponent

actualLegendItemBadgeBrush: string

Inherited from: IgxFinancialOverlayComponent

actualLegendItemBadgeOutline: string

Inherited from: IgxFinancialOverlayComponent

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgxFinancialOverlayComponent

actualMarkerFillOpacity: number

Inherited from: IgxFinancialOverlayComponent

actualOutline: string

Inherited from: IgxFinancialOverlayComponent

actualResolution: number

Inherited from: IgxFinancialOverlayComponent

actualSelectionBrush: string

Inherited from: IgxFinancialOverlayComponent

actualSelectionMode: SeriesSelectionMode

Inherited from: IgxFinancialOverlayComponent

actualThickness: number

Inherited from: IgxFinancialOverlayComponent

areaFillOpacity: number

Inherited from: IgxFinancialOverlayComponent

attachTooltipToRoot: boolean

Inherited from: IgxFinancialOverlayComponent

autoCalloutLabelFormat: string

Inherited from: IgxFinancialOverlayComponent

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgxFinancialOverlayComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgxFinancialOverlayComponent

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgxFinancialOverlayComponent

brush: string

Inherited from: IgxFinancialOverlayComponent

closeMemberPath: string

Inherited from: IgxFinancialOverlayComponent

coercionMethods: any

Inherited from: IgxFinancialOverlayComponent

dashArray: number[]

Inherited from: IgxFinancialOverlayComponent

dataLegendGroup: string

Inherited from: IgxFinancialOverlayComponent

dataSource: any

Inherited from: IgxFinancialOverlayComponent

discreteLegendItemTemplate: IgDataTemplate

Inherited from: IgxFinancialOverlayComponent

expectFunctions: boolean

Inherited from: IgxFinancialOverlayComponent

finalValue: number

Inherited from: IgxFinancialOverlayComponent

focusBrush: string

Inherited from: IgxFinancialOverlayComponent

highlightedCloseMemberPath: string

Inherited from: IgxFinancialOverlayComponent

highlightedDataSource: any

Inherited from: IgxFinancialOverlayComponent

highlightedHighMemberPath: string

Inherited from: IgxFinancialOverlayComponent

highlightedLegendItemVisibility: Visibility

Inherited from: IgxFinancialOverlayComponent

highlightedLowMemberPath: string

Inherited from: IgxFinancialOverlayComponent

highlightedOpenMemberPath: string

Inherited from: IgxFinancialOverlayComponent

highlightedTitleSuffix: string

Inherited from: IgxFinancialOverlayComponent

highlightedValuesDataLegendGroup: string

Inherited from: IgxFinancialOverlayComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgxFinancialOverlayComponent

highlightedValuesExtraPropertyOverlays: IgxSeriesLayerPropertyOverlayCollection

Inherited from: IgxFinancialOverlayComponent

highlightedValuesFadeOpacity: number

Inherited from: IgxFinancialOverlayComponent

highlightedVolumeMemberPath: string

Inherited from: IgxFinancialOverlayComponent

highlightingFadeOpacity: number

Inherited from: IgxFinancialOverlayComponent

highMemberPath: string

Inherited from: IgxFinancialOverlayComponent

hitTestMode: SeriesHitTestMode

Inherited from: IgxFinancialOverlayComponent

ignoreFirst: number

Inherited from: IgxFinancialOverlayComponent

index: number

Inherited from: IgxFinancialOverlayComponent

isActualLegendFinancial: boolean

Inherited from: IgxFinancialOverlayComponent

isComponentHighlightingModeIgnored: boolean

Inherited from: IgxFinancialOverlayComponent

isCustomCategoryStyleAllowed: boolean

Inherited from: IgxFinancialOverlayComponent

isDefaultToolTipSelected: boolean

Inherited from: IgxFinancialOverlayComponent

isDropShadowEnabled: boolean

Inherited from: IgxFinancialOverlayComponent

isHighlightingEnabled: boolean

Inherited from: IgxFinancialOverlayComponent

isTransitionInEnabled: boolean

Inherited from: IgxFinancialOverlayComponent

layers: IgxSeriesLayerCollection

Inherited from: IgxFinancialOverlayComponent

legend: any

Inherited from: IgxFinancialOverlayComponent

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgxFinancialOverlayComponent

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgxFinancialOverlayComponent

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgxFinancialOverlayComponent

legendItemTemplate: IgDataTemplate

Inherited from: IgxFinancialOverlayComponent

legendItemVisibility: Visibility

Inherited from: IgxFinancialOverlayComponent

lineCap: PenLineCap

Inherited from: IgxFinancialOverlayComponent

lineJoin: PenLineJoin

Inherited from: IgxFinancialOverlayComponent

lowMemberPath: string

Inherited from: IgxFinancialOverlayComponent

markerFillOpacity: number

Inherited from: IgxFinancialOverlayComponent

mouseOverEnabled: boolean
multiplier: number

Inherited from: IgxFinancialOverlayComponent

name: string

Inherited from: IgxFinancialOverlayComponent

negativeBrush: string

Inherited from: IgxFinancialOverlayComponent

opacity: number

Inherited from: IgxFinancialOverlayComponent

openMemberPath: string

Inherited from: IgxFinancialOverlayComponent

outline: string

Inherited from: IgxFinancialOverlayComponent

outlineMode: SeriesOutlineMode

Inherited from: IgxFinancialOverlayComponent

percentChange: number
period: number

Inherited from: IgxFinancialOverlayComponent

resolution: number

Inherited from: IgxFinancialOverlayComponent

safeActualBrush: string

Inherited from: IgxFinancialOverlayComponent

selectionBrush: string

Inherited from: IgxFinancialOverlayComponent

selectionThickness: number

Inherited from: IgxFinancialOverlayComponent

shadowBlur: number

Inherited from: IgxFinancialOverlayComponent

shadowColor: string

Inherited from: IgxFinancialOverlayComponent

shadowOffsetX: number

Inherited from: IgxFinancialOverlayComponent

shadowOffsetY: number

Inherited from: IgxFinancialOverlayComponent

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgxFinancialOverlayComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgxFinancialOverlayComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgxFinancialOverlayComponent

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgxFinancialOverlayComponent

showDefaultTooltip: boolean

Inherited from: IgxFinancialOverlayComponent

thickness: number

Inherited from: IgxFinancialOverlayComponent

title: any

Inherited from: IgxFinancialOverlayComponent

tooltipContainerTemplate: TemplateRef<any>

Inherited from: IgxFinancialOverlayComponent

tooltipTemplate: TemplateRef<any>

Inherited from: IgxFinancialOverlayComponent

transitionDuration: number

Inherited from: IgxFinancialOverlayComponent

transitionEasingFunction: object

Inherited from: IgxFinancialOverlayComponent

transitionInDuration: number

Inherited from: IgxFinancialOverlayComponent

transitionInEasingFunction: object

Inherited from: IgxFinancialOverlayComponent

transitionInMode: CategoryTransitionInMode

Inherited from: IgxFinancialOverlayComponent

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgxFinancialOverlayComponent

transitionOutDuration: number

Inherited from: IgxFinancialOverlayComponent

transitionOutEasingFunction: object

Inherited from: IgxFinancialOverlayComponent

transitionOutSpeedType: TransitionOutSpeedType

Inherited from: IgxFinancialOverlayComponent

useItemWiseColors: boolean

Inherited from: IgxFinancialOverlayComponent

useSingleShadow: boolean

Inherited from: IgxFinancialOverlayComponent

visibility: Visibility

Inherited from: IgxFinancialOverlayComponent

visibleRangeMarginBottom: number

Inherited from: IgxFinancialOverlayComponent

visibleRangeMarginLeft: number

Inherited from: IgxFinancialOverlayComponent

visibleRangeMarginRight: number

Inherited from: IgxFinancialOverlayComponent

visibleRangeMarginTop: number

Inherited from: IgxFinancialOverlayComponent

visibleRangeMode: SeriesVisibleRangeMode

Inherited from: IgxFinancialOverlayComponent

volumeMemberPath: string

Inherited from: IgxFinancialOverlayComponent

xAxis: IgxCategoryAxisBaseComponent

Inherited from: IgxFinancialOverlayComponent

yAxis: IgxNumericYAxisComponent

Inherited from: IgxFinancialOverlayComponent

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

get actualCloseLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualHighLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualLowLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualOpenLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualRadiusLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualValueLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

get actualVolumeLabel(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

Event raised when Assigning Category Style

The AssigningCategoryStyle event raised when assigning Category Style.

series.assigningCategoryStyle= this.chart_AssigningCategoryStyle;
chart_AssigningCategoryStyle(sender :any,args: AssigningCategoryStyleEventArgs )
  {


  }
get assigningCategoryStyle(): EventEmitter<object>

Returns EventEmitter<object>

Inherited from: IgxFinancialOverlayComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

Returns whether the current series supports visual markers.

let hasMarkers: boolean = this.series.hasMarkers;
get hasMarkers(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

get isAnnotationDataLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

Gets whether the series is an annotation layer.

let isAnnotationLayer: boolean = this.series.isAnnotationLayer;
get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

let isAreaorLine: boolean = this.series.isAreaorLine;
get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a category type series.

let isCategory: boolean = this.series.isCategory;
get isCategory(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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.

let isDefaultCrosshairBehaviorDisabled: boolean = this.series.isDefaultCrosshairBehaviorDisabled;
get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;
get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a stack fragment.

let isFragment: boolean = this.series.isFragment;
get isFragment(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a geographic series.

let isGeographic: boolean = this.series.isGeographic;
get isGeographic(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

let isIndexed: boolean = this.series.isIndexed;
get isIndexed(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

get isLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a polar type series.

let isPolar: boolean = this.series.isPolar;
get isPolar(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a radial type series.

let isRadial: boolean = this.series.isRadial;
get isRadial(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a range type series.

let isRange: boolean = this.series.isRange;
get isRange(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a scatter type series.

let isScatter: boolean = this.series.isScatter;
get isScatter(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is a stacked type series.

let isStacked: boolean = this.series.isStacked;
get isStacked(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

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

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets if the series should appear in any legends.

let isUsableInLegend: boolean = this.series.isUsableInLegend;
get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series is oriented vertically.

let isVertical: boolean = this.series.isVertical;
get isVertical(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgxFinancialOverlayComponent

This event is raised every time a render has been requested from a series.

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

Inherited from: IgxFinancialOverlayComponent

get seriesInternal(): any

Returns any

Inherited from: IgxFinancialOverlayComponent

Fired when a transition out has completed.

get transitionOutCompleted(): EventEmitter<object>

Returns EventEmitter<object>

Inherited from: IgxFinancialOverlayComponent

Handle this event in order to perform a custom typical price calculation.

Use Typical event to perform a custom typical price calculation.

series.typical= this.chart_typical;

  chart_typical(sender :any,args: FinancialEventArgs )
  {


  }
get typical(): EventEmitter<object>

Returns EventEmitter<object>

Inherited from: IgxFinancialOverlayComponent

Handle this event in order to specify which columns the Typical price calculation is based on.

Use TypicalBasedOn event to specify which columns the Typical price calculation is based on.

series.typicalBasedOn= this.chart_typicalBasedOn;
    chart_typicalBasedOn(sender :any,args: FinancialEventArgs )
  {

  }
get typicalBasedOn(): EventEmitter<object>

Returns EventEmitter<object>

Inherited from: IgxFinancialOverlayComponent

bindAxes(axes: IgxAxisComponent[]): void

Parameters

Returns void

Inherited from: IgxFinancialOverlayComponent

bindSeries(series: IgxSeriesComponent[]): void

Parameters

Returns void

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgxFinancialOverlayComponent

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.
    let pt: IgxPoint = this.series.fromWorldPosition({x:.5,y:.5});

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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.

number width = series.getCategoryWidth();
getCategoryWidth(): number

Returns number

Inherited from: IgxFinancialOverlayComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

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.

let span: number = this.series.getItemSpan();
getItemSpan(): number

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgxFinancialOverlayComponent

getMainContentViewport(): IgRect

Returns IgRect

Inherited from: IgxFinancialOverlayComponent

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgxFinancialOverlayComponent

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.

number offset= series.getOffsetValue();
getOffsetValue(): number

Returns number

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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
    let box: IgxRect = this.series.getSeriesValueBoundingBox({x:.8,y:.8});

Returns IgRect

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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
    let box: IgxRect = this.series.getSeriesValueMarkerBoundingBox({x:.8,y:.8});

Returns IgRect

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgxFinancialOverlayComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns number

Inherited from: IgxFinancialOverlayComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgxFinancialOverlayComponent

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

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

hideToolTips(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

hideToolTipsImmediate(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

ngOnInit(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

notifyIndexedPropertiesChanged(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgxFinancialOverlayComponent

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgxFinancialOverlayComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

Replays the assigned transition in animation, if any.

this.series.replayTransitionIn();
replayTransitionIn(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

Inherited from: IgxFinancialOverlayComponent

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

Inherited from: IgxFinancialOverlayComponent

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgxFinancialOverlayComponent

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

Inherited from: IgxFinancialOverlayComponent

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

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

_createFromInternal(internal: any): IgxSeriesComponent

Parameters

  • internal: any

Returns IgxSeriesComponent