IgxFinancialPriceSeriesComponent

Represents a IgxDataChartComponent financial price series that renders as Candlestick or OHLC representations. Default required members: Open, Low, High, Close

The FinancialPriceSeries class represents a IgxDataChartComponent financial price series that renders as Candlestick or OHLC representations.

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      >
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
   series.xAxis = this.xAxis;
   series.yAxis = this.yAxis;
   series.openMemberPath = "open";
   series.highMemberPath = "high";
   series.lowMemberPath = "low";
   series.closeMemberPath = "close";
   series.volumeMemberPath="volume";
   this.chart.series.add(series);

Constructors

new IgxFinancialPriceSeriesComponent(): IgxFinancialPriceSeriesComponent

Returns IgxFinancialPriceSeriesComponent

Properties

ngAcceptInputType_actualAreaFillOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualAreaFillOpacity: string | number

ngAcceptInputType_actualFocusMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualFocusMode: string | SeriesSelectionMode

ngAcceptInputType_actualHighlightedValuesFadeOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualHighlightedValuesFadeOpacity: string | number

ngAcceptInputType_actualHighlightingFadeOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualHighlightingFadeOpacity: string | number

ngAcceptInputType_actualHighlightingMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualHighlightingMode: string | SeriesHighlightingMode

ngAcceptInputType_actualHitTestMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualHitTestMode: string | SeriesHitTestMode

ngAcceptInputType_actualLayers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualLayers: string | IgxSeriesLayerCollection

ngAcceptInputType_actualMarkerFillOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualMarkerFillOpacity: string | number

ngAcceptInputType_actualResolution

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualResolution: string | number

ngAcceptInputType_actualSelectionMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualSelectionMode: string | SeriesSelectionMode

ngAcceptInputType_actualThickness

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_actualThickness: string | number

ngAcceptInputType_areaFillOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_areaFillOpacity: string | number

ngAcceptInputType_attachTooltipToRoot

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_attachTooltipToRoot: string | boolean

ngAcceptInputType_autoCalloutLabelFormatSpecifiers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_autoCalloutLabelFormatSpecifiers: string | any[]

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers: string | any[]

ngAcceptInputType_categoryCollisionMode

ngAcceptInputType_categoryCollisionMode: string | CategoryCollisionMode

ngAcceptInputType_dashArray

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_dashArray: string | number[]

ngAcceptInputType_displayType

ngAcceptInputType_displayType: string | PriceDisplayType

ngAcceptInputType_expectFunctions

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_expectFunctions: string | boolean

ngAcceptInputType_finalValue

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_finalValue: string | number

ngAcceptInputType_hasMarkers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_hasOnlyMarkers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_hasOnlyMarkers: string | boolean

ngAcceptInputType_hasValueAxis

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_hasValueAxis: string | boolean

ngAcceptInputType_hasVisibleMarkers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_hasVisibleMarkers: string | boolean

ngAcceptInputType_highlightedLegendItemVisibility

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_highlightedLegendItemVisibility: any

ngAcceptInputType_highlightedValuesDisplayMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_highlightedValuesDisplayMode: any

ngAcceptInputType_highlightedValuesExtraPropertyOverlays

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_highlightedValuesExtraPropertyOverlays: string | IgxSeriesLayerPropertyOverlayCollection

ngAcceptInputType_highlightedValuesFadeOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_highlightedValuesFadeOpacity: string | number

ngAcceptInputType_highlightingFadeOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_highlightingFadeOpacity: string | number

ngAcceptInputType_hitTestMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_hitTestMode: string | SeriesHitTestMode

ngAcceptInputType_index

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_index: string | number

ngAcceptInputType_isActualLegendFinancial

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isActualLegendFinancial: string | boolean

ngAcceptInputType_isAnnotationCalloutLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationCalloutLayer: string | boolean

ngAcceptInputType_isAnnotationCrosshairLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationCrosshairLayer: string | boolean

ngAcceptInputType_isAnnotationDataLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationDataLayer: string | boolean

ngAcceptInputType_isAnnotationFinalValue

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationFinalValue: string | boolean

ngAcceptInputType_isAnnotationHoverLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationHoverLayer: string | boolean

ngAcceptInputType_isAnnotationLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationLayer: string | boolean

ngAcceptInputType_isAnnotationValueLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAnnotationValueLayer: string | boolean

ngAcceptInputType_isArea

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isArea: string | boolean

ngAcceptInputType_isAreaOrLine

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isAreaOrLine: string | boolean

ngAcceptInputType_isBar

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isBar: string | boolean

ngAcceptInputType_isCategory

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isColoredItemwise

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isColoredItemwise: string | boolean

ngAcceptInputType_isColumn

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isColumn: string | boolean

ngAcceptInputType_isComponentHighlightingModeIgnored

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isComponentHighlightingModeIgnored: string | boolean

ngAcceptInputType_isCustomCategoryStyleAllowed

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isCustomCategoryStyleAllowed: string | boolean

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultTooltipBehaviorDisabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isDefaultTooltipBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultToolTipSelected

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isDefaultToolTipSelected: string | boolean

ngAcceptInputType_isDropShadowEnabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isDropShadowEnabled: string | boolean

ngAcceptInputType_isFinancial

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isFinancial: string | boolean

ngAcceptInputType_isFinancialIndicator

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isFinancialIndicator: string | boolean

ngAcceptInputType_isFinancialOverlay

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isFinancialOverlay: string | boolean

ngAcceptInputType_isFinancialSeries

ngAcceptInputType_isFinancialSeries: string | boolean

ngAcceptInputType_isFinancialWaterfall

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isFinancialWaterfall: string | boolean

ngAcceptInputType_isFragment

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isFragment: string | boolean

ngAcceptInputType_isGeographic

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_isHighlightingEnabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isHighlightingEnabled: string | boolean

ngAcceptInputType_isHighlightOverlay

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isHighlightOverlay: string | boolean

ngAcceptInputType_isIndexed

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isIndexed: string | boolean

ngAcceptInputType_isLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isLayer: string | boolean

ngAcceptInputType_isLineContour

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isLineContour: string | boolean

ngAcceptInputType_isLineOnly

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isLineOnly: string | boolean

ngAcceptInputType_isMarkerlessDisplayPreferred

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isMarkerlessDisplayPreferred: string | boolean

ngAcceptInputType_isNegativeColorSupported

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isNegativeColorSupported: string | boolean

ngAcceptInputType_isPie

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isPie: string | boolean

ngAcceptInputType_isPixel

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isPixel: string | boolean

ngAcceptInputType_isPolar

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isPolar: string | boolean

ngAcceptInputType_isPolygon

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isPolygon: string | boolean

ngAcceptInputType_isPolyline

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isPolyline: string | boolean

ngAcceptInputType_isRadial

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isRadial: string | boolean

ngAcceptInputType_isRange

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isRange: string | boolean

ngAcceptInputType_isScatter

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isScatter: string | boolean

ngAcceptInputType_isShape

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isShape: string | boolean

ngAcceptInputType_isShapeControl

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isShapeControl: string | boolean

ngAcceptInputType_isSpline

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isSpline: string | boolean

ngAcceptInputType_isStacked

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isStacked: string | boolean

ngAcceptInputType_isStep

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isStep: string | boolean

ngAcceptInputType_isSummarizationSupported

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isSummarizationSupported: string | boolean

ngAcceptInputType_isTile

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isTile: string | boolean

ngAcceptInputType_isToolTipLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isToolTipLayer: string | boolean

ngAcceptInputType_isTransitionInEnabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isTransitionInEnabled: string | boolean

ngAcceptInputType_isUsableInLegend

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isUsableInLegend: string | boolean

ngAcceptInputType_isUserAnnotationLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isUserAnnotationLayer: string | boolean

ngAcceptInputType_isUserAnnotationToolTipLayer

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isUserAnnotationToolTipLayer: string | boolean

ngAcceptInputType_isValueAxisInverted

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isValueAxisInverted: string | boolean

ngAcceptInputType_isValueOverlay

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isValueOverlay: string | boolean

ngAcceptInputType_isVertical

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isVertical: string | boolean

ngAcceptInputType_isWaterfall

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_isWaterfall: string | boolean

ngAcceptInputType_layers

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_layers: string | IgxSeriesLayerCollection

ngAcceptInputType_legendItemBadgeMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_legendItemBadgeMode: any

ngAcceptInputType_legendItemBadgeShape

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_legendItemBadgeShape: any

ngAcceptInputType_legendItemVisibility

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_legendItemVisibility: any

ngAcceptInputType_lineCap

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_lineCap: any

ngAcceptInputType_lineJoin

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_lineJoin: any

ngAcceptInputType_markerFillOpacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_markerFillOpacity: string | number

ngAcceptInputType_mouseOverEnabled

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_mouseOverEnabled: string | boolean

ngAcceptInputType_opacity

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_opacity: string | number

ngAcceptInputType_outlineMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_outlineMode: string | SeriesOutlineMode

ngAcceptInputType_percentChange

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_percentChange: string | number

ngAcceptInputType_resolution

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_resolution: string | number

ngAcceptInputType_selectionThickness

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_selectionThickness: string | number

ngAcceptInputType_shadowBlur

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shadowBlur: string | number

ngAcceptInputType_shadowOffsetX

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shadowOffsetX: string | number

ngAcceptInputType_shadowOffsetY

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shadowOffsetY: string | number

ngAcceptInputType_shouldAnimateOnDataSourceSwap

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shouldAnimateOnDataSourceSwap: string | boolean

ngAcceptInputType_shouldHideAutoCallouts

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shouldHideAutoCallouts: string | boolean

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden: string | boolean

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush: string | boolean

ngAcceptInputType_showDefaultTooltip

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_showDefaultTooltip: string | boolean

ngAcceptInputType_thickness

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_thickness: string | number

ngAcceptInputType_transitionDuration

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionDuration: string | number

ngAcceptInputType_transitionInDuration

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionInDuration: string | number

ngAcceptInputType_transitionInMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionInMode: string | CategoryTransitionInMode

ngAcceptInputType_transitionInSpeedType

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType

ngAcceptInputType_transitionOutDuration

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionOutDuration: string | number

ngAcceptInputType_transitionOutSpeedType

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_transitionOutSpeedType: string | TransitionOutSpeedType

ngAcceptInputType_trendLineDashArray

ngAcceptInputType_trendLineDashArray: string | number[]

ngAcceptInputType_trendLinePeriod

ngAcceptInputType_trendLinePeriod: string | number

ngAcceptInputType_trendLineThickness

ngAcceptInputType_trendLineThickness: string | number

ngAcceptInputType_trendLineType

ngAcceptInputType_trendLineType: any

ngAcceptInputType_useItemWiseColors

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_useItemWiseColors: string | boolean

ngAcceptInputType_useSingleShadow

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_useSingleShadow: string | boolean

ngAcceptInputType_visibility

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibility: any

ngAcceptInputType_visibleRangeMarginBottom

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibleRangeMarginBottom: string | number

ngAcceptInputType_visibleRangeMarginLeft

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibleRangeMarginLeft: string | number

ngAcceptInputType_visibleRangeMarginRight

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibleRangeMarginRight: string | number

ngAcceptInputType_visibleRangeMarginTop

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibleRangeMarginTop: string | number

ngAcceptInputType_visibleRangeMode

Inherited from: IgxFinancialSeriesComponent

ngAcceptInputType_visibleRangeMode: string | SeriesVisibleRangeMode

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxFinancialPriceSeriesComponent, "igx-financial-price-series", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxFinancialPriceSeriesComponent, never>

Accessors

actualAreaFillOpacity

Inherited from: IgxFinancialSeriesComponent

Gets the actual opacity applied to the area fill visual.

let actualFillOpacity: number = series.actualAreaFillOpacity;

get actualAreaFillOpacity(): number

Returns number

set actualAreaFillOpacity(v: number): void

Parameters

v: number

Returns void

actualBrush

Inherited from: IgxFinancialSeriesComponent

Gets the effective brush for the current series object.

let actualBrush: string = series.actualBrush;

get actualBrush(): string

Returns string

set actualBrush(v: string): void

Parameters

v: string

Returns void

actualCloseLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualCloseLabel(): string

Returns string

actualFocusBrush

Inherited from: IgxFinancialSeriesComponent

Gets the effective emphasis brush for the current series object.

get actualFocusBrush(): string

Returns string

set actualFocusBrush(v: string): void

Parameters

v: string

Returns void

actualFocusMode

Inherited from: IgxFinancialSeriesComponent

Gets actual Selection mode

get actualFocusMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualFocusMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualHighLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualHighLabel(): string

Returns string

actualHighlightedValuesFadeOpacity

Inherited from: IgxFinancialSeriesComponent

Gets actual HighlightedValues fade opacity

get actualHighlightedValuesFadeOpacity(): number

Returns number

set actualHighlightedValuesFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingFadeOpacity

Inherited from: IgxFinancialSeriesComponent

Gets actual highlighting fade opacity

get actualHighlightingFadeOpacity(): number

Returns number

set actualHighlightingFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingMode

Inherited from: IgxFinancialSeriesComponent

Gets actual highlighting mode

get actualHighlightingMode(): SeriesHighlightingMode

Returns SeriesHighlightingMode

set actualHighlightingMode(v: SeriesHighlightingMode): void

Parameters

v: SeriesHighlightingMode

Returns void

actualHitTestMode

Inherited from: IgxFinancialSeriesComponent

Resolved method of hit testing to use when pointing to items in the chart.

let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;

get actualHitTestMode(): SeriesHitTestMode

Returns SeriesHitTestMode

set actualHitTestMode(v: SeriesHitTestMode): void

Parameters

v: SeriesHitTestMode

Returns void

actualLayers

Inherited from: IgxFinancialSeriesComponent

Gets the actual extra layers for the series.

get actualLayers(): IgxSeriesLayerCollection

Returns IgxSeriesLayerCollection

set actualLayers(v: IgxSeriesLayerCollection): void

Parameters

v: IgxSeriesLayerCollection

Returns void

actualLegendItemBadgeBrush

Inherited from: IgxFinancialSeriesComponent

Gets the effective legend badge fill for the current series.

get actualLegendItemBadgeBrush(): string

Returns string

set actualLegendItemBadgeBrush(v: string): void

Parameters

v: string

Returns void

actualLegendItemBadgeOutline

Inherited from: IgxFinancialSeriesComponent

Gets the effective legend badge outline for the current series.

get actualLegendItemBadgeOutline(): string

Returns string

set actualLegendItemBadgeOutline(v: string): void

Parameters

v: string

Returns void

actualLegendItemBadgeTemplate

Inherited from: IgxFinancialSeriesComponent

Gets the actual legend item badge template used by the series.

get actualLegendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set actualLegendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

actualLowLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualLowLabel(): string

Returns string

actualMarkerFillOpacity

Inherited from: IgxFinancialSeriesComponent

Gets the actual opacity applied to the fill of the markers.

get actualMarkerFillOpacity(): number

Returns number

set actualMarkerFillOpacity(v: number): void

Parameters

v: number

Returns void

actualOpenLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualOpenLabel(): string

Returns string

actualOutline

Inherited from: IgxFinancialSeriesComponent

Gets the effective outline for the current series object.

let actualOutline: string = series.ActualOutline;

get actualOutline(): string

Returns string

set actualOutline(v: string): void

Parameters

v: string

Returns void

actualRadiusLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualRadiusLabel(): string

Returns string

actualResolution

Inherited from: IgxFinancialSeriesComponent

get actualResolution(): number

Returns number

set actualResolution(v: number): void

Parameters

v: number

Returns void

actualSelectionBrush

Inherited from: IgxFinancialSeriesComponent

Gets the effective emphasis brush for the current series object.

get actualSelectionBrush(): string

Returns string

set actualSelectionBrush(v: string): void

Parameters

v: string

Returns void

actualSelectionMode

Inherited from: IgxFinancialSeriesComponent

Gets actual Selection mode

get actualSelectionMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualSelectionMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualThickness

Inherited from: IgxFinancialSeriesComponent

Gets the effective Thickness for the current series object.

get actualThickness(): number

Returns number

set actualThickness(v: number): void

Parameters

v: number

Returns void

actualTrendLineBrush

Gets the effective TrendLineBrush for this FinancialPriceSeries.

Use the ActualTrendLineBrush property to Gets the effective TrendLineBrush for the FinancialIndicator.

get actualTrendLineBrush(): string

Returns string

set actualTrendLineBrush(v: string): void

Parameters

v: string

Returns void

actualValueLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgxFinancialSeriesComponent

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

get actualVolumeLabel(): string

Returns string

areaFillOpacity

Inherited from: IgxFinancialSeriesComponent

Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

<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-area-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        areaFillOpacity=.5>
    </igx-area-series>
</igx-data-chart>

get areaFillOpacity(): number

Returns number

set areaFillOpacity(v: number): void

Parameters

v: number

Returns void

assigningCategoryStyle

Inherited from: IgxFinancialSeriesComponent

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>

attachTooltipToRoot

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the tooltip will be attached to the root, when set to false it will be a child of the chart.

get attachTooltipToRoot(): boolean

Returns boolean

set attachTooltipToRoot(v: boolean): void

Parameters

v: boolean

Returns void

autoCalloutLabelFormat

Inherited from: IgxFinancialSeriesComponent

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

get autoCalloutLabelFormat(): string

Returns string

set autoCalloutLabelFormat(v: string): void

Parameters

v: string

Returns void

autoCalloutLabelFormatSpecifiers

Inherited from: IgxFinancialSeriesComponent

Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string.

get autoCalloutLabelFormatSpecifiers(): any[]

Returns any[]

set autoCalloutLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

autoCalloutValueLabelFormat

Inherited from: IgxFinancialSeriesComponent

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

get autoCalloutValueLabelFormat(): string

Returns string

set autoCalloutValueLabelFormat(v: string): void

Parameters

v: string

Returns void

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgxFinancialSeriesComponent

Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string.

get autoCalloutValueLabelFormatSpecifiers(): any[]

Returns any[]

set autoCalloutValueLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

brush

Inherited from: IgxFinancialSeriesComponent

Gets or sets the brush to use for the series.

The Brush along with the Outline and Negative Brush can be used to affect the visuals of the 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-area-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        brush="red">
    </igx-area-series>
</igx-data-chart>

this.series.brush = "red";

get brush(): string

Returns string

set brush(v: string): void

Parameters

v: string

Returns void

categoryCollisionMode

Gets or sets the category collision mode selection behavior to use for the series.

get categoryCollisionMode(): CategoryCollisionMode

Returns CategoryCollisionMode

set categoryCollisionMode(v: CategoryCollisionMode): void

Parameters

v: CategoryCollisionMode

Returns void

closeMemberAsLegendLabel

Gets or sets the label displayed before series' Close value in the Data Legend.

get closeMemberAsLegendLabel(): string

Returns string

set closeMemberAsLegendLabel(v: string): void

Parameters

v: string

Returns void

closeMemberAsLegendUnit

Gets or sets the unit displayed after series' Close value in the Data Legend.

get closeMemberAsLegendUnit(): string

Returns string

set closeMemberAsLegendUnit(v: string): void

Parameters

v: string

Returns void

closeMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the close mapping property for the current series object.

Use CloseMemberPath property for the close mapping of the current series object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get closeMemberPath(): string

Returns string

set closeMemberPath(v: string): void

Parameters

v: string

Returns void

coercionMethods

Inherited from: IgxFinancialSeriesComponent

Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

<igx-data-chart
      [dataSource]="data"
     >
      <igx-category-x-axis
        label="label"
        #xAxis>
      </igx-category-x-axis>
      <igx-numeric-y-axis
        #yAxis>
      </igx-numeric-y-axis>
      <igx-line-series
      [xAxis]="xAxis"
      [yAxis]="yAxis"
      valueMemberPath="value">
     </igx-line-series>
       <igx-line-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        [coercionMethods]= cMethods
        valueMemberPath="value!ValueCoercion">
       </igx-line-series>
    </igx-data-chart>

<-- position: content member-->

cMethods: any = {
    ValueCoercion: function(value:number): number {return value+2;}
 }

get coercionMethods(): any

Returns any

set coercionMethods(v: any): void

Parameters

v: any

Returns void

dashArray

Inherited from: IgxFinancialSeriesComponent

Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

get dashArray(): number[]

Returns number[]

set dashArray(v: number[]): void

Parameters

v: number[]

Returns void

dataLegendGroup

Inherited from: IgxFinancialSeriesComponent

Gets or sets a name used for grouping multiple series in the Data Legend If not set, series will be grouped by series family, e.g. Category, Range, Financial, Scatter

get dataLegendGroup(): string

Returns string

set dataLegendGroup(v: string): void

Parameters

v: string

Returns void

dataLegendKey

Inherited from: IgxFinancialSeriesComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

dataSource

Inherited from: IgxFinancialSeriesComponent

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

discreteLegendItemTemplate

Inherited from: IgxFinancialSeriesComponent

Gets or sets the DiscreteLegendItemTemplate property. The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

get discreteLegendItemTemplate(): IgDataTemplate

Returns IgDataTemplate

set discreteLegendItemTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

displayType

Gets or sets the display type for the current FinancialPriceSeries object.

Use the DisplayType property for the display type of the current FinancialPriceSeries object.

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      displayType="Candlestick">
</igx-financial-price-series>
</igx-data-chart>

series.displayType=PriceDisplayType.Candlestick;

get displayType(): PriceDisplayType

Returns PriceDisplayType

set displayType(v: PriceDisplayType): void

Parameters

v: PriceDisplayType

Returns void

expectFunctions

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

expectFunctions is used to decide whether the series should expect that its data source members need to be called as functions to get their values.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
    label="label"
    #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
    #yAxis>
    </igx-numeric-y-axis>
    <igx-line-series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    expectFunctions=true
    valueMemberPath="MyFunction">
    </igx-line-series>
</igx-data-chart>

this.series.expectFunctions=true;

get expectFunctions(): boolean

Returns boolean

set expectFunctions(v: boolean): void

Parameters

v: boolean

Returns void

finalValue

Inherited from: IgxFinancialSeriesComponent

The final value of this series.

get finalValue(): number

Returns number

set finalValue(v: number): void

Parameters

v: number

Returns void

focusBrush

Inherited from: IgxFinancialSeriesComponent

Gets or sets the Focus brush to use for the series.

get focusBrush(): string

Returns string

set focusBrush(v: string): void

Parameters

v: string

Returns void

hasMarkers

Inherited from: IgxFinancialSeriesComponent

Returns whether the current series supports visual markers.

let hasMarkers: boolean = this.series.hasMarkers;

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgxFinancialSeriesComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgxFinancialSeriesComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

highlightedCloseMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the highlighted Y value mapping property for the current series object.

get highlightedCloseMemberPath(): string

Returns string

set highlightedCloseMemberPath(v: string): void

Parameters

v: string

Returns void

highlightedDataSource

Inherited from: IgxFinancialSeriesComponent

get highlightedDataSource(): any

Returns any

set highlightedDataSource(value: any): void

Parameters

value: any

Returns void

highlightedHighMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the highlighted Y value mapping property for the current series object.

get highlightedHighMemberPath(): string

Returns string

set highlightedHighMemberPath(v: string): void

Parameters

v: string

Returns void

highlightedLegendItemVisibility

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the highlighted values layer should have a legend item.

get highlightedLegendItemVisibility(): Visibility

Returns Visibility

set highlightedLegendItemVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

highlightedLowMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the highlighted X value mapping property for the current series object.

get highlightedLowMemberPath(): string

Returns string

set highlightedLowMemberPath(v: string): void

Parameters

v: string

Returns void

highlightedOpenMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the highlighted X value mapping property for the current series object.

get highlightedOpenMemberPath(): string

Returns string

set highlightedOpenMemberPath(v: string): void

Parameters

v: string

Returns void

highlightedTitleSuffix

Inherited from: IgxFinancialSeriesComponent

Gets or sets the HighlightedTitleSuffix property.

get highlightedTitleSuffix(): string

Returns string

set highlightedTitleSuffix(v: string): void

Parameters

v: string

Returns void

highlightedValuesDataLegendGroup

Inherited from: IgxFinancialSeriesComponent

Gets or sets a name used for grouping highlighted series in the Data Legend If not set, series will default to parent series' DataLegendGroup, e.g. Category, Range, Financial, Scatter

get highlightedValuesDataLegendGroup(): string

Returns string

set highlightedValuesDataLegendGroup(v: string): void

Parameters

v: string

Returns void

highlightedValuesDisplayMode

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

Returns SeriesHighlightedValuesDisplayMode

set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void

Parameters

v: SeriesHighlightedValuesDisplayMode

Returns void

highlightedValuesExtraPropertyOverlays

Inherited from: IgxFinancialSeriesComponent

Gets the current extra layers for the series.

get highlightedValuesExtraPropertyOverlays(): IgxSeriesLayerPropertyOverlayCollection

Returns IgxSeriesLayerPropertyOverlayCollection

set highlightedValuesExtraPropertyOverlays(v: IgxSeriesLayerPropertyOverlayCollection): void

Parameters

v: IgxSeriesLayerPropertyOverlayCollection

Returns void

highlightedValuesFadeOpacity

Inherited from: IgxFinancialSeriesComponent

Gets or sets the target opacity to fade to for fade style HighlightedValues.

get highlightedValuesFadeOpacity(): number

Returns number

set highlightedValuesFadeOpacity(v: number): void

Parameters

v: number

Returns void

highlightedVolumeMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the highlighted Y value mapping property for the current series object.

get highlightedVolumeMemberPath(): string

Returns string

set highlightedVolumeMemberPath(v: string): void

Parameters

v: string

Returns void

highlightingFadeOpacity

Inherited from: IgxFinancialSeriesComponent

Gets or sets the target opacity to fade to for fade style highlighting.

get highlightingFadeOpacity(): number

Returns number

set highlightingFadeOpacity(v: number): void

Parameters

v: number

Returns void

highMemberAsLegendLabel

Gets or sets the label displayed before series' High value in the Data Legend.

get highMemberAsLegendLabel(): string

Returns string

set highMemberAsLegendLabel(v: string): void

Parameters

v: string

Returns void

highMemberAsLegendUnit

Gets or sets the unit displayed after series' High value in the Data Legend.

get highMemberAsLegendUnit(): string

Returns string

set highMemberAsLegendUnit(v: string): void

Parameters

v: string

Returns void

highMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the high mapping property for the current series object.

Use HighMemberPath propert for high mapping of the current series object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get highMemberPath(): string

Returns string

set highMemberPath(v: string): void

Parameters

v: string

Returns void

hitTestMode

Inherited from: IgxFinancialSeriesComponent

Method of hit testing to use when pointing to items in this series.

The HitTestMode can be set to either:

Auto: automatically decide the appropriate hit test mode for the series.
ColorEncoded: use a color encoded off screen buffer for hit testing. Should always be O(1) time for determining a hit series. This increases frame render time and memory usage, however. Consider using this if hit testing time is degrading performance.
Computational: use a computational based approach to determine whether the series has been hit. This uses loose bounding boxes, in some cases, and can range in time complexity between O(1) and O(log n) to find a hit. This decreases frame render time compared to color encoded

this.series.hitTestMode = SeriesHitTestMode.Computational;

get hitTestMode(): SeriesHitTestMode

Returns SeriesHitTestMode

set hitTestMode(v: SeriesHitTestMode): void

Parameters

v: SeriesHitTestMode

Returns void

index

Inherited from: IgxFinancialSeriesComponent

Gets the Index property.

get index(): number

Returns number

set index(v: number): void

Parameters

v: number

Returns void

isActualLegendFinancial

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

get isActualLegendFinancial(): boolean

Returns boolean

set isActualLegendFinancial(v: boolean): void

Parameters

v: boolean

Returns void

isAnnotationCalloutLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgxFinancialSeriesComponent

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

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is an annotation layer.

let isAnnotationLayer: boolean = this.series.isAnnotationLayer;

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgxFinancialSeriesComponent

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

let isAreaorLine: boolean = this.series.isAreaorLine;

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a category type series.

let isCategory: boolean = this.series.isCategory;

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgxFinancialSeriesComponent

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isComponentHighlightingModeIgnored

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the component level highlight mode is ignored.

get isComponentHighlightingModeIgnored(): boolean

Returns boolean

set isComponentHighlightingModeIgnored(v: boolean): void

Parameters

v: boolean

Returns void

isCustomCategoryStyleAllowed

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether this category series should allow custom style overrides of its individual visuals.

The IsCustomCategoryStyleAllowed property is used to check if the category series should allow custom style.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
	  isCustomCategoryStyleAllowed="True" />
</igx-financial-price-series>
</igx-data-chart>

series.isCustomCategoryStyleAllowed= true;

get isCustomCategoryStyleAllowed(): boolean

Returns boolean

set isCustomCategoryStyleAllowed(v: boolean): void

Parameters

v: boolean

Returns void

isDefaultCrosshairBehaviorDisabled

Inherited from: IgxFinancialSeriesComponent

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

isDefaultTooltipBehaviorDisabled

Inherited from: IgxFinancialSeriesComponent

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

isDefaultToolTipSelected

Inherited from: IgxFinancialSeriesComponent

Gets if the default tooltip has been selected for display.

To use the default tooltip set ShowDefaultTooltip to true.

let isDefaultToolTipSelected: boolean = this.series.isDefaultToolTipSelected;

get isDefaultToolTipSelected(): boolean

Returns boolean

set isDefaultToolTipSelected(v: boolean): void

Parameters

v: boolean

Returns void

isDropShadowEnabled

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether drop shadow should be enabled for this series.

IsDropShadowEnabled is used to decide whether drop shadow should be enabled for this series.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-line-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled=true>
    </igx-line-series>
    </igx-data-chart>

this.series.isDropShadowEnabled = true;

get isDropShadowEnabled(): boolean

Returns boolean

set isDropShadowEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isFinancial

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a stack fragment.

let isFragment: boolean = this.series.isFragment;

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a geographic series.

let isGeographic: boolean = this.series.isGeographic;

get isGeographic(): boolean

Returns boolean

isHighlightingEnabled

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

<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-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isHighlightEnabled="true">
    </igx-column-series>
</igx-data-chart>

this.series.isHighlightingEnabled = true;

get isHighlightingEnabled(): boolean

Returns boolean

set isHighlightingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isHighlightOverlay

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgxFinancialSeriesComponent

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

isLayer

Inherited from: IgxFinancialSeriesComponent

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgxFinancialSeriesComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgxFinancialSeriesComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a polar type series.

let isPolar: boolean = this.series.isPolar;

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a radial type series.

let isRadial: boolean = this.series.isRadial;

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a range type series.

let isRange: boolean = this.series.isRange;

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a scatter type series.

let isScatter: boolean = this.series.isScatter;

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is a stacked type series.

let isStacked: boolean = this.series.isStacked;

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgxFinancialSeriesComponent

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isTransitionInEnabled

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series.

The IsTransitionInEnabled property is used to check if the series should transition into the plot area when a new data source is assigned.

series.isTransitionInEnabled= true;

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
	  isTransitionInEnabled= "true">
</igx-financial-price-series>
</igx-data-chart>

get isTransitionInEnabled(): boolean

Returns boolean

set isTransitionInEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isUsableInLegend

Inherited from: IgxFinancialSeriesComponent

Gets if the series should appear in any legends.

let isUsableInLegend: boolean = this.series.isUsableInLegend;

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgxFinancialSeriesComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series is oriented vertically.

let isVertical: boolean = this.series.isVertical;

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgxFinancialSeriesComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

layers

Inherited from: IgxFinancialSeriesComponent

Gets the current extra layers for the series.

get layers(): IgxSeriesLayerCollection

Returns IgxSeriesLayerCollection

set layers(v: IgxSeriesLayerCollection): void

Parameters

v: IgxSeriesLayerCollection

Returns void

legend

Inherited from: IgxFinancialSeriesComponent

Gets or sets the legend used for the current series.

get legend(): any

Returns any

set legend(v: any): void

Parameters

v: any

Returns void

legendItemBadgeMode

Inherited from: IgxFinancialSeriesComponent

Gets or sets the mode of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

get legendItemBadgeMode(): LegendItemBadgeMode

Returns LegendItemBadgeMode

set legendItemBadgeMode(v: LegendItemBadgeMode): void

Parameters

v: LegendItemBadgeMode

Returns void

legendItemBadgeShape

Inherited from: IgxFinancialSeriesComponent

Gets or sets the type of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

get legendItemBadgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape

set legendItemBadgeShape(v: LegendItemBadgeShape): void

Parameters

v: LegendItemBadgeShape

Returns void

legendItemBadgeTemplate

Inherited from: IgxFinancialSeriesComponent

Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

get legendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendItemTemplate

Inherited from: IgxFinancialSeriesComponent

Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

get legendItemTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendItemVisibility

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether or not the current series will have a legend item displayed in a legend.

The LegendItemVisibilty can be used to exclude only certain Series from the Legend.

get legendItemVisibility(): Visibility

Returns Visibility

set legendItemVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

lineCap

Inherited from: IgxFinancialSeriesComponent

Gets or sets the style of the starting point of any lines or polylines representing this series. Not every series type has a line at which it would be appropriate to display a start cap, so this property does not affect every series type. LineSeries, for example, is affected by StartCap, but ColumnSeries is not.

get lineCap(): PenLineCap

Returns PenLineCap

set lineCap(v: PenLineCap): void

Parameters

v: PenLineCap

Returns void

lineJoin

Inherited from: IgxFinancialSeriesComponent

Gets or sets the brush that specifies current series object's line join style.

get lineJoin(): PenLineJoin

Returns PenLineJoin

set lineJoin(v: PenLineJoin): void

Parameters

v: PenLineJoin

Returns void

lowMemberAsLegendLabel

Gets or sets the label displayed before series' Low value in the Data Legend.

get lowMemberAsLegendLabel(): string

Returns string

set lowMemberAsLegendLabel(v: string): void

Parameters

v: string

Returns void

lowMemberAsLegendUnit

Gets or sets the unit displayed after series' Low value in the Data Legend.

get lowMemberAsLegendUnit(): string

Returns string

set lowMemberAsLegendUnit(v: string): void

Parameters

v: string

Returns void

lowMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the low mapping property for the current series object.

The LowMemberPath is used for low mapping property of the current series object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get lowMemberPath(): string

Returns string

set lowMemberPath(v: string): void

Parameters

v: string

Returns void

markerFillOpacity

Inherited from: IgxFinancialSeriesComponent

Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

get markerFillOpacity(): number

Returns number

set markerFillOpacity(v: number): void

Parameters

v: number

Returns void

mouseOverEnabled

Inherited from: IgxFinancialSeriesComponent

Gets or sets the whether the chart reacts to mouse move events.

get mouseOverEnabled(): boolean

Returns boolean

set mouseOverEnabled(v: boolean): void

Parameters

v: boolean

Returns void

name

Inherited from: IgxFinancialSeriesComponent

get name(): string

Returns string

set name(value: string): void

Parameters

value: string

Returns void

negativeBrush

Inherited from: IgxFinancialSeriesComponent

Gets or sets the brush to use for negative portions of the series.

The NegativeBrush property is used to brush the negative portions of the series.

series.negativeBrush="red";

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
	  negativeBrush="red">
</igx-financial-price-series>
</igx-data-chart>

get negativeBrush(): string

Returns string

set negativeBrush(v: string): void

Parameters

v: string

Returns void

negativeOutline

Brush to use for outlining negative elements in the series.

Use the NegativeOutline property to brush the outline negative elements in the series.

series.negativeOutline="red";

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      negativeOutline="Red" >
</igx-financial-price-series>
</igx-data-chart>

get negativeOutline(): string

Returns string

set negativeOutline(v: string): void

Parameters

v: string

Returns void

opacity

Inherited from: IgxFinancialSeriesComponent

get opacity(): number

Returns number

set opacity(v: number): void

Parameters

v: number

Returns void

openMemberAsLegendLabel

Gets or sets the label displayed before series' Open value in the Data Legend.

get openMemberAsLegendLabel(): string

Returns string

set openMemberAsLegendLabel(v: string): void

Parameters

v: string

Returns void

openMemberAsLegendUnit

Gets or sets the unit displayed after series' Open value in the Data Legend.

get openMemberAsLegendUnit(): string

Returns string

set openMemberAsLegendUnit(v: string): void

Parameters

v: string

Returns void

openMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the open mapping property for the current series object.

The OpenMemberPath property is used for open mapping of the current series object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get openMemberPath(): string

Returns string

set openMemberPath(v: string): void

Parameters

v: string

Returns void

outline

Inherited from: IgxFinancialSeriesComponent

Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

The Outline along with the Brush and NegativeBrush can be used to affect the visuals of the 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-area-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        outline="red">
    </igx-area-series>
</igx-data-chart>

this.series.brush = "red";

get outline(): string

Returns string

set outline(v: string): void

Parameters

v: string

Returns void

outlineMode

Inherited from: IgxFinancialSeriesComponent

Gets or sets the outline mode to use for the series.

get outlineMode(): SeriesOutlineMode

Returns SeriesOutlineMode

set outlineMode(v: SeriesOutlineMode): void

Parameters

v: SeriesOutlineMode

Returns void

percentChange

Inherited from: IgxFinancialSeriesComponent

The percent change from the beginning to the end of this series.

get percentChange(): number

Returns number

set percentChange(v: number): void

Parameters

v: number

Returns void

renderRequested

Inherited from: IgxFinancialSeriesComponent

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

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

resolution

Inherited from: IgxFinancialSeriesComponent

Gets or sets the current series object's rendering resolution.

Setting the Resolution on a Series to a higher value can help with performance, but it will lower the graphical fidelity of the line. As such, it can be increased up until the fidelity is unacceptable.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-line-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        resolution=1.5>
    </igx-line-series>
</igx-data-chart>

this.series.resolution = 1.5;

get resolution(): number

Returns number

set resolution(v: number): void

Parameters

v: number

Returns void

safeActualBrush

Inherited from: IgxFinancialSeriesComponent

Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

get safeActualBrush(): string

Returns string

set safeActualBrush(v: string): void

Parameters

v: string

Returns void

selectionBrush

Inherited from: IgxFinancialSeriesComponent

Gets or sets the selection brush to use for the series.

get selectionBrush(): string

Returns string

set selectionBrush(v: string): void

Parameters

v: string

Returns void

selectionThickness

Inherited from: IgxFinancialSeriesComponent

Gets or sets the width of the current series object's line thickness when the series is selected.

get selectionThickness(): number

Returns number

set selectionThickness(v: number): void

Parameters

v: number

Returns void

seriesInternal

Inherited from: IgxFinancialSeriesComponent

get seriesInternal(): any

Returns any

shadowBlur

Inherited from: IgxFinancialSeriesComponent

Gets or sets the shadow blur. This property is ignored when Series.UseSingleShadow is set to true.

ShadowBlur can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled="true"
        shadowBlur="7"
        shadowColor="blue">
    </igx-column-series>
</igx-data-chart>

this.series.shadowBlur = 7;

get shadowBlur(): number

Returns number

set shadowBlur(v: number): void

Parameters

v: number

Returns void

shadowColor

Inherited from: IgxFinancialSeriesComponent

Gets or sets the drop shadow color.

ShadowColor can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled="true"
        shadowBlur="7"
        shadowColor="blue">
    </igx-column-series>
</igx-data-chart>

this.series.shadowColor = "blue";

get shadowColor(): string

Returns string

set shadowColor(v: string): void

Parameters

v: string

Returns void

shadowOffsetX

Inherited from: IgxFinancialSeriesComponent

Gets or sets the drop shadow x-offset.

ShadowOffsetX can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled="true"
        shadowOffsetX="10"
        shadowOffsetY="10">
    </igx-column-series>
</igx-data-chart>

this.series.shadowOffsetX = 10;

get shadowOffsetX(): number

Returns number

set shadowOffsetX(v: number): void

Parameters

v: number

Returns void

shadowOffsetY

Inherited from: IgxFinancialSeriesComponent

Gets or sets the drop shadow y-offset.

ShadowOffsetY can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled="true"
        shadowOffsetX="10"
        shadowOffsetY="10">
    </igx-column-series>
</igx-data-chart>

this.series.shadowOffsetY = 10;

get shadowOffsetY(): number

Returns number

set shadowOffsetY(v: number): void

Parameters

v: number

Returns void

shouldAnimateOnDataSourceSwap

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

get shouldAnimateOnDataSourceSwap(): boolean

Returns boolean

set shouldAnimateOnDataSourceSwap(v: boolean): void

Parameters

v: boolean

Returns void

shouldHideAutoCallouts

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether this series should suppress it's auto callouts

get shouldHideAutoCallouts(): boolean

Returns boolean

set shouldHideAutoCallouts(v: boolean): void

Parameters

v: boolean

Returns void

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

get shouldRemoveHighlightedDataOnLayerHidden(): boolean

Returns boolean

set shouldRemoveHighlightedDataOnLayerHidden(v: boolean): void

Parameters

v: boolean

Returns void

shouldShiftOpacityForSafeActualBrush

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

get shouldShiftOpacityForSafeActualBrush(): boolean

Returns boolean

set shouldShiftOpacityForSafeActualBrush(v: boolean): void

Parameters

v: boolean

Returns void

showDefaultTooltip

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether default tooltip will be shown.

The default tooltips display all the information relevant to the particular series item (series title, data values, axis values etc.) and are styled to match the series' style. When using default tooltips, you should also set the series Title.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        showDefaultTooltip="true"
        title="InStock Items">
    </igx-column-series>
</igx-data-chart>

this.series.showDefaultTooltip ="true";

get showDefaultTooltip(): boolean

Returns boolean

set showDefaultTooltip(v: boolean): void

Parameters

v: boolean

Returns void

thickness

Inherited from: IgxFinancialSeriesComponent

Gets or sets the width of the current series object's line thickness.

Depending on the Series type, this can be the main brush used, or just the outline. For example, when using a LineSeries it will affect the thickness of the lines drawn, whereas when using a ColumnSeries it will affect the outer border thickness of the columns.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-line-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        thickness=5>
    </igx-line-series>
</igx-data-chart>

this.series.thickness=5;

get thickness(): number

Returns number

set thickness(v: number): void

Parameters

v: number

Returns void

title

Inherited from: IgxFinancialSeriesComponent

Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

The Series Title may be used in tooltips and legends.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        showDefaultTooltip="true"
        title="InStock Items">
    </igx-column-series>
</igx-data-chart>

this.series.title = "InStock Items";

get title(): any

Returns any

set title(v: any): void

Parameters

v: any

Returns void

tooltipContainerTemplate

Inherited from: IgxFinancialSeriesComponent

get tooltipContainerTemplate(): TemplateRef<any>

Returns TemplateRef<any>

set tooltipContainerTemplate(value: TemplateRef<any>): void

Parameters

value: TemplateRef<any>

Returns void

tooltipTemplate

Inherited from: IgxFinancialSeriesComponent

get tooltipTemplate(): TemplateRef<any>

Returns TemplateRef<any>

set tooltipTemplate(value: TemplateRef<any>): void

Parameters

value: TemplateRef<any>

Returns void

transitionDuration

Inherited from: IgxFinancialSeriesComponent

Gets or sets the duration of the current series' morph.

The TransitionDuration can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

<igx-data-chart
    [dataSource]="data"
    animateSeriesWhenAxisRangeChanges=true>
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        transitionInMode="accordionFromBottom"
        isTransitionInEnabled=true
        transitionInSpeedType="indexScaled"
        transitionDuration=500
        transitionInDuration=500>
    </igx-column-series>
</igx-data-chart>

this.series.transitionDuration = 500;

get transitionDuration(): number

Returns number

set transitionDuration(v: number): void

Parameters

v: number

Returns void

transitionEasingFunction

Inherited from: IgxFinancialSeriesComponent

Gets or sets the easing function used to morph the current series.

The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

this.series.transitionEasingFunction =  EasingFunctions.cubicEase;

get transitionEasingFunction(): object

Returns object

set transitionEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionInDuration

Inherited from: IgxFinancialSeriesComponent

Gets or sets the duration of the current series' transition in morph.

The TransitionInDuration can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        transitionInMode="accordionFromBottom"
        isTransitionInEnabled=true
        transitionInSpeedType="indexScaled"
        transitionDuration=500
        transitionInDuration=500>
    </igx-column-series>
</igx-data-chart>

this.series.transitionDuration = 500;

get transitionInDuration(): number

Returns number

set transitionInDuration(v: number): void

Parameters

v: number

Returns void

transitionInEasingFunction

Inherited from: IgxFinancialSeriesComponent

Gets or sets the EasingFunction used to morph the current series during the initial transition.

The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

this.series.transitionInEasingFunction =  EasingFunctions.cubicEase;

get transitionInEasingFunction(): object

Returns object

set transitionInEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionInMode

Inherited from: IgxFinancialSeriesComponent

Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series.

The TransitionInMode property is used to gets or sets the method by which to animate the data into the chart when the chart data source is swapped.

series.transitionInMode =CategoryTransitionInMode.Auto;

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
	  transitionInMode= "Auto">
</igx-financial-price-series>
</igx-data-chart>

get transitionInMode(): CategoryTransitionInMode

Returns CategoryTransitionInMode

set transitionInMode(v: CategoryTransitionInMode): void

Parameters

v: CategoryTransitionInMode

Returns void

transitionInSpeedType

Inherited from: IgxFinancialSeriesComponent

Gets or sets the duration of the current series' transition in morph.

The TransitionInSpeedType can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        transitionInMode="accordionFromBottom"
        isTransitionInEnabled=true
        transitionInSpeedType="indexScaled"
        transitionInDuration=500>
    </igx-column-series>
</igx-data-chart>

this.series.transitionInSpeedType = TransitionInSpeedType.IndexScaled;

get transitionInSpeedType(): TransitionInSpeedType

Returns TransitionInSpeedType

set transitionInSpeedType(v: TransitionInSpeedType): void

Parameters

v: TransitionInSpeedType

Returns void

transitionOutCompleted

Inherited from: IgxFinancialSeriesComponent

Fired when a transition out has completed.

get transitionOutCompleted(): EventEmitter<object>

Returns EventEmitter<object>

transitionOutDuration

Inherited from: IgxFinancialSeriesComponent

Gets or sets the duration of the current series' transition out morph.

get transitionOutDuration(): number

Returns number

set transitionOutDuration(v: number): void

Parameters

v: number

Returns void

transitionOutEasingFunction

Inherited from: IgxFinancialSeriesComponent

Gets or sets the EasingFunction used to morph the current series during the initial transition.

get transitionOutEasingFunction(): object

Returns object

set transitionOutEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionOutSpeedType

Inherited from: IgxFinancialSeriesComponent

Gets or sets the duration of the current series' transition out morph.

get transitionOutSpeedType(): TransitionOutSpeedType

Returns TransitionOutSpeedType

set transitionOutSpeedType(v: TransitionOutSpeedType): void

Parameters

v: TransitionOutSpeedType

Returns void

trendLineBrush

Gets or sets the brush to use to draw the trend line.

Use the TrendLineBrush property to brush the the trend line.

series.trendLineBrush="red";

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
     trendLineBrush="red" >
</igx-financial-price-series>
</igx-data-chart>

get trendLineBrush(): string

Returns string

set trendLineBrush(v: string): void

Parameters

v: string

Returns void

trendLineDashArray

Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current FinancialPriceSeries object.

get trendLineDashArray(): number[]

Returns number[]

set trendLineDashArray(v: number[]): void

Parameters

v: number[]

Returns void

trendLinePeriod

Gets or sets the trend line period for the current series. The typical, and initial, value for trend line period is 7.

Use the TrendLinePeriod property for the periodo the the current series.

series.trendLinePeriod= 7;

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      trendLinePeriod="7">
</igx-financial-price-series>
</igx-data-chart>

get trendLinePeriod(): number

Returns number

set trendLinePeriod(v: number): void

Parameters

v: number

Returns void

trendLineThickness

Gets or sets the thickness of the current FinancialPriceSeries object's trend line.

Use the TrendLineThickness property for the thickness of the current FinancialPriceSeries object's trend line.

series.trendLineThickness=5;

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      trendLineThickness="3">
</igx-financial-price-series>
</igx-data-chart>

get trendLineThickness(): number

Returns number

set trendLineThickness(v: number): void

Parameters

v: number

Returns void

trendLineType

Gets or sets the trend type for the current financial series.

Use the TrendLineType property for the trend type of the current financial series.

series.trendLineType= "CubicFit";

<igx-data-chart
    #chart
        [dataSource]="data" >
 <igx-ordinal-time-x-axis
    dateTimeMemberPath="TimeStamp"
    #xAxis >
    </igx-ordinal-time-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume"
      trendLineType="CubicFit">
</igx-financial-price-series>
</igx-data-chart>

get trendLineType(): TrendLineType

Returns TrendLineType

set trendLineType(v: TrendLineType): void

Parameters

v: TrendLineType

Returns void

typical

Inherited from: IgxFinancialSeriesComponent

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>

typicalBasedOn

Inherited from: IgxFinancialSeriesComponent

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>

useItemWiseColors

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether the series should use individual palette colors for each item.

get useItemWiseColors(): boolean

Returns boolean

set useItemWiseColors(v: boolean): void

Parameters

v: boolean

Returns void

useSingleShadow

Inherited from: IgxFinancialSeriesComponent

Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. When this property is set to true, no Series.ShadowBlur is applied.

<igx-data-chart
    [dataSource]="data">
    <igx-category-x-axis
        label="label"
        #xAxis>
    </igx-category-x-axis>
    <igx-numeric-y-axis
        #yAxis>
    </igx-numeric-y-axis>
    <igx-line-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value"
        isDropShadowEnabled=true
        markerType="circle"
        useSingleShadow=true>
    </igx-line-series>
</igx-data-chart>

this.series.useSingleShadow = true;

get useSingleShadow(): boolean

Returns boolean

set useSingleShadow(v: boolean): void

Parameters

v: boolean

Returns void

visibility

Inherited from: IgxFinancialSeriesComponent

get visibility(): Visibility

Returns Visibility

set visibility(v: Visibility): void

Parameters

v: Visibility

Returns void

visibleRangeMarginBottom

Inherited from: IgxFinancialSeriesComponent

Gets or sets the bottom margin to use when getting a visible axis range for the series.

get visibleRangeMarginBottom(): number

Returns number

set visibleRangeMarginBottom(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginLeft

Inherited from: IgxFinancialSeriesComponent

Gets or sets the left margin to use when getting a visible axis range for the series.

get visibleRangeMarginLeft(): number

Returns number

set visibleRangeMarginLeft(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginRight

Inherited from: IgxFinancialSeriesComponent

Gets or sets the right margin to use when getting a visible axis range for the series.

get visibleRangeMarginRight(): number

Returns number

set visibleRangeMarginRight(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginTop

Inherited from: IgxFinancialSeriesComponent

Gets or sets the top margin to use when getting a visible axis range for the series.

get visibleRangeMarginTop(): number

Returns number

set visibleRangeMarginTop(v: number): void

Parameters

v: number

Returns void

visibleRangeMode

Inherited from: IgxFinancialSeriesComponent

Gets or sets the visible range mode to use.

get visibleRangeMode(): SeriesVisibleRangeMode

Returns SeriesVisibleRangeMode

set visibleRangeMode(v: SeriesVisibleRangeMode): void

Parameters

v: SeriesVisibleRangeMode

Returns void

volumeMemberPath

Inherited from: IgxFinancialSeriesComponent

Gets or sets the volume mapping property for the current series object.

The VolumeMemberPath property is used for the volume mapping property of the current series object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get volumeMemberPath(): string

Returns string

set volumeMemberPath(v: string): void

Parameters

v: string

Returns void

xAxis

Inherited from: IgxFinancialSeriesComponent

Gets or sets the effective x-axis for the current FinancialSeries object.

Use XAxis property to set effective x-axis for the current FinancialSeries object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get xAxis(): IgxCategoryAxisBaseComponent

Returns IgxCategoryAxisBaseComponent

set xAxis(v: IgxCategoryAxisBaseComponent): void

Parameters

v: IgxCategoryAxisBaseComponent

Returns void

yAxis

Inherited from: IgxFinancialSeriesComponent

Gets or sets the effective y-axis for the current FinancialSeries object.

Use YAxis property to set the effective y-axis for the current FinancialSeries object.

<igx-data-chart
    #chart
        [dataSource]="data" >
  <igx-category-x-axis
        label="label"
        #xAxis>
        </igx-category-x-axis>
 <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
</igx-numeric-y-axis>
<igx-financial-price-series
    [xAxis]="xAxis"
      [yAxis]="yAxis"
      openMemberPath="open"
      highMemberPath="high"
      lowMemberPath="low"
      closeMemberPath="close"
      volumeMemberPath="volume">
</igx-financial-price-series>
</igx-data-chart>

let series = new IgxFinancialPriceSeriesComponent();
series.xAxis = this.xAxis;
series.yAxis = this.yAxis;
series.openMemberPath = "open";
series.highMemberPath = "high";
series.lowMemberPath = "low";
series.closeMemberPath = "close";
series.volumeMemberPath="volume";
this.chart.series.add(series);

get yAxis(): IgxNumericYAxisComponent

Returns IgxNumericYAxisComponent

set yAxis(v: IgxNumericYAxisComponent): void

Parameters

v: IgxNumericYAxisComponent

Returns void

Methods

bindAxes

Inherited from: IgxFinancialSeriesComponent

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

bindSeries

Inherited from: IgxFinancialSeriesComponent

bindSeries(series: IgxSeriesComponent[]): void

Parameters

series: IgxSeriesComponent[]

Returns void

canUseAsXAxis

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

findByName

Inherited from: IgxFinancialSeriesComponent

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgxFinancialSeriesComponent

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

getCategoryWidth

Inherited from: IgxFinancialSeriesComponent

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

getEffectiveViewport

Inherited from: IgxFinancialSeriesComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

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.

The GetItemSpan method is used 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

Inherited from: IgxFinancialSeriesComponent

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgxFinancialSeriesComponent

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getOffsetValue

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesCloseValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesCloseValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesHighValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesOpenValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesOpenValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

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
The GetSeriesValueBoundingBox method return the best available value bounding box within the series that has the best value match for the world position provided.

Returns IgRect

getSeriesValueFromSeriesPixel

Inherited from: IgxFinancialSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgxFinancialSeriesComponent

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

getSeriesValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgxFinancialSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Gets a numeric value from the numeric axis associated with this series that matches the desired value mode.

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

Parameters

mode: string | ValueLayerValueMode
- The type of value desired from the series numeric axis.

Returns number[]

getSeriesValueTypePosition

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getSeriesVolumeValue

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesVolumeValuePosition

Inherited from: IgxFinancialSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getUnscaledPosition

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgxFinancialSeriesComponent

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgxFinancialSeriesComponent

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

ngOnInit

Inherited from: IgxFinancialSeriesComponent

ngOnInit(): void

Returns void

notifyIndexedPropertiesChanged

Inherited from: IgxFinancialSeriesComponent

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgxFinancialSeriesComponent

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgxFinancialSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgxFinancialSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgxFinancialSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgxFinancialSeriesComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgxFinancialSeriesComponent

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgxFinancialSeriesComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Inherited from: IgxFinancialSeriesComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Inherited from: IgxFinancialSeriesComponent

Replays the assigned transition in animation, if any.

this.series.replayTransitionIn();

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgxFinancialSeriesComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Scrolls the series to display the item for the specified data item. The categorySeries 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.
The ScrollIntoView methos scrolls the series to display the item for the specified data item.

Returns boolean

setNegativeColors

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

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

Inherited from: IgxFinancialSeriesComponent

_createFromInternal(internal: any): IgxSeriesComponent

Parameters

internal: any

Returns IgxSeriesComponent

register

register(): void