IgxSeriesComponent

Represents the base class for all IgxDataChartComponent series.

Constructors

new IgxSeriesComponent(): IgxSeriesComponent

Returns IgxSeriesComponent

Properties

ngAcceptInputType_actualAreaFillOpacity

ngAcceptInputType_actualAreaFillOpacity: string | number

ngAcceptInputType_actualFocusMode

ngAcceptInputType_actualFocusMode: string | SeriesSelectionMode

ngAcceptInputType_actualHighlightedValuesFadeOpacity

ngAcceptInputType_actualHighlightedValuesFadeOpacity: string | number

ngAcceptInputType_actualHighlightingFadeOpacity

ngAcceptInputType_actualHighlightingFadeOpacity: string | number

ngAcceptInputType_actualHighlightingMode

ngAcceptInputType_actualHighlightingMode: string | SeriesHighlightingMode

ngAcceptInputType_actualHitTestMode

ngAcceptInputType_actualHitTestMode: string | SeriesHitTestMode

ngAcceptInputType_actualLayers

ngAcceptInputType_actualLayers: string | IgxSeriesLayerCollection

ngAcceptInputType_actualMarkerFillOpacity

ngAcceptInputType_actualMarkerFillOpacity: string | number

ngAcceptInputType_actualResolution

ngAcceptInputType_actualResolution: string | number

ngAcceptInputType_actualSelectionMode

ngAcceptInputType_actualSelectionMode: string | SeriesSelectionMode

ngAcceptInputType_actualThickness

ngAcceptInputType_actualThickness: string | number

ngAcceptInputType_areaFillOpacity

ngAcceptInputType_areaFillOpacity: string | number

ngAcceptInputType_attachTooltipToRoot

ngAcceptInputType_attachTooltipToRoot: string | boolean

ngAcceptInputType_autoCalloutLabelFormatSpecifiers

ngAcceptInputType_autoCalloutLabelFormatSpecifiers: string | any[]

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers: string | any[]

ngAcceptInputType_dashArray

ngAcceptInputType_dashArray: string | number[]

ngAcceptInputType_expectFunctions

ngAcceptInputType_expectFunctions: string | boolean

ngAcceptInputType_finalValue

ngAcceptInputType_finalValue: string | number

ngAcceptInputType_hasMarkers

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_hasOnlyMarkers

ngAcceptInputType_hasOnlyMarkers: string | boolean

ngAcceptInputType_hasValueAxis

ngAcceptInputType_hasValueAxis: string | boolean

ngAcceptInputType_hasVisibleMarkers

ngAcceptInputType_hasVisibleMarkers: string | boolean

ngAcceptInputType_highlightedLegendItemVisibility

ngAcceptInputType_highlightedLegendItemVisibility: any

ngAcceptInputType_highlightedValuesDisplayMode

ngAcceptInputType_highlightedValuesDisplayMode: any

ngAcceptInputType_highlightedValuesExtraPropertyOverlays

ngAcceptInputType_highlightedValuesExtraPropertyOverlays: string | IgxSeriesLayerPropertyOverlayCollection

ngAcceptInputType_highlightedValuesFadeOpacity

ngAcceptInputType_highlightedValuesFadeOpacity: string | number

ngAcceptInputType_highlightingFadeOpacity

ngAcceptInputType_highlightingFadeOpacity: string | number

ngAcceptInputType_hitTestMode

ngAcceptInputType_hitTestMode: string | SeriesHitTestMode

ngAcceptInputType_index

ngAcceptInputType_index: string | number

ngAcceptInputType_isActualLegendFinancial

ngAcceptInputType_isActualLegendFinancial: string | boolean

ngAcceptInputType_isAnnotationCalloutLayer

ngAcceptInputType_isAnnotationCalloutLayer: string | boolean

ngAcceptInputType_isAnnotationCrosshairLayer

ngAcceptInputType_isAnnotationCrosshairLayer: string | boolean

ngAcceptInputType_isAnnotationDataLayer

ngAcceptInputType_isAnnotationDataLayer: string | boolean

ngAcceptInputType_isAnnotationFinalValue

ngAcceptInputType_isAnnotationFinalValue: string | boolean

ngAcceptInputType_isAnnotationHoverLayer

ngAcceptInputType_isAnnotationHoverLayer: string | boolean

ngAcceptInputType_isAnnotationLayer

ngAcceptInputType_isAnnotationLayer: string | boolean

ngAcceptInputType_isAnnotationValueLayer

ngAcceptInputType_isAnnotationValueLayer: string | boolean

ngAcceptInputType_isArea

ngAcceptInputType_isArea: string | boolean

ngAcceptInputType_isAreaOrLine

ngAcceptInputType_isAreaOrLine: string | boolean

ngAcceptInputType_isBar

ngAcceptInputType_isBar: string | boolean

ngAcceptInputType_isCategory

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isColoredItemwise

ngAcceptInputType_isColoredItemwise: string | boolean

ngAcceptInputType_isColumn

ngAcceptInputType_isColumn: string | boolean

ngAcceptInputType_isComponentHighlightingModeIgnored

ngAcceptInputType_isComponentHighlightingModeIgnored: string | boolean

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultTooltipBehaviorDisabled

ngAcceptInputType_isDefaultTooltipBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultToolTipSelected

ngAcceptInputType_isDefaultToolTipSelected: string | boolean

ngAcceptInputType_isDropShadowEnabled

ngAcceptInputType_isDropShadowEnabled: string | boolean

ngAcceptInputType_isFinancial

ngAcceptInputType_isFinancial: string | boolean

ngAcceptInputType_isFinancialIndicator

ngAcceptInputType_isFinancialIndicator: string | boolean

ngAcceptInputType_isFinancialOverlay

ngAcceptInputType_isFinancialOverlay: string | boolean

ngAcceptInputType_isFinancialSeries

ngAcceptInputType_isFinancialSeries: string | boolean

ngAcceptInputType_isFinancialWaterfall

ngAcceptInputType_isFinancialWaterfall: string | boolean

ngAcceptInputType_isFragment

ngAcceptInputType_isFragment: string | boolean

ngAcceptInputType_isGeographic

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_isHighlightingEnabled

ngAcceptInputType_isHighlightingEnabled: string | boolean

ngAcceptInputType_isHighlightOverlay

ngAcceptInputType_isHighlightOverlay: string | boolean

ngAcceptInputType_isIndexed

ngAcceptInputType_isIndexed: string | boolean

ngAcceptInputType_isLayer

ngAcceptInputType_isLayer: string | boolean

ngAcceptInputType_isLineContour

ngAcceptInputType_isLineContour: string | boolean

ngAcceptInputType_isLineOnly

ngAcceptInputType_isLineOnly: string | boolean

ngAcceptInputType_isMarkerlessDisplayPreferred

ngAcceptInputType_isMarkerlessDisplayPreferred: string | boolean

ngAcceptInputType_isNegativeColorSupported

ngAcceptInputType_isNegativeColorSupported: string | boolean

ngAcceptInputType_isPie

ngAcceptInputType_isPie: string | boolean

ngAcceptInputType_isPixel

ngAcceptInputType_isPixel: string | boolean

ngAcceptInputType_isPolar

ngAcceptInputType_isPolar: string | boolean

ngAcceptInputType_isPolygon

ngAcceptInputType_isPolygon: string | boolean

ngAcceptInputType_isPolyline

ngAcceptInputType_isPolyline: string | boolean

ngAcceptInputType_isRadial

ngAcceptInputType_isRadial: string | boolean

ngAcceptInputType_isRange

ngAcceptInputType_isRange: string | boolean

ngAcceptInputType_isScatter

ngAcceptInputType_isScatter: string | boolean

ngAcceptInputType_isShape

ngAcceptInputType_isShape: string | boolean

ngAcceptInputType_isShapeControl

ngAcceptInputType_isShapeControl: string | boolean

ngAcceptInputType_isSpline

ngAcceptInputType_isSpline: string | boolean

ngAcceptInputType_isStacked

ngAcceptInputType_isStacked: string | boolean

ngAcceptInputType_isStep

ngAcceptInputType_isStep: string | boolean

ngAcceptInputType_isSummarizationSupported

ngAcceptInputType_isSummarizationSupported: string | boolean

ngAcceptInputType_isTile

ngAcceptInputType_isTile: string | boolean

ngAcceptInputType_isToolTipLayer

ngAcceptInputType_isToolTipLayer: string | boolean

ngAcceptInputType_isUsableInLegend

ngAcceptInputType_isUsableInLegend: string | boolean

ngAcceptInputType_isUserAnnotationLayer

ngAcceptInputType_isUserAnnotationLayer: string | boolean

ngAcceptInputType_isUserAnnotationToolTipLayer

ngAcceptInputType_isUserAnnotationToolTipLayer: string | boolean

ngAcceptInputType_isValueAxisInverted

ngAcceptInputType_isValueAxisInverted: string | boolean

ngAcceptInputType_isValueOverlay

ngAcceptInputType_isValueOverlay: string | boolean

ngAcceptInputType_isVertical

ngAcceptInputType_isVertical: string | boolean

ngAcceptInputType_isWaterfall

ngAcceptInputType_isWaterfall: string | boolean

ngAcceptInputType_layers

ngAcceptInputType_layers: string | IgxSeriesLayerCollection

ngAcceptInputType_legendItemBadgeMode

ngAcceptInputType_legendItemBadgeMode: any

ngAcceptInputType_legendItemBadgeShape

ngAcceptInputType_legendItemBadgeShape: any

ngAcceptInputType_legendItemVisibility

ngAcceptInputType_legendItemVisibility: any

ngAcceptInputType_lineCap

ngAcceptInputType_lineCap: any

ngAcceptInputType_lineJoin

ngAcceptInputType_lineJoin: any

ngAcceptInputType_markerFillOpacity

ngAcceptInputType_markerFillOpacity: string | number

ngAcceptInputType_mouseOverEnabled

ngAcceptInputType_mouseOverEnabled: string | boolean

ngAcceptInputType_opacity

ngAcceptInputType_opacity: string | number

ngAcceptInputType_outlineMode

ngAcceptInputType_outlineMode: string | SeriesOutlineMode

ngAcceptInputType_percentChange

ngAcceptInputType_percentChange: string | number

ngAcceptInputType_resolution

ngAcceptInputType_resolution: string | number

ngAcceptInputType_selectionThickness

ngAcceptInputType_selectionThickness: string | number

ngAcceptInputType_shadowBlur

ngAcceptInputType_shadowBlur: string | number

ngAcceptInputType_shadowOffsetX

ngAcceptInputType_shadowOffsetX: string | number

ngAcceptInputType_shadowOffsetY

ngAcceptInputType_shadowOffsetY: string | number

ngAcceptInputType_shouldAnimateOnDataSourceSwap

ngAcceptInputType_shouldAnimateOnDataSourceSwap: string | boolean

ngAcceptInputType_shouldHideAutoCallouts

ngAcceptInputType_shouldHideAutoCallouts: string | boolean

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden: string | boolean

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush: string | boolean

ngAcceptInputType_showDefaultTooltip

ngAcceptInputType_showDefaultTooltip: string | boolean

ngAcceptInputType_thickness

ngAcceptInputType_thickness: string | number

ngAcceptInputType_transitionDuration

ngAcceptInputType_transitionDuration: string | number

ngAcceptInputType_transitionInDuration

ngAcceptInputType_transitionInDuration: string | number

ngAcceptInputType_transitionInSpeedType

ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType

ngAcceptInputType_transitionOutDuration

ngAcceptInputType_transitionOutDuration: string | number

ngAcceptInputType_transitionOutSpeedType

ngAcceptInputType_transitionOutSpeedType: string | TransitionOutSpeedType

ngAcceptInputType_useItemWiseColors

ngAcceptInputType_useItemWiseColors: string | boolean

ngAcceptInputType_useSingleShadow

ngAcceptInputType_useSingleShadow: string | boolean

ngAcceptInputType_visibility

ngAcceptInputType_visibility: any

ngAcceptInputType_visibleRangeMarginBottom

ngAcceptInputType_visibleRangeMarginBottom: string | number

ngAcceptInputType_visibleRangeMarginLeft

ngAcceptInputType_visibleRangeMarginLeft: string | number

ngAcceptInputType_visibleRangeMarginRight

ngAcceptInputType_visibleRangeMarginRight: string | number

ngAcceptInputType_visibleRangeMarginTop

ngAcceptInputType_visibleRangeMarginTop: string | number

ngAcceptInputType_visibleRangeMode

ngAcceptInputType_visibleRangeMode: string | SeriesVisibleRangeMode

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxSeriesComponent, "ng-component", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxSeriesComponent, never>

Accessors

actualAreaFillOpacity

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

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

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

get actualCloseLabel(): string

Returns string

actualFocusBrush

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

Gets actual Selection mode

get actualFocusMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualFocusMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualHighLabel

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

get actualHighLabel(): string

Returns string

actualHighlightedValuesFadeOpacity

Gets actual HighlightedValues fade opacity

get actualHighlightedValuesFadeOpacity(): number

Returns number

set actualHighlightedValuesFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingFadeOpacity

Gets actual highlighting fade opacity

get actualHighlightingFadeOpacity(): number

Returns number

set actualHighlightingFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingMode

Gets actual highlighting mode

get actualHighlightingMode(): SeriesHighlightingMode

Returns SeriesHighlightingMode

set actualHighlightingMode(v: SeriesHighlightingMode): void

Parameters

v: SeriesHighlightingMode

Returns void

actualHitTestMode

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

Gets the actual extra layers for the series.

get actualLayers(): IgxSeriesLayerCollection

Returns IgxSeriesLayerCollection

set actualLayers(v: IgxSeriesLayerCollection): void

Parameters

v: IgxSeriesLayerCollection

Returns void

actualLegendItemBadgeBrush

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

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

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

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

get actualLowLabel(): string

Returns string

actualMarkerFillOpacity

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

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

get actualOpenLabel(): string

Returns string

actualOutline

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

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

get actualRadiusLabel(): string

Returns string

actualResolution

get actualResolution(): number

Returns number

set actualResolution(v: number): void

Parameters

v: number

Returns void

actualSelectionBrush

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

Gets actual Selection mode

get actualSelectionMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualSelectionMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualThickness

Gets the effective Thickness for the current series object.

get actualThickness(): number

Returns number

set actualThickness(v: number): void

Parameters

v: number

Returns void

actualValueLabel

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

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

get actualVolumeLabel(): string

Returns string

areaFillOpacity

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

attachTooltipToRoot

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

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

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

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

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

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

coercionMethods

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

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

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

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

dataSource

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

discreteLegendItemTemplate

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

expectFunctions

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

The final value of this series.

get finalValue(): number

Returns number

set finalValue(v: number): void

Parameters

v: number

Returns void

focusBrush

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

Returns whether the current series supports visual markers.

let hasMarkers: boolean = this.series.hasMarkers;

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

highlightedDataSource

get highlightedDataSource(): any

Returns any

set highlightedDataSource(value: any): void

Parameters

value: any

Returns void

highlightedLegendItemVisibility

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

highlightedTitleSuffix

Gets or sets the HighlightedTitleSuffix property.

get highlightedTitleSuffix(): string

Returns string

set highlightedTitleSuffix(v: string): void

Parameters

v: string

Returns void

highlightedValuesDataLegendGroup

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

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

Gets the current extra layers for the series.

get highlightedValuesExtraPropertyOverlays(): IgxSeriesLayerPropertyOverlayCollection

Returns IgxSeriesLayerPropertyOverlayCollection

set highlightedValuesExtraPropertyOverlays(v: IgxSeriesLayerPropertyOverlayCollection): void

Parameters

v: IgxSeriesLayerPropertyOverlayCollection

Returns void

highlightedValuesFadeOpacity

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

highlightingFadeOpacity

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

hitTestMode

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

i

get i(): Series

Returns Series

index

Gets the Index property.

get index(): number

Returns number

set index(v: number): void

Parameters

v: number

Returns void

isActualLegendFinancial

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

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

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

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

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

Gets whether the series is an annotation layer.

let isAnnotationLayer: boolean = this.series.isAnnotationLayer;

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

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

let isAreaorLine: boolean = this.series.isAreaorLine;

get isAreaOrLine(): boolean

Returns boolean

isBar

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Gets whether the current series is a category type series.

let isCategory: boolean = this.series.isCategory;

get isCategory(): boolean

Returns boolean

isColoredItemwise

get isColoredItemwise(): boolean

Returns boolean

isColumn

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isComponentHighlightingModeIgnored

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

isDefaultCrosshairBehaviorDisabled

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

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

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

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

Gets whether the current series is a financial type series.

let isFinancial: boolean = this.series.isFinancial;

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

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

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Gets whether the current series is a stack fragment.

let isFragment: boolean = this.series.isFragment;

get isFragment(): boolean

Returns boolean

isGeographic

Gets whether the current series is a geographic series.

let isGeographic: boolean = this.series.isGeographic;

get isGeographic(): boolean

Returns boolean

isHighlightingEnabled

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

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

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

get isLayer(): boolean

Returns boolean

isLineContour

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Gets whether the current series is a polar type series.

let isPolar: boolean = this.series.isPolar;

get isPolar(): boolean

Returns boolean

isPolygon

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Gets whether the current series is a radial type series.

let isRadial: boolean = this.series.isRadial;

get isRadial(): boolean

Returns boolean

isRange

Gets whether the current series is a range type series.

let isRange: boolean = this.series.isRange;

get isRange(): boolean

Returns boolean

isScatter

Gets whether the current series is a scatter type series.

let isScatter: boolean = this.series.isScatter;

get isScatter(): boolean

Returns boolean

isShape

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Gets whether the current series is a stacked type series.

let isStacked: boolean = this.series.isStacked;

get isStacked(): boolean

Returns boolean

isStep

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Gets if the series should appear in any legends.

let isUsableInLegend: boolean = this.series.isUsableInLegend;

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Gets whether the current series is oriented vertically.

let isVertical: boolean = this.series.isVertical;

get isVertical(): boolean

Returns boolean

isWaterfall

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

layers

Gets the current extra layers for the series.

get layers(): IgxSeriesLayerCollection

Returns IgxSeriesLayerCollection

set layers(v: IgxSeriesLayerCollection): void

Parameters

v: IgxSeriesLayerCollection

Returns void

legend

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

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

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

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

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

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

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

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

markerFillOpacity

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

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

get name(): string

Returns string

set name(value: string): void

Parameters

value: string

Returns void

opacity

get opacity(): number

Returns number

set opacity(v: number): void

Parameters

v: number

Returns void

outline

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

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

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

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

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

resolution

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

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

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

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

get seriesInternal(): any

Returns any

shadowBlur

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

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

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

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

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

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

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

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

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

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

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

get tooltipContainerTemplate(): TemplateRef<any>

Returns TemplateRef<any>

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

Parameters

value: TemplateRef<any>

Returns void

tooltipTemplate

get tooltipTemplate(): TemplateRef<any>

Returns TemplateRef<any>

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

Parameters

value: TemplateRef<any>

Returns void

transitionDuration

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

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

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

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

transitionInSpeedType

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

Fired when a transition out has completed.

get transitionOutCompleted(): EventEmitter<object>

Returns EventEmitter<object>

transitionOutDuration

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

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

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

useItemWiseColors

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

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

get visibility(): Visibility

Returns Visibility

set visibility(v: Visibility): void

Parameters

v: Visibility

Returns void

visibleRangeMarginBottom

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

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

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

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

Gets or sets the visible range mode to use.

get visibleRangeMode(): SeriesVisibleRangeMode

Returns SeriesVisibleRangeMode

set visibleRangeMode(v: SeriesVisibleRangeMode): void

Parameters

v: SeriesVisibleRangeMode

Returns void

Methods

bindAxes

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

bindSeries

bindSeries(series: IgxSeriesComponent[]): void

Parameters

series: IgxSeriesComponent[]

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

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

getEffectiveViewport

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

getExactItemIndex(world: IgPoint): number

Parameters

world: IgPoint

The world position for which to return the index.

let index: number = this.series.getExactItemIndex({x:.5,y:.5});

Returns number

getItem

Gets the item that is the best match for the specified world coordinates.

getItem(world: IgPoint): any

Parameters

world: IgPoint

The world coordinates to use.

let item: number = this.series.getItem({x:.5,y:.5});

Returns any

getItemIndex

Gets the item index associated with the specified world position

let index: number = this.series.getItemIndex({x:.5,y:.5});

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

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.

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

getItemSpan(): number

Returns number

getItemValue

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

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

Returns IgRect

getSeriesValueFromSeriesPixel

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

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

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

Parameters

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

Returns number[]

getSeriesValueTypePosition

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

getUnscaledPosition

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

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

ngOnInit(): void

Returns void

notifyIndexedPropertiesChanged

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Replays the assigned transition in animation, if any.

this.series.replayTransitionIn();

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Requests that the provided item should be brought into view if possible.

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to attempt to bring into view.
```
this.series.scrollIntoView(dataItem);
```

Returns boolean

setNegativeColors

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

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

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

_createFromInternal(internal: any): IgxSeriesComponent

Parameters

internal: any