Represents an annotation layer that displays grouped tooltips with summaries for series.

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

ngAcceptInputType_actualAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_actualAreaFillOpacity: string | number
ngAcceptInputType_actualGroupedPositionModeX: string | DataTooltipGroupedPositionX
ngAcceptInputType_actualGroupedPositionModeY: string | DataTooltipGroupedPositionY
ngAcceptInputType_actualGroupingMode: string | DataToolTipLayerGroupingMode
ngAcceptInputType_actualHighlightingFadeOpacity: string | number
ngAcceptInputType_actualHighlightingMode: string | SeriesHighlightingMode
ngAcceptInputType_actualHitTestMode: string | SeriesHitTestMode
ngAcceptInputType_actualHorizontalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_actualHorizontalDashArray: string | number[]
ngAcceptInputType_actualHorizontalShiftAmount: string | number
ngAcceptInputType_actualMarkerFillOpacity: string | number
ngAcceptInputType_actualResolution: string | number
ngAcceptInputType_actualShiftAmount: string | number
ngAcceptInputType_actualThickness: string | number
ngAcceptInputType_actualVerticalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_actualVerticalDashArray: string | number[]
ngAcceptInputType_actualVerticalShiftAmount: string | number
ngAcceptInputType_appearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_areaFillOpacity: string | number
ngAcceptInputType_badgeMarginBottom: string | number
ngAcceptInputType_badgeMarginLeft: string | number
ngAcceptInputType_badgeMarginRight: string | number
ngAcceptInputType_badgeMarginTop: string | number
ngAcceptInputType_badgeShape: string | LegendItemBadgeShape
ngAcceptInputType_cursorPosition: string | IgPoint
ngAcceptInputType_dashArray: string | number[]
ngAcceptInputType_defaultPositionOffsetX: string | number
ngAcceptInputType_defaultPositionOffsetY: string | number
ngAcceptInputType_excludedColumns: string | string[]
ngAcceptInputType_excludedSeries: string | string[]
ngAcceptInputType_expectFunctions: string | boolean
ngAcceptInputType_finalValue: string | number
ngAcceptInputType_groupedPositionModeX: string | DataTooltipGroupedPositionX
ngAcceptInputType_groupedPositionModeY: string | DataTooltipGroupedPositionY
ngAcceptInputType_groupingMode: string | DataToolTipLayerGroupingMode
ngAcceptInputType_hasMarkers: string | boolean
ngAcceptInputType_hasOnlyMarkers: string | boolean
ngAcceptInputType_hasValueAxis: string | boolean
ngAcceptInputType_headerFormatDate: string | DataLegendHeaderDateMode
ngAcceptInputType_headerFormatSpecifiers: string | any[]
ngAcceptInputType_headerFormatTime: string | DataLegendHeaderTimeMode
ngAcceptInputType_headerRowMarginBottom: string | number
ngAcceptInputType_headerRowMarginLeft: string | number
ngAcceptInputType_headerRowMarginRight: string | number
ngAcceptInputType_headerRowMarginTop: string | number
ngAcceptInputType_headerRowVisible: string | boolean
ngAcceptInputType_headerTextMarginBottom: string | number
ngAcceptInputType_headerTextMarginLeft: string | number
ngAcceptInputType_headerTextMarginRight: string | number
ngAcceptInputType_headerTextMarginTop: string | number
ngAcceptInputType_highlightingFadeOpacity: string | number
ngAcceptInputType_hitTestMode: string | SeriesHitTestMode
ngAcceptInputType_horizontalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_horizontalDashArray: string | number[]
ngAcceptInputType_horizontalShiftAmount: string | number
ngAcceptInputType_includedColumns: string | string[]
ngAcceptInputType_includedSeries: string | string[]
ngAcceptInputType_isActualLegendFinancial: string | boolean
ngAcceptInputType_isAnnotationCalloutLayer: string | boolean
ngAcceptInputType_isAnnotationCrosshairLayer: string | boolean
ngAcceptInputType_isAnnotationFinalValue: string | boolean
ngAcceptInputType_isAnnotationHoverLayer: string | boolean
ngAcceptInputType_isAnnotationLayer: string | boolean
ngAcceptInputType_isAnnotationValueLayer: string | boolean
ngAcceptInputType_isArea: string | boolean
ngAcceptInputType_isAreaOrLine: string | boolean
ngAcceptInputType_isBar: string | boolean
ngAcceptInputType_isCategory: string | boolean
ngAcceptInputType_isColumn: string | boolean
ngAcceptInputType_isComponentHighlightingModeIgnored: string | boolean
ngAcceptInputType_isDefaultCrosshairBehaviorDisabled: string | boolean
ngAcceptInputType_isDefaultCrosshairDisabled: string | boolean
ngAcceptInputType_isDefaultToolTipSelected: string | boolean
ngAcceptInputType_isDefaultTooltipBehaviorDisabled: string | boolean
ngAcceptInputType_isDropShadowEnabled: string | boolean
ngAcceptInputType_isFinancial: string | boolean
ngAcceptInputType_isFinancialIndicator: string | boolean
ngAcceptInputType_isFinancialOverlay: string | boolean
ngAcceptInputType_isFinancialSeries: string | boolean
ngAcceptInputType_isFinancialWaterfall: string | boolean
ngAcceptInputType_isFragment: string | boolean
ngAcceptInputType_isGeographic: string | boolean
ngAcceptInputType_isHighlightingEnabled: string | boolean
ngAcceptInputType_isIndexed: string | boolean
ngAcceptInputType_isLineContour: string | boolean
ngAcceptInputType_isLineOnly: string | boolean
ngAcceptInputType_isMarkerlessDisplayPreferred: string | boolean
ngAcceptInputType_isNegativeColorSupported: string | boolean
ngAcceptInputType_isPie: string | boolean
ngAcceptInputType_isPixel: string | boolean
ngAcceptInputType_isPolar: string | boolean
ngAcceptInputType_isPolygon: string | boolean
ngAcceptInputType_isPolyline: string | boolean
ngAcceptInputType_isRadial: string | boolean
ngAcceptInputType_isRange: string | boolean
ngAcceptInputType_isScatter: string | boolean
ngAcceptInputType_isShape: string | boolean
ngAcceptInputType_isShapeControl: string | boolean
ngAcceptInputType_isSpline: string | boolean
ngAcceptInputType_isStacked: string | boolean
ngAcceptInputType_isStep: string | boolean
ngAcceptInputType_isTile: string | boolean
ngAcceptInputType_isUsableInLegend: string | boolean
ngAcceptInputType_isValueAxisInverted: string | boolean
ngAcceptInputType_isValueOverlay: string | boolean
ngAcceptInputType_isVertical: string | boolean
ngAcceptInputType_isWaterfall: string | boolean
ngAcceptInputType_labelDisplayMode: string | DataLegendLabelMode
ngAcceptInputType_labelTextMarginBottom: string | number
ngAcceptInputType_labelTextMarginLeft: string | number
ngAcceptInputType_labelTextMarginRight: string | number
ngAcceptInputType_labelTextMarginTop: string | number
ngAcceptInputType_legendItemBadgeMode: string | LegendItemBadgeMode
ngAcceptInputType_legendItemBadgeShape: string | LegendItemBadgeShape
ngAcceptInputType_legendItemVisibility: string | Visibility
ngAcceptInputType_lineCap: string | PenLineCap
ngAcceptInputType_lineJoin: string | PenLineJoin
ngAcceptInputType_markerFillOpacity: string | number
ngAcceptInputType_mouseOverEnabled: string | boolean
ngAcceptInputType_opacity: string | number
ngAcceptInputType_outlineMode: string | SeriesOutlineMode
ngAcceptInputType_percentChange: string | number
ngAcceptInputType_positionOffsetX: string | number
ngAcceptInputType_positionOffsetY: string | number
ngAcceptInputType_resolution: string | number
ngAcceptInputType_shadowBlur: string | number
ngAcceptInputType_shadowOffsetX: string | number
ngAcceptInputType_shadowOffsetY: string | number
ngAcceptInputType_shiftAmount: string | number
ngAcceptInputType_shouldHideAutoCallouts: string | boolean
ngAcceptInputType_shouldRenderAsOverlay: string | boolean
ngAcceptInputType_shouldUpdateWhenSeriesDataChanges: string | boolean
ngAcceptInputType_showDefaultTooltip: string | boolean
ngAcceptInputType_summaryRowMarginBottom: string | number
ngAcceptInputType_summaryRowMarginLeft: string | number
ngAcceptInputType_summaryRowMarginRight: string | number
ngAcceptInputType_summaryRowMarginTop: string | number
ngAcceptInputType_summaryTitleTextMarginBottom: string | number
ngAcceptInputType_summaryTitleTextMarginLeft: string | number
ngAcceptInputType_summaryTitleTextMarginRight: string | number
ngAcceptInputType_summaryTitleTextMarginTop: string | number
ngAcceptInputType_summaryType: string | DataLegendSummaryType
ngAcceptInputType_thickness: string | number
ngAcceptInputType_titleTextMarginBottom: string | number
ngAcceptInputType_titleTextMarginLeft: string | number
ngAcceptInputType_titleTextMarginRight: string | number
ngAcceptInputType_titleTextMarginTop: string | number
ngAcceptInputType_transitionDuration: string | number
ngAcceptInputType_transitionInDuration: string | number
ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType
ngAcceptInputType_unitsDisplayMode: string | DataLegendUnitsMode
ngAcceptInputType_unitsTextMarginBottom: string | number
ngAcceptInputType_unitsTextMarginLeft: string | number
ngAcceptInputType_unitsTextMarginRight: string | number
ngAcceptInputType_unitsTextMarginTop: string | number
ngAcceptInputType_useIndex: string | boolean
ngAcceptInputType_useInterpolation: string | boolean
ngAcceptInputType_useLegend: string | boolean
ngAcceptInputType_useSingleShadow: string | boolean
ngAcceptInputType_valueFormatAbbreviation: string | DataAbbreviationMode
ngAcceptInputType_valueFormatMaxFractions: string | number
ngAcceptInputType_valueFormatMinFractions: string | number
ngAcceptInputType_valueFormatMode: string | DataLegendValueMode
ngAcceptInputType_valueFormatSpecifiers: string | any[]
ngAcceptInputType_valueFormatUseGrouping: string | boolean
ngAcceptInputType_valueRowMarginBottom: string | number
ngAcceptInputType_valueRowMarginLeft: string | number
ngAcceptInputType_valueRowMarginRight: string | number
ngAcceptInputType_valueRowMarginTop: string | number
ngAcceptInputType_valueRowVisible: string | boolean
ngAcceptInputType_valueTextMarginBottom: string | number
ngAcceptInputType_valueTextMarginLeft: string | number
ngAcceptInputType_valueTextMarginRight: string | number
ngAcceptInputType_valueTextMarginTop: string | number
ngAcceptInputType_valueTextUseSeriesColors: string | boolean
ngAcceptInputType_verticalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_verticalDashArray: string | number[]
ngAcceptInputType_verticalShiftAmount: string | number
ngAcceptInputType_visibility: string | Visibility
ngAcceptInputType_visibleRangeMarginBottom: string | number
ngAcceptInputType_visibleRangeMarginLeft: string | number
ngAcceptInputType_visibleRangeMarginRight: string | number
ngAcceptInputType_visibleRangeMarginTop: string | number
ngAcceptInputType_visibleRangeMode: string | SeriesVisibleRangeMode
ɵcmp: unknown
ɵfac: unknown

Accessors

  • get actualAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualAppearanceMode(v: AnnotationAppearanceMode): void
  • Parameters

    Returns void

  • get actualAreaFillOpacity(): number
  • Gets the actual opacity applied to the area fill visual.

    let actualFillOpacity: number = series.actualAreaFillOpacity;
    

    Returns number

  • set actualAreaFillOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualBrush(): string
  • Gets the effective brush for the current series object.

    let actualBrush: string = series.actualBrush;
    

    Returns string

  • set actualBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualCloseLabel(): string
  • Gets the text that is displayed for the Close label in the tooltip.

    Returns string

  • get actualHighLabel(): string
  • Gets the text that is displayed for the High label in the tooltip.

    Returns string

  • get actualHighlightingFadeOpacity(): number
  • Gets actual highlighting fade opacity

    Returns number

  • set actualHighlightingFadeOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightingMode(): SeriesHighlightingMode
  • Gets actual highlighting mode

    Returns SeriesHighlightingMode

  • set actualHighlightingMode(v: SeriesHighlightingMode): void
  • Parameters

    Returns void

  • get actualHitTestMode(): SeriesHitTestMode
  • Resolved method of hit testing to use when pointing to items in the chart.

    let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;
    

    Returns SeriesHitTestMode

  • set actualHitTestMode(v: SeriesHitTestMode): void
  • Parameters

    Returns void

  • get actualHorizontalAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualHorizontalAppearanceMode(v: AnnotationAppearanceMode): void
  • Parameters

    Returns void

  • get actualHorizontalDashArray(): number[]
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set actualHorizontalDashArray(v: number[]): void
  • Parameters

    • v: number[]

    Returns void

  • get actualHorizontalShiftAmount(): number
  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualHorizontalShiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualLegendItemBadgeBrush(): string
  • Gets the effective legend badge fill for the current series.

    Returns string

  • set actualLegendItemBadgeBrush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualLegendItemBadgeOutline(): string
  • Gets the effective legend badge outline for the current series.

    Returns string

  • set actualLegendItemBadgeOutline(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualLegendItemBadgeTemplate(): IgDataTemplate
  • Gets the actual legend item badge template used by the series.

    Returns IgDataTemplate

  • set actualLegendItemBadgeTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

  • get actualLowLabel(): string
  • Gets the text that is displayed for the Low label in the tooltip.

    Returns string

  • get actualMarkerFillOpacity(): number
  • Gets the actual opacity applied to the fill of the markers.

    Returns number

  • set actualMarkerFillOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualOpenLabel(): string
  • Gets the text that is displayed for the Open label in the tooltip.

    Returns string

  • get actualOutline(): string
  • Gets the effective outline for the current series object.

    let actualOutline: string = series.ActualOutline;
    

    Returns string

  • set actualOutline(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualRadiusLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • get actualResolution(): number
  • Returns number

  • set actualResolution(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualShiftAmount(): number
  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualShiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualThickness(): number
  • Gets the effective Thickness for the current series object.

    Returns number

  • set actualThickness(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualValueLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • get actualVerticalAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualVerticalAppearanceMode(v: AnnotationAppearanceMode): void
  • Parameters

    Returns void

  • get actualVerticalDashArray(): number[]
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set actualVerticalDashArray(v: number[]): void
  • Parameters

    • v: number[]

    Returns void

  • get actualVerticalShiftAmount(): number
  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualVerticalShiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualVolumeLabel(): string
  • Gets the text that is displayed for the Volume label in the tooltip.

    Returns string

  • get appearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set appearanceMode(v: AnnotationAppearanceMode): void
  • Parameters

    Returns void

  • get areaFillOpacity(): number
  • 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>

    Returns number

  • set areaFillOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get badgeMarginBottom(): number
  • Returns number

  • set badgeMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get badgeMarginLeft(): number
  • Returns number

  • set badgeMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get badgeMarginRight(): number
  • Returns number

  • set badgeMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get badgeMarginTop(): number
  • Returns number

  • set badgeMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get brush(): string
  • 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";
    

    Returns string

  • set brush(v: string): void
  • Parameters

    • v: string

    Returns void

  • get coercionMethods(): any
  • 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;}
    }

    Returns any

  • set coercionMethods(v: any): void
  • Parameters

    • v: any

    Returns void

  • get cursorPosition(): IgPoint
  • Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position. A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement.

    Returns IgPoint

  • set cursorPosition(v: IgPoint): void
  • Parameters

    Returns void

  • get dashArray(): number[]
  • 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.

    Returns number[]

  • set dashArray(v: number[]): void
  • Parameters

    • v: number[]

    Returns void

  • get dataLegendKey(): string
  • Gets unique key used to identify the series in data legend

    Returns string

  • get dataSource(): any
  • Returns any

  • set dataSource(value: any): void
  • Parameters

    • value: any

    Returns void

  • get defaultPositionOffsetX(): number
  • Gets or sets the default offset of the tooltip layer on the X axis.

    Returns number

  • set defaultPositionOffsetX(v: number): void
  • Parameters

    • v: number

    Returns void

  • get defaultPositionOffsetY(): number
  • Gets or sets the default offset of the tooltip layer on the Y axis.

    Returns number

  • set defaultPositionOffsetY(v: number): void
  • Parameters

    • v: number

    Returns void

  • get discreteLegendItemTemplate(): IgDataTemplate
  • Gets or sets the DiscreteLegendItemTemplate property. The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set discreteLegendItemTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

  • get excludedColumns(): string[]
  • Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedences over values of IncludedColumns property

    Returns string[]

  • set excludedColumns(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get excludedSeries(): string[]
  • Gets or sets indexes or names of series to exclude from displaying in the data legend, e.g. "0, 1" The ExcludedSeries property takes precedences over values of IncludedSeries property

    Returns string[]

  • set excludedSeries(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get expectFunctions(): boolean
  • 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;
    

    Returns boolean

  • set expectFunctions(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get finalValue(): number
  • The final value of this series.

    Returns number

  • set finalValue(v: number): void
  • Parameters

    • v: number

    Returns void

  • get hasMarkers(): boolean
  • Returns whether the current series supports visual markers.

    let hasMarkers: boolean = this.series.hasMarkers;
    

    Returns boolean

  • get hasOnlyMarkers(): boolean
  • Gets whether the series has only marker as visuals

    Returns boolean

  • get hasValueAxis(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get headerFormatCulture(): string
  • Gets or sets globalization culture when displaying header as date time This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns string

  • set headerFormatCulture(v: string): void
  • Parameters

    • v: string

    Returns void

  • get headerFormatDate(): DataLegendHeaderDateMode
  • Gets or sets date format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns DataLegendHeaderDateMode

  • set headerFormatDate(v: DataLegendHeaderDateMode): void
  • Parameters

    Returns void

  • get headerFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the HeaderFormatString string.

    Returns any[]

  • set headerFormatSpecifiers(v: any[]): void
  • Parameters

    • v: any[]

    Returns void

  • get headerFormatString(): string
  • Gets or sets the format string for header text displayed in the data legend.

    Returns string

  • set headerFormatString(v: string): void
  • Parameters

    • v: string

    Returns void

  • get headerFormatTime(): DataLegendHeaderTimeMode
  • Gets or sets time format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns DataLegendHeaderTimeMode

  • set headerFormatTime(v: DataLegendHeaderTimeMode): void
  • Parameters

    Returns void

  • get headerRowMarginBottom(): number
  • Returns number

  • set headerRowMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerRowMarginLeft(): number
  • Returns number

  • set headerRowMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerRowMarginRight(): number
  • Returns number

  • set headerRowMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerRowMarginTop(): number
  • Returns number

  • set headerRowMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerRowVisible(): boolean
  • Gets or sets whether to show Header row.

    Returns boolean

  • set headerRowVisible(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get headerText(): string
  • Gets or sets the HeaderText for the data legend.

    Returns string

  • set headerText(v: string): void
  • Parameters

    • v: string

    Returns void

  • get headerTextColor(): string
  • Gets or sets the header text color.

    Returns string

  • set headerTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get headerTextMarginBottom(): number
  • Returns number

  • set headerTextMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerTextMarginLeft(): number
  • Returns number

  • set headerTextMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerTextMarginRight(): number
  • Returns number

  • set headerTextMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerTextMarginTop(): number
  • Returns number

  • set headerTextMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get headerTextStyle(): string
  • Gets or Sets the style to use for the header text.

    Returns string

  • set headerTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get highlightingFadeOpacity(): number
  • Gets or sets the target opacity to fade to for fade style highlighting.

    Returns number

  • set highlightingFadeOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get hitTestMode(): SeriesHitTestMode
  • 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;
    

    Returns SeriesHitTestMode

  • set hitTestMode(v: SeriesHitTestMode): void
  • Parameters

    Returns void

  • get horizontalAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set horizontalAppearanceMode(v: AnnotationAppearanceMode): void
  • Parameters

    Returns void

  • get horizontalDashArray(): number[]
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set horizontalDashArray(v: number[]): void
  • Parameters

    • v: number[]

    Returns void

  • get horizontalShiftAmount(): number
  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set horizontalShiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get includedColumns(): string[]
  • Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedences over values of IncludedColumns property

    Returns string[]

  • set includedColumns(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get includedSeries(): string[]
  • Gets or sets indexes or names of series to include in displaying in the data legend, e.g. "0, 1"

    Returns string[]

  • set includedSeries(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get isActualLegendFinancial(): boolean
  • Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

    Returns boolean

  • set isActualLegendFinancial(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isAnnotationCalloutLayer(): boolean
  • Gets whether the series is an callout annotation layer.

    Returns boolean

  • get isAnnotationCrosshairLayer(): boolean
  • Gets whether the series is an crosshair annotation layer.

    Returns boolean

  • get isAnnotationFinalValue(): boolean
  • Gets whether the series is final value annotation layer.

    Returns boolean

  • get isAnnotationHoverLayer(): boolean
  • Gets whether the series is an annotation layer displayed only when hovering over the chart.

    Returns boolean

  • get isAnnotationLayer(): boolean
  • Gets whether this series is an annotation layer.

    Returns boolean

  • get isAnnotationValueLayer(): boolean
  • Gets whether the series is a value annotation layer.

    Returns boolean

  • get isArea(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isAreaOrLine(): boolean
  • Gets whether the current series shows an area or line shape.

    let isAreaorLine: boolean = this.series.isAreaorLine;
    

    Returns boolean

  • get isBar(): boolean
  • Gets whether the current series shows a horizontal column shape.

    Returns boolean

  • get isCategory(): boolean
  • Gets whether the current series is a category type series.

    let isCategory: boolean = this.series.isCategory;
    

    Returns boolean

  • get isColumn(): boolean
  • Gets whether the current series shows a column shape.

    Returns boolean

  • get isComponentHighlightingModeIgnored(): boolean
  • Gets or sets whether the component level highlight mode is ignored.

    Returns boolean

  • set isComponentHighlightingModeIgnored(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isDefaultCrosshairBehaviorDisabled(): boolean
  • Gets whether or not the default crosshair behavior is disabled.

    Returns boolean

  • get isDefaultCrosshairDisabled(): boolean
  • Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer.

    Returns boolean

  • set isDefaultCrosshairDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isDefaultToolTipSelected(): boolean
  • 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;
    

    Returns boolean

  • set isDefaultToolTipSelected(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isDefaultTooltipBehaviorDisabled(): boolean
  • Gets whether the default tooltip behaviors for the chart are disabled if this layer is present.

    Returns boolean

  • get isDropShadowEnabled(): boolean
  • 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;
    

    Returns boolean

  • set isDropShadowEnabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isFinancial(): boolean
  • Gets whether the current series is a financial type series.

    let isFinancial: boolean = this.series.isFinancial;
    

    Returns boolean

  • get isFinancialIndicator(): boolean
  • Gets whether the series is financial indicator

    Returns boolean

  • get isFinancialOverlay(): boolean
  • Gets whether the series is financial overlay

    Returns boolean

  • get isFinancialSeries(): boolean
  • Gets whether the series has financial OHLC/candlestick visuals

    Returns boolean

  • get isFinancialWaterfall(): boolean
  • Gets whether the series is financial waterfall

    Returns boolean

  • get isFragment(): boolean
  • Gets whether the current series is a stack fragment.

    let isFragment: boolean = this.series.isFragment;
    

    Returns boolean

  • get isGeographic(): boolean
  • Gets whether the current series is a geographic series.

    let isGeographic: boolean = this.series.isGeographic;
    

    Returns boolean

  • get isHighlightingEnabled(): boolean
  • 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;
    

    Returns boolean

  • set isHighlightingEnabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isIndexed(): boolean
  • Gets if the series uses an index, which can be used to auto-assign it a color.

    Returns boolean

  • get isLineContour(): boolean
  • Gets whether the current series shows a line contour shape.

    Returns boolean

  • get isLineOnly(): boolean
  • Gets whether the current series shows only line shapes.

    Returns boolean

  • get isMarkerlessDisplayPreferred(): boolean
  • Overridden by derived series classes to indicate when markerless display is preferred or not.

    Returns boolean

  • get isNegativeColorSupported(): boolean
  • Overridden by derived series classes to indicate when negative colors are supported or not.

    Returns boolean

  • get isPie(): boolean
  • Gets whether the current series shows a pie shape.

    Returns boolean

  • get isPixel(): boolean
  • Gets whether the current series shows pixels.

    Returns boolean

  • get isPolar(): boolean
  • Gets whether the current series is a polar type series.

    let isPolar: boolean = this.series.isPolar;
    

    Returns boolean

  • get isPolygon(): boolean
  • Gets whether the current series shows a polygon shape.

    Returns boolean

  • get isPolyline(): boolean
  • Gets whether the current series shows a polyline shape.

    Returns boolean

  • get isRadial(): boolean
  • Gets whether the current series is a radial type series.

    let isRadial: boolean = this.series.isRadial;
    

    Returns boolean

  • get isRange(): boolean
  • Gets whether the current series is a range type series.

    let isRange: boolean = this.series.isRange;
    

    Returns boolean

  • get isScatter(): boolean
  • Gets whether the current series is a scatter type series.

    let isScatter: boolean = this.series.isScatter;
    

    Returns boolean

  • get isShape(): boolean
  • Gets whether the current series is a shape type series.

    Returns boolean

  • get isShapeControl(): boolean
  • Gets whether the current series shows interactive shape controls.

    Returns boolean

  • get isSpline(): boolean
  • Gets whether the current series shows a spline shape.

    Returns boolean

  • get isStacked(): boolean
  • Gets whether the current series is a stacked type series.

    let isStacked: boolean = this.series.isStacked;
    

    Returns boolean

  • get isStep(): boolean
  • Gets whether the current series shows step shapes.

    Returns boolean

  • get isTile(): boolean
  • Gets whether the current series shows a tile imagery.

    Returns boolean

  • get isUsableInLegend(): boolean
  • Gets if the series should appear in any legends.

    Returns boolean

  • get isValueAxisInverted(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isValueOverlay(): boolean
  • Gets whether the series is a value overlay.

    Returns boolean

  • get isVertical(): boolean
  • Gets whether the current series is oriented vertically.

    let isVertical: boolean = this.series.isVertical;
    

    Returns boolean

  • get isWaterfall(): boolean
  • Gets whether the current series shows a waterfall column shape.

    Returns boolean

  • get labelDisplayMode(): DataLegendLabelMode
  • Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

    Returns DataLegendLabelMode

  • set labelDisplayMode(v: DataLegendLabelMode): void
  • Parameters

    Returns void

  • get labelTextColor(): string
  • Gets or sets the units text color.

    Returns string

  • set labelTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get labelTextMarginBottom(): number
  • Returns number

  • set labelTextMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get labelTextMarginLeft(): number
  • Returns number

  • set labelTextMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get labelTextMarginRight(): number
  • Returns number

  • set labelTextMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get labelTextMarginTop(): number
  • Returns number

  • set labelTextMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get labelTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set labelTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get legend(): any
  • Gets or sets the legend used for the current series.

    Returns any

  • set legend(v: any): void
  • Parameters

    • v: any

    Returns void

  • get legendItemBadgeMode(): 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

    Returns LegendItemBadgeMode

  • set legendItemBadgeMode(v: LegendItemBadgeMode): void
  • Parameters

    Returns void

  • get legendItemBadgeShape(): 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

    Returns LegendItemBadgeShape

  • set legendItemBadgeShape(v: LegendItemBadgeShape): void
  • Parameters

    Returns void

  • get legendItemBadgeTemplate(): IgDataTemplate
  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

  • get legendItemTemplate(): IgDataTemplate
  • Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

  • get legendItemVisibility(): Visibility
  • Gets or sets the legend item visibility for the current series object.

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

    Returns Visibility

  • set legendItemVisibility(v: Visibility): void
  • Parameters

    Returns void

  • get lineCap(): PenLineCap
  • 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.

    Returns PenLineCap

  • set lineCap(v: PenLineCap): void
  • Parameters

    Returns void

  • get lineJoin(): PenLineJoin
  • Gets or sets the brush that specifies current series object's line join style.

    Returns PenLineJoin

  • set lineJoin(v: PenLineJoin): void
  • Parameters

    Returns void

  • get markerFillOpacity(): number
  • Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

    Returns number

  • set markerFillOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get mouseOverEnabled(): boolean
  • Gets or sets the whether the chart reacts to mouse move events.

    Returns boolean

  • set mouseOverEnabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get name(): string
  • Returns string

  • set name(value: string): void
  • Parameters

    • value: string

    Returns void

  • get opacity(): number
  • Returns number

  • set opacity(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outline(): string
  • 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";
    

    Returns string

  • set outline(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlineMode(): SeriesOutlineMode
  • Gets or sets the outline mode to use for the series.

    Returns SeriesOutlineMode

  • set outlineMode(v: SeriesOutlineMode): void
  • Parameters

    Returns void

  • get percentChange(): number
  • The percent change from the beginning to the end of this series.

    Returns number

  • set percentChange(v: number): void
  • Parameters

    • v: number

    Returns void

  • get positionOffsetX(): number
  • Gets or sets the offset of the tooltip layer on the X axis.

    Returns number

  • set positionOffsetX(v: number): void
  • Parameters

    • v: number

    Returns void

  • get positionOffsetY(): number
  • Gets or sets the offset of the tooltip layer on the Y axis.

    Returns number

  • set positionOffsetY(v: number): void
  • Parameters

    • v: number

    Returns void

  • get renderRequested(): EventEmitter<{
        args: IgxRenderRequestedEventArgs;
        sender: any;
    }>
  • This event is raised every time a render has been requested from a series.

    Returns EventEmitter<{
        args: IgxRenderRequestedEventArgs;
        sender: any;
    }>

  • get resolution(): number
  • 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;
    

    Returns number

  • set resolution(v: number): void
  • Parameters

    • v: number

    Returns void

  • get seriesInternal(): any
  • Returns any

  • get shadowBlur(): number
  • 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;
    

    Returns number

  • set shadowBlur(v: number): void
  • Parameters

    • v: number

    Returns void

  • get shadowColor(): string
  • 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";
    

    Returns string

  • set shadowColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get shadowOffsetX(): number
  • 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;
    

    Returns number

  • set shadowOffsetX(v: number): void
  • Parameters

    • v: number

    Returns void

  • get shadowOffsetY(): number
  • 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;
    

    Returns number

  • set shadowOffsetY(v: number): void
  • Parameters

    • v: number

    Returns void

  • get shiftAmount(): number
  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set shiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get shouldHideAutoCallouts(): boolean
  • Gets or sets whether this series should suppress it's auto callouts

    Returns boolean

  • set shouldHideAutoCallouts(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldRenderAsOverlay(): boolean
  • Gets or sets whether this layer renders as an overlay or not.

    Returns boolean

  • set shouldRenderAsOverlay(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldUpdateWhenSeriesDataChanges(): boolean
  • Gets or sets whether the data legend should update when the series data is mutated.

    Returns boolean

  • set shouldUpdateWhenSeriesDataChanges(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get showDefaultTooltip(): boolean
  • 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";
    

    Returns boolean

  • set showDefaultTooltip(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get summaryLabelText(): string
  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryLabelText(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryLabelTextColor(): string
  • Gets or sets the units text color.

    Returns string

  • set summaryLabelTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryLabelTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryLabelTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryRowMarginBottom(): number
  • Returns number

  • set summaryRowMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryRowMarginLeft(): number
  • Returns number

  • set summaryRowMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryRowMarginRight(): number
  • Returns number

  • set summaryRowMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryRowMarginTop(): number
  • Returns number

  • set summaryRowMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryTitleText(): string
  • Gets or sets the SummaryTitleText for the data legend.

    Returns string

  • set summaryTitleText(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryTitleTextColor(): string
  • Gets or sets the summary text color.

    Returns string

  • set summaryTitleTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryTitleTextMarginBottom(): number
  • Returns number

  • set summaryTitleTextMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryTitleTextMarginLeft(): number
  • Returns number

  • set summaryTitleTextMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryTitleTextMarginRight(): number
  • Returns number

  • set summaryTitleTextMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryTitleTextMarginTop(): number
  • Returns number

  • set summaryTitleTextMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get summaryTitleTextStyle(): string
  • Gets or Sets the style to use for the summary text.

    Returns string

  • set summaryTitleTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryUnitsText(): string
  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryUnitsText(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryUnitsTextColor(): string
  • Gets or sets the units text color.

    Returns string

  • set summaryUnitsTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryUnitsTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryUnitsTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryValueTextColor(): string
  • Gets or sets the units text color.

    Returns string

  • set summaryValueTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get summaryValueTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryValueTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get targetAxis(): IgxAxisComponent
  • Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.

    Returns IgxAxisComponent

  • set targetAxis(v: IgxAxisComponent): void
  • Parameters

    Returns void

  • get thickness(): number
  • 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;
    

    Returns number

  • set thickness(v: number): void
  • Parameters

    • v: number

    Returns void

  • get title(): any
  • 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";
    

    Returns any

  • set title(v: any): void
  • Parameters

    • v: any

    Returns void

  • get titleTextColor(): string
  • Gets or sets the display text color.

    Returns string

  • set titleTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get titleTextMarginBottom(): number
  • Returns number

  • set titleTextMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get titleTextMarginLeft(): number
  • Returns number

  • set titleTextMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get titleTextMarginRight(): number
  • Returns number

  • set titleTextMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get titleTextMarginTop(): number
  • Returns number

  • set titleTextMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get titleTextStyle(): string
  • Gets or Sets the style to use for the display text.

    Returns string

  • set titleTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get tooltipContainerTemplate(): TemplateRef<any>
  • Returns TemplateRef<any>

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

    • value: TemplateRef<any>

    Returns void

  • get tooltipTemplate(): TemplateRef<any>
  • Returns TemplateRef<any>

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

    • value: TemplateRef<any>

    Returns void

  • get transitionDuration(): number
  • Gets or sets the duration of the current series's 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;
    

    Returns number

  • set transitionDuration(v: number): void
  • Parameters

    • v: number

    Returns void

  • get transitionEasingFunction(): ((time: number) => number)
  • 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;
    

    Returns ((time: number) => number)

      • (time: number): number
      • 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;
        

        Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v: ((time: number) => number)): void
  • Parameters

    • v: ((time: number) => number)
        • (time: number): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get transitionInDuration(): number
  • Gets or sets the duration of the current series's 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;
    

    Returns number

  • set transitionInDuration(v: number): void
  • Parameters

    • v: number

    Returns void

  • get transitionInEasingFunction(): ((time: number) => number)
  • 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;
    

    Returns ((time: number) => number)

      • (time: number): number
      • 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;
        

        Parameters

        • time: number

        Returns number

  • set transitionInEasingFunction(v: ((time: number) => number)): void
  • Parameters

    • v: ((time: number) => number)
        • (time: number): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get transitionInSpeedType(): TransitionInSpeedType
  • Gets or sets the duration of the current series's 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;
    

    Returns TransitionInSpeedType

  • set transitionInSpeedType(v: TransitionInSpeedType): void
  • Parameters

    Returns void

  • get unitsDisplayMode(): DataLegendUnitsMode
  • Gets or sets the UnitsMode for the data legend.

    Returns DataLegendUnitsMode

  • set unitsDisplayMode(v: DataLegendUnitsMode): void
  • Parameters

    Returns void

  • get unitsText(): string
  • Gets or sets the units text for the data legend.

    Returns string

  • set unitsText(v: string): void
  • Parameters

    • v: string

    Returns void

  • get unitsTextColor(): string
  • Gets or sets the units text color.

    Returns string

  • set unitsTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get unitsTextMarginBottom(): number
  • Returns number

  • set unitsTextMarginBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get unitsTextMarginLeft(): number
  • Returns number

  • set unitsTextMarginLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get unitsTextMarginRight(): number
  • Returns number

  • set unitsTextMarginRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get unitsTextMarginTop(): number
  • Returns number

  • set unitsTextMarginTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get unitsTextStyle(): string
  • Gets or Sets the style to use for the units text.

    Returns string

  • set unitsTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get useIndex(): boolean
  • Gets or sets whether this series should take up an index for auto brush coloring.

    Returns boolean

  • set useIndex(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get useInterpolation(): boolean
  • Gets or sets whether to use value interpolation when drawing the tooltips.

    Returns boolean

  • set useInterpolation(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get useLegend(): boolean
  • Gets or sets whether this series interacts with the chart legend.

    Returns boolean

  • set useLegend(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get useSingleShadow(): boolean
  • 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;
    

    Returns boolean

  • set useSingleShadow(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get valueFormatAbbreviation(): DataAbbreviationMode
  • Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns DataAbbreviationMode

  • set valueFormatAbbreviation(v: DataAbbreviationMode): void
  • Parameters

    Returns void

  • get valueFormatCulture(): string
  • Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns string

  • set valueFormatCulture(v: string): void
  • Parameters

    • v: string

    Returns void

  • get valueFormatMaxFractions(): number
  • Gets or sets maximum digits for formating numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns number

  • set valueFormatMaxFractions(v: number): void
  • Parameters

    • v: number

    Returns void

  • get valueFormatMinFractions(): number
  • Gets or sets minimum digits for formating numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns number

  • set valueFormatMinFractions(v: number): void
  • Parameters

    • v: number

    Returns void

  • get valueFormatMode(): DataLegendValueMode
  • Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

    Returns DataLegendValueMode

  • set valueFormatMode(v: DataLegendValueMode): void
  • Parameters

    Returns void

  • get valueFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the ValueFormatString string.

    Returns any[]

  • set valueFormatSpecifiers(v: any[]): void
  • Parameters

    • v: any[]

    Returns void

  • get valueFormatString(): string
  • Gets or sets the format string for values displayed in the data legend.

    Returns string

  • set valueFormatString(v: string): void
  • Parameters

    • v: string

    Returns void

  • get valueFormatUseGrouping(): boolean
  • Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns boolean

  • set valueFormatUseGrouping(v: boolean