Class IgxDataAnnotationLineLayerComponent

Represents an annotation layer that renders lines at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

ngAcceptInputType_actualAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_actualAreaFillOpacity: string | number
ngAcceptInputType_actualDashArray: string | number[]
ngAcceptInputType_actualDashCap: string | PenLineCap
ngAcceptInputType_actualFocusMode: string | SeriesSelectionMode
ngAcceptInputType_actualHighlightedValuesFadeOpacity: string | number
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_actualLayers: string | IgxSeriesLayerCollection
ngAcceptInputType_actualMarkerFillOpacity: string | number
ngAcceptInputType_actualResolution: string | number
ngAcceptInputType_actualSelectionMode: string | SeriesSelectionMode
ngAcceptInputType_actualShiftAmount: string | number
ngAcceptInputType_actualThickness: string | number
ngAcceptInputType_actualVerticalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_actualVerticalDashArray: string | number[]
ngAcceptInputType_actualVerticalShiftAmount: string | number
ngAcceptInputType_annotationBackgroundMatchLayer: string | boolean
ngAcceptInputType_annotationBackgroundMode: string | AnnotationAppearanceMode
ngAcceptInputType_annotationBackgroundShift: string | number
ngAcceptInputType_annotationBorderMatchLayer: string | boolean
ngAcceptInputType_annotationBorderMode: string | AnnotationAppearanceMode
ngAcceptInputType_annotationBorderRadius: string | number
ngAcceptInputType_annotationBorderShift: string | number
ngAcceptInputType_annotationBorderThickness: string | number
ngAcceptInputType_annotationLabelDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_annotationLabelVisible: string | boolean
ngAcceptInputType_annotationPaddingBottom: string | number
ngAcceptInputType_annotationPaddingLeft: string | number
ngAcceptInputType_annotationPaddingRight: string | number
ngAcceptInputType_annotationPaddingTop: string | number
ngAcceptInputType_annotationShapeVisible: string | boolean
ngAcceptInputType_annotationTextColorMatchLayer: string | boolean
ngAcceptInputType_annotationTextColorMode: string | AnnotationAppearanceMode
ngAcceptInputType_annotationTextColorShift: string | number
ngAcceptInputType_annotationValueMaxPrecision: string | number
ngAcceptInputType_annotationValueMinPrecision: string | number
ngAcceptInputType_appearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_areaFillOpacity: string | number
ngAcceptInputType_attachTooltipToRoot: string | boolean
ngAcceptInputType_autoCalloutLabelFormatSpecifiers: string | any[]
ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers: string | any[]
ngAcceptInputType_centerLabelXDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_centerLabelYDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_cursorPosition: string | IgPoint
ngAcceptInputType_dashArray: string | number[]
ngAcceptInputType_endLabelXDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_endLabelYDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_expectFunctions: string | boolean
ngAcceptInputType_finalValue: string | number
ngAcceptInputType_hasMarkers: string | boolean
ngAcceptInputType_hasOnlyMarkers: string | boolean
ngAcceptInputType_hasValueAxis: string | boolean
ngAcceptInputType_hasVisibleMarkers: string | boolean
ngAcceptInputType_highlightedLegendItemVisibility: string | Visibility
ngAcceptInputType_highlightedValuesDisplayMode: string | SeriesHighlightedValuesDisplayMode
ngAcceptInputType_highlightedValuesExtraPropertyOverlays: string | IgxSeriesLayerPropertyOverlayCollection
ngAcceptInputType_highlightedValuesFadeOpacity: string | number
ngAcceptInputType_highlightingFadeOpacity: string | number
ngAcceptInputType_hitTestMode: string | SeriesHitTestMode
ngAcceptInputType_horizontalAppearanceMode: string | AnnotationAppearanceMode
ngAcceptInputType_horizontalDashArray: string | number[]
ngAcceptInputType_horizontalShiftAmount: string | number
ngAcceptInputType_index: string | number
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_isColoredItemwise: 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_isHighlightOverlay: string | boolean
ngAcceptInputType_isHighlightingEnabled: string | boolean
ngAcceptInputType_isIndexed: string | boolean
ngAcceptInputType_isLayer: 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_isSummarizationSupported: string | boolean
ngAcceptInputType_isTargetingHorizontalAxis: 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_itemsUseWorldCoordinates: string | boolean
ngAcceptInputType_layers: string | IgxSeriesLayerCollection
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_overlayTextAngle: string | number
ngAcceptInputType_overlayTextBackgroundMatchLayer: string | boolean
ngAcceptInputType_overlayTextBackgroundMode: string | AnnotationAppearanceMode
ngAcceptInputType_overlayTextBackgroundShift: string | number
ngAcceptInputType_overlayTextBorderMatchLayer: string | boolean
ngAcceptInputType_overlayTextBorderMode: string | AnnotationAppearanceMode
ngAcceptInputType_overlayTextBorderRadius: string | number
ngAcceptInputType_overlayTextBorderShift: string | number
ngAcceptInputType_overlayTextBorderThickness: string | number
ngAcceptInputType_overlayTextColorMatchLayer: string | boolean
ngAcceptInputType_overlayTextColorMode: string | AnnotationAppearanceMode
ngAcceptInputType_overlayTextColorShift: string | number
ngAcceptInputType_overlayTextHorizontalMargin: string | number
ngAcceptInputType_overlayTextHorizontalPadding: string | number
ngAcceptInputType_overlayTextLocation: string | OverlayTextLocation
ngAcceptInputType_overlayTextVerticalMargin: string | number
ngAcceptInputType_overlayTextVerticalPadding: string | number
ngAcceptInputType_overlayTextVisible: string | boolean
ngAcceptInputType_percentChange: string | number
ngAcceptInputType_resolution: string | number
ngAcceptInputType_selectionThickness: string | number
ngAcceptInputType_shadowBlur: string | number
ngAcceptInputType_shadowOffsetX: string | number
ngAcceptInputType_shadowOffsetY: string | number
ngAcceptInputType_shiftAmount: string | number
ngAcceptInputType_shouldAnimateOnDataSourceSwap: string | boolean
ngAcceptInputType_shouldHideAutoCallouts: string | boolean
ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden: string | boolean
ngAcceptInputType_shouldRenderAsOverlay: string | boolean
ngAcceptInputType_shouldShiftOpacityForSafeActualBrush: string | boolean
ngAcceptInputType_showDefaultTooltip: string | boolean
ngAcceptInputType_startLabelXDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_startLabelYDisplayMode: string | DataAnnotationDisplayMode
ngAcceptInputType_targetMode: string | DataAnnotationTargetMode
ngAcceptInputType_thickness: string | number
ngAcceptInputType_transitionDuration: string | number
ngAcceptInputType_transitionInDuration: string | number
ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType
ngAcceptInputType_transitionOutDuration: string | number
ngAcceptInputType_transitionOutSpeedType: string | TransitionOutSpeedType
ngAcceptInputType_useIndex: string | boolean
ngAcceptInputType_useItemWiseColors: string | boolean
ngAcceptInputType_useLegend: string | boolean
ngAcceptInputType_useSingleShadow: 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 actualDashArray(): number[]
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

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

    • v: number[]

    Returns void

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

    Returns PenLineCap

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

    Returns void

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

    Returns string

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

    • v: string

    Returns void

  • get actualFocusMode(): SeriesSelectionMode
  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualFocusMode(v: SeriesSelectionMode): void
  • Parameters

    Returns void

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

    Returns string

  • get actualHighlightedValuesFadeOpacity(): number
  • Gets actual HighlightedValues fade opacity

    Returns number

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

    • v: number

    Returns void

  • 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 actualLayers(): IgxSeriesLayerCollection
  • Gets the actual extra layers for the series.

    Returns IgxSeriesLayerCollection

  • set actualLayers(v: IgxSeriesLayerCollection): void
  • Parameters

    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 actualSelectionBrush(): string
  • Gets the effective emphasis brush for the current series object.

    Returns string

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

    • v: string

    Returns void

  • get actualSelectionMode(): SeriesSelectionMode
  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualSelectionMode(v: SeriesSelectionMode): void
  • Parameters

    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 annotationBackground(): string
  • Gets or sets the color used for backing of the axis annotation.

    Returns string

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

    • v: string

    Returns void

  • get annotationBackgroundMatchLayer(): boolean
  • Gets or sets whether the annotation background matches brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get annotationBackgroundMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the background of axis annotation.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get annotationBackgroundShift(): number
  • Gets or sets the percentage used to shift AnnotationBackground. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get annotationBorderColor(): string
  • Gets or sets the color used for border color of the axis annotation.

    Returns string

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

    • v: string

    Returns void

  • get annotationBorderMatchLayer(): boolean
  • Gets or sets whether the annotation border matches outline of the layer (if it has a fill visual) otherwise brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get annotationBorderMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting border color of the axis annotation.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get annotationBorderRadius(): number
  • Gets or sets the border radius used for displaying the axis annotation.

    Returns number

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

    • v: number

    Returns void

  • get annotationBorderShift(): number
  • Gets or sets the percentage amount used to shift AnnotationBorderColor. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get annotationBorderThickness(): number
  • Gets or sets border thickness of the axis annotations.

    Returns number

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

    • v: number

    Returns void

  • get annotationLabelDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label on axis annotation.

    Returns DataAnnotationDisplayMode

  • set annotationLabelDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get annotationLabelVisible(): boolean
  • Gets or sets whether to show all annotations over target axis

    Returns boolean

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

    • v: boolean

    Returns void

  • get annotationPaddingBottom(): number
  • Returns number

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

    • v: number

    Returns void

  • get annotationPaddingLeft(): number
  • Returns number

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

    • v: number

    Returns void

  • get annotationPaddingRight(): number
  • Returns number

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

    • v: number

    Returns void

  • get annotationPaddingTop(): number
  • Returns number

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

    • v: number

    Returns void

  • get annotationShapeVisible(): boolean
  • Gets or sets whether to draw shape of annotations in the plot area

    Returns boolean

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

    • v: boolean

    Returns void

  • get annotationTextColor(): string
  • Gets or sets the text color used in the axis annotation.

    Returns string

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

    • v: string

    Returns void

  • get annotationTextColorMatchLayer(): boolean
  • Gets or sets whether the annotation text color matches brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get annotationTextColorMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the text color in axis annotation.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get annotationTextColorShift(): number
  • Gets or sets the percentage used to shift AnnotationTextColor. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get annotationValueMaxPrecision(): number
  • Gets or sets maximum precision for displaying values on axis annotation.

    Returns number

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

    • v: number

    Returns void

  • get annotationValueMinPrecision(): number
  • Gets or sets minimum precision for displaying values on axis annotation.

    Returns number

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

    • v: number

    Returns void

  • 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 attachTooltipToRoot(): boolean
  • Gets or sets whether the tooltip will be attached to the root, when set to false it will be a child of the chart.

    Returns boolean

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

    • v: boolean

    Returns void

  • get autoCalloutLabelFormat(): string
  • Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

    Returns string

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

    • v: string

    Returns void

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

    Returns any[]

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

    • v: any[]

    Returns void

  • get autoCalloutValueLabelFormat(): string
  • Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

    Returns string

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

    • v: string

    Returns void

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

    Returns any[]

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

    • v: any[]

    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 centerLabelBackground(): string
  • Gets or sets the background used for displaying the center annotation label.

    Returns string

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

    • v: string

    Returns void

  • get centerLabelBorderColor(): string
  • Gets or sets the border color used for displaying the center annotation label.

    Returns string

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

    • v: string

    Returns void

  • get centerLabelTextColor(): string
  • Gets or sets the text color used for displaying the center annotation label.

    Returns string

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

    • v: string

    Returns void

  • get centerLabelXDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label in the center annotation on x-axis.

    Returns DataAnnotationDisplayMode

  • set centerLabelXDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get centerLabelXMemberPath(): string
  • Gets or sets mapping custom label between start and end of data annotations on x-axis.

    Returns string

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

    • v: string

    Returns void

  • get centerLabelYDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of content in the center annotation on y-axis.

    Returns DataAnnotationDisplayMode

  • set centerLabelYDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get centerLabelYMemberPath(): string
  • Gets or sets mapping custom label between start and end of data annotations on y-axis.

    Returns string

  • set centerLabelYMemberPath(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 dataLegendGroup(): string
  • 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

    Returns string

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

    • v: string

    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 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 endLabelBackground(): string
  • Gets or sets the background used for displaying the end annotation label.

    Returns string

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

    • v: string

    Returns void

  • get endLabelBorderColor(): string
  • Gets or sets the border used for displaying the end annotation label.

    Returns string

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

    • v: string

    Returns void

  • get endLabelTextColor(): string
  • Gets or sets the text color used for displaying the end annotation label.

    Returns string

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

    • v: string

    Returns void

  • get endLabelXDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label at the end annotation on x-axis.

    Returns DataAnnotationDisplayMode

  • set endLabelXDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get endLabelXMemberPath(): string
  • Gets or sets mapping custom label at the end of annotations on x-axis.

    Returns string

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

    • v: string

    Returns void

  • get endLabelYDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label at the end annotation on y-axis.

    Returns DataAnnotationDisplayMode

  • set endLabelYDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get endLabelYMemberPath(): string
  • Gets or sets mapping custom label at the end of annotations on y-axis.

    Returns string

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

    • v: string

    Returns void

  • get endValueXMemberPath(): string
  • Gets or sets name of data column with x-positions for end of annotation.

    Returns string

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

    • v: string

    Returns void

  • get endValueYMemberPath(): string
  • Gets or sets name of data column with y-positions for end of annotation.

    Returns string

  • set endValueYMemberPath(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 focusBrush(): string
  • Gets or sets the Focus brush to use for the series.

    Returns string

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

    • v: string

    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 hasVisibleMarkers(): boolean
  • Returns whether the current series has a visible marker style.

    Returns boolean

  • get highlightedDataSource(): any
  • Returns any

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

    • value: any

    Returns void

  • get highlightedLegendItemVisibility(): Visibility
  • Gets or sets whether the highlighted values layer should have a legend item.

    Returns Visibility

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

    Returns void

  • get highlightedTitleSuffix(): string
  • Gets or sets the HighlightedTitleSuffix property.

    Returns string

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

    • v: string

    Returns void

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

    Returns string

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

    • v: string

    Returns void

  • get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode
  • 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.

    Returns SeriesHighlightedValuesDisplayMode

  • set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void
  • Parameters

    Returns void

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

    Returns number

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

    • v: number

    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 index(): number
  • Gets the Index property.

    Returns number

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

    • v: number

    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. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

    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 isColoredItemwise(): boolean
  • 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 behavior should be disabled if this series is present.

     let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;
    

    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 isHighlightOverlay(): boolean
  • Gets whether the series is a highlight overlay.

    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 isLayer(): boolean
  • 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 isSummarizationSupported(): boolean
  • Gets whether the series supports summarization in Data Legend and Data Tooltip.

    Returns boolean

  • get isTargetingHorizontalAxis(): boolean
  • Gets whether the annotation layer is currently targeting horizontal axis.

    Returns boolean

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

    • v: boolean

    Returns void

  • 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 itemsUseWorldCoordinates(): boolean
  • Gets or sets whether the data items of the annotations use world coordinates (0.0 - 1.0) or they default to using axes coordinates (data indexes for category axis or data values for numeric axis).

    Returns boolean

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

    • v: boolean

    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 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.

    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 overlayText(): string
  • Gets or sets the text that will be displayed as the overlay annotation.

    Returns string

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

    • v: string

    Returns void

  • get overlayTextAngle(): number
  • Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextBackground(): string
  • Gets or sets the background the overlay text.

    Returns string

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

    • v: string

    Returns void

  • get overlayTextBackgroundMatchLayer(): boolean
  • Gets or sets whether the overlay text background matches brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get overlayTextBackgroundMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the background of overlay text based on the target series.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get overlayTextBackgroundShift(): number
  • Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextBorderColor(): string
  • Gets or sets the border stroke of the overlay text.

    Returns string

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

    • v: string

    Returns void

  • get overlayTextBorderMatchLayer(): boolean
  • Gets or sets whether the overlay text border matches brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get overlayTextBorderMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the border of overlay text based on the target series.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get overlayTextBorderRadius(): number
  • Gets or sets the border corner of the overlay text.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextBorderShift(): number
  • Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextBorderThickness(): number
  • Gets or sets the border thickness of the overlay text.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextColor(): string
  • Gets or sets the color the overlay text.

    Returns string

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

    • v: string

    Returns void

  • get overlayTextColorMatchLayer(): boolean
  • Gets or sets whether the overlay text color matches brush of the layer

    Returns boolean

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

    • v: boolean

    Returns void

  • get overlayTextColorMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the background of overlay text based on the target series.

    Returns AnnotationAppearanceMode

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

    Returns void

  • get overlayTextColorShift(): number
  • Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextHorizontalMargin(): number
  • Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextHorizontalPadding(): number
  • Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextLocation(): OverlayTextLocation
  • Gets or sets location of the overlay text in relation to shape of data annotation.

    Returns OverlayTextLocation

  • set overlayTextLocation(v: OverlayTextLocation): void
  • Parameters

    Returns void

  • get overlayTextMemberPath(): string
  • Gets or sets name of data column with text that will be displayed as overlay text.

    Returns string

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

    • v: string

    Returns void

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

    Returns string

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

    • v: string

    Returns void

  • get overlayTextVerticalMargin(): number
  • Gets or sets the vertical margin of the overlay text in relation to shape of data annotation.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextVerticalPadding(): number
  • Gets or sets the vertical padding of the overlay text in relation to shape of data annotation.

    Returns number

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

    • v: number

    Returns void

  • get overlayTextVisible(): boolean
  • Gets or sets whether the overlay text is visible in shape of data annotation

    Returns boolean

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

    • v: boolean

    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 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 safeActualBrush(): string
  • Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

    Returns string

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

    • v: string

    Returns void

  • get selectionBrush(): string
  • Gets or sets the selection brush to use for the series.

    Returns string

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

    • v: string

    Returns void

  • get selectionThickness(): number
  • Gets or sets the width of the current series object's line thickness when the series is selected.

    Returns number

  • set selectionThickness(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 shouldAnimateOnDataSourceSwap(): boolean
  • 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.

    Returns boolean

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

    • v: boolean

    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 shouldRemoveHighlightedDataOnLayerHidden(): boolean
  • Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

    Returns boolean

  • set shouldRemoveHighlightedDataOnLayerHidden(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 shouldShiftOpacityForSafeActualBrush(): boolean
  • Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

    Returns boolean

  • set shouldShiftOpacityForSafeActualBrush(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 startLabelBackground(): string
  • Gets or sets the background used for displaying the start annotation label.

    Returns string

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

    • v: string

    Returns void

  • get startLabelBorderColor(): string
  • Gets or sets the border color used for displaying Start annotation label.

    Returns string

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

    • v: string

    Returns void

  • get startLabelTextColor(): string
  • Gets or sets the text color used for displaying the start annotation label.

    Returns string

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

    • v: string

    Returns void

  • get startLabelXDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label in the start annotation on x-axis.

    Returns DataAnnotationDisplayMode

  • set startLabelXDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get startLabelXMemberPath(): string
  • Gets or sets mapping custom label at the start of annotations on x-axis.

    Returns string

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

    • v: string

    Returns void

  • get startLabelYDisplayMode(): DataAnnotationDisplayMode
  • Gets or sets display mode of label in the start annotation on y-axis.

    Returns DataAnnotationDisplayMode

  • set startLabelYDisplayMode(v: DataAnnotationDisplayMode): void
  • Parameters

    Returns void

  • get startLabelYMemberPath(): string
  • Gets or sets mapping custom label at the start of annotations on y-axis.

    Returns string

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

    • v: string

    Returns void

  • get startValueXMemberPath(): string
  • Gets or sets name of data column with x-positions for the start of annotations.

    Returns string

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

    • v: string

    Returns void

  • get startValueYMemberPath(): string
  • Gets or sets name of data column with y-positions for the start of annotations.

    Returns string

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

    • v: string

    Returns void

  • get stylingAxisAnnotation(): EventEmitter<{
        args: IgxDataAnnotationInfo;
        sender: any;
    }>
  • Event raised when updating style of annotation

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

  • get stylingOverlayText(): EventEmitter<{
        args: IgxOverlayTextUpdatingEventArgs;
        sender: any;
    }>
  • Event raised when updating style of overlay text

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

  • get stylingShapeAnnotation(): EventEmitter<{
        args: IgxDataAnnotationItem;
        sender: any;
    }>
  • Event raised when updating style of annotation

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

  • get targetAxis(): IgxAxisComponent
  • Gets or sets the target axis for this annotation. If null, this annotation will use TargetMode to determine target axis.

    Returns IgxAxisComponent

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

    Returns void

  • get targetMode(): DataAnnotationTargetMode
  • Gets or sets the mode for targeting axes present in the chart. Defaults to targeting all category-axes present in the chart

    Returns DataAnnotationTargetMode

  • set targetMode(v: DataAnnotationTargetMode): 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 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' 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' 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' 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 transitionOutCompleted(): EventEmitter<{
        args: IgxTransitionOutCompletedEventArgs;
        sender: any;
    }>
  • Fired when a transition out has completed.

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

  • get transitionOutDuration(): number
  • Gets or sets the duration of the current series' transition out morph.

    Returns number

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

    • v: number

    Returns void

  • get transitionOutEasingFunction(): ((time: number) => number)
  • Gets or sets the EasingFunction used to morph the current series during the initial transition.

    Returns ((time: number) => number)

      • (time: number): number
      • Gets or sets the EasingFunction used to morph the current series during the initial transition.

        Parameters

        • time: number

        Returns number

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

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

          • time: number

          Returns number

    Returns void

  • get transitionOutSpeedType(): TransitionOutSpeedType
  • Gets or sets the duration of the current series' transition out morph.

    Returns TransitionOutSpeedType

  • set transitionOutSpeedType(v: TransitionOutSpeedType): void
  • Parameters

    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 useItemWiseColors(): boolean
  • Gets or sets whether the series should use individual palette colors for each item.

    Returns boolean

  • set useItemWiseColors(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 verticalAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

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

    Returns void

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

    Returns number[]

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

    • v: number[]

    Returns void

  • get verticalShiftAmount(): 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 verticalShiftAmount(v: number): void
  • Parameters

    • v: number

    Returns void

  • get visibility(): Visibility
  • Returns Visibility

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

    Returns void

  • get visibleRangeMarginBottom(): number
  • Gets or sets the bottom margin to use when getting a visible axis range for the series.

    Returns number

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

    • v: number

    Returns void

  • get visibleRangeMarginLeft(): number
  • Gets or sets the left margin to use when getting a visible axis range for the series.

    Returns number

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

    • v: number

    Returns void

  • get visibleRangeMarginRight(): number
  • Gets or sets the right margin to use when getting a visible axis range for the series.

    Returns number

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

    • v: number

    Returns void

  • get visibleRangeMarginTop(): number
  • Gets or sets the top margin to use when getting a visible axis range for the series.

    Returns number

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

    • v: number

    Returns void

  • get visibleRangeMode(): SeriesVisibleRangeMode
  • Gets or sets the visible range mode to use.

    Returns SeriesVisibleRangeMode

  • set visibleRangeMode(v: SeriesVisibleRangeMode): void
  • Parameters

    Returns void

Methods

  • Converts a point from world coordinates to coordinates within the viewport of the series.

    Parameters

    • world: IgPoint
      • The world position from which to convert.
      let pt: IgxPoint = this.series.fromWorldPosition({x:.5,y:.5});
      

    Returns IgPoint

  • Converts world X coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's width

    Parameters

    • x: number

    Returns number

  • Converts world Y coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's height

    Parameters

    • y: number

    Returns number

  • 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.

    Parameters

    • world: IgPoint
      • The world position for which to return the index.
      let index: number = this.series.getExactItemIndex({x:.5,y:.5});
      

    Returns number

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

    Parameters

    • world: IgPoint
      • The world coordinates to use.
      let item: number = this.series.getItem({x:.5,y:.5});
      

    Returns any

  • Gets the item index associated with the specified world position

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

    Parameters

    Returns number

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

    Returns number

  • Parameters

    • item: any
    • memberPathName: string

    Returns any

  • Gets the value of a requested member path from the series.

    Parameters

    • memberPathName: string
      • The property name of a valid member path for the series

    Returns string

  • If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

    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

  • 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.

    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

  • 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.

    Parameters

    Returns number[]

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

    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

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

    Returns void

  • Removes an alternate view of this series.

    Parameters

    • viewIdentifier: string
      • The string identifier for the view to remove.

    Returns void

  • Renders the series.

    Parameters

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

    Returns void

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

    Parameters

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

    Returns boolean

  • Parameters

    • negativeBrush: string
    • negativeOutline: string

    Returns void

  • Simulates a pointer hover over the series surface.

    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

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

    Parameters

    • seriesPoint: IgPoint
      • The pixel location within the plot area of the series.
      this.series.toWorldPosition({x:500,y:500});
      

    Returns IgPoint

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

    Parameters

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

    Returns IgRect

  • Converts pixel X coordinate (relative to component's width) to world coordinate (0.0 - 1.0)

    Parameters

    • x: number

    Returns number

  • Converts pixel Y coordinate (relative to component's height) to world coordinate (0.0 - 1.0)

    Parameters

    • y: number

    Returns number