IgxSeriesComponent

Represents the base class for all IgxDataChartComponent series.

Constructors

new IgxSeriesComponent(): IgxSeriesComponent

Returns IgxSeriesComponent

Properties

ngAcceptInputType_actualAreaFillOpacity

ngAcceptInputType_actualAreaFillOpacity: string | number

ngAcceptInputType_actualFocusMode

ngAcceptInputType_actualFocusMode: string | SeriesSelectionMode

ngAcceptInputType_actualHighlightedValuesFadeOpacity

ngAcceptInputType_actualHighlightedValuesFadeOpacity: string | number

ngAcceptInputType_actualHighlightingFadeOpacity

ngAcceptInputType_actualHighlightingFadeOpacity: string | number

ngAcceptInputType_actualHighlightingMode

ngAcceptInputType_actualHighlightingMode: string | SeriesHighlightingMode

ngAcceptInputType_actualHitTestMode

ngAcceptInputType_actualHitTestMode: string | SeriesHitTestMode

ngAcceptInputType_actualLayers

ngAcceptInputType_actualLayers: string | IgxSeriesLayerCollection

ngAcceptInputType_actualMarkerFillOpacity

ngAcceptInputType_actualMarkerFillOpacity: string | number

ngAcceptInputType_actualResolution

ngAcceptInputType_actualResolution: string | number

ngAcceptInputType_actualSelectionMode

ngAcceptInputType_actualSelectionMode: string | SeriesSelectionMode

ngAcceptInputType_actualThickness

ngAcceptInputType_actualThickness: string | number

ngAcceptInputType_areaFillOpacity

ngAcceptInputType_areaFillOpacity: string | number

ngAcceptInputType_attachTooltipToRoot

ngAcceptInputType_attachTooltipToRoot: string | boolean

ngAcceptInputType_autoCalloutLabelFormatSpecifiers

ngAcceptInputType_autoCalloutLabelFormatSpecifiers: string | any[]

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers

ngAcceptInputType_autoCalloutValueLabelFormatSpecifiers: string | any[]

ngAcceptInputType_dashArray

ngAcceptInputType_dashArray: string | number[]

ngAcceptInputType_expectFunctions

ngAcceptInputType_expectFunctions: string | boolean

ngAcceptInputType_finalValue

ngAcceptInputType_finalValue: string | number

ngAcceptInputType_hasMarkers

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_hasOnlyMarkers

ngAcceptInputType_hasOnlyMarkers: string | boolean

ngAcceptInputType_hasValueAxis

ngAcceptInputType_hasValueAxis: string | boolean

ngAcceptInputType_hasVisibleMarkers

ngAcceptInputType_hasVisibleMarkers: string | boolean

ngAcceptInputType_highlightedLegendItemVisibility

ngAcceptInputType_highlightedLegendItemVisibility: any

ngAcceptInputType_highlightedValuesDisplayMode

ngAcceptInputType_highlightedValuesDisplayMode: any

ngAcceptInputType_highlightedValuesExtraPropertyOverlays

ngAcceptInputType_highlightedValuesExtraPropertyOverlays: string | IgxSeriesLayerPropertyOverlayCollection

ngAcceptInputType_highlightedValuesFadeOpacity

ngAcceptInputType_highlightedValuesFadeOpacity: string | number

ngAcceptInputType_highlightingFadeOpacity

ngAcceptInputType_highlightingFadeOpacity: string | number

ngAcceptInputType_hitTestMode

ngAcceptInputType_hitTestMode: string | SeriesHitTestMode

ngAcceptInputType_index

ngAcceptInputType_index: string | number

ngAcceptInputType_isActualLegendFinancial

ngAcceptInputType_isActualLegendFinancial: string | boolean

ngAcceptInputType_isAnnotationCalloutLayer

ngAcceptInputType_isAnnotationCalloutLayer: string | boolean

ngAcceptInputType_isAnnotationCrosshairLayer

ngAcceptInputType_isAnnotationCrosshairLayer: string | boolean

ngAcceptInputType_isAnnotationDataLayer

ngAcceptInputType_isAnnotationDataLayer: string | boolean

ngAcceptInputType_isAnnotationFinalValue

ngAcceptInputType_isAnnotationFinalValue: string | boolean

ngAcceptInputType_isAnnotationHoverLayer

ngAcceptInputType_isAnnotationHoverLayer: string | boolean

ngAcceptInputType_isAnnotationLayer

ngAcceptInputType_isAnnotationLayer: string | boolean

ngAcceptInputType_isAnnotationValueLayer

ngAcceptInputType_isAnnotationValueLayer: string | boolean

ngAcceptInputType_isArea

ngAcceptInputType_isArea: string | boolean

ngAcceptInputType_isAreaOrLine

ngAcceptInputType_isAreaOrLine: string | boolean

ngAcceptInputType_isBar

ngAcceptInputType_isBar: string | boolean

ngAcceptInputType_isCategory

ngAcceptInputType_isCategory: string | boolean

ngAcceptInputType_isColoredItemwise

ngAcceptInputType_isColoredItemwise: string | boolean

ngAcceptInputType_isColumn

ngAcceptInputType_isColumn: string | boolean

ngAcceptInputType_isComponentHighlightingModeIgnored

ngAcceptInputType_isComponentHighlightingModeIgnored: string | boolean

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled

ngAcceptInputType_isDefaultCrosshairBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultTooltipBehaviorDisabled

ngAcceptInputType_isDefaultTooltipBehaviorDisabled: string | boolean

ngAcceptInputType_isDefaultToolTipSelected

ngAcceptInputType_isDefaultToolTipSelected: string | boolean

ngAcceptInputType_isDropShadowEnabled

ngAcceptInputType_isDropShadowEnabled: string | boolean

ngAcceptInputType_isFinancial

ngAcceptInputType_isFinancial: string | boolean

ngAcceptInputType_isFinancialIndicator

ngAcceptInputType_isFinancialIndicator: string | boolean

ngAcceptInputType_isFinancialOverlay

ngAcceptInputType_isFinancialOverlay: string | boolean

ngAcceptInputType_isFinancialSeries

ngAcceptInputType_isFinancialSeries: string | boolean

ngAcceptInputType_isFinancialWaterfall

ngAcceptInputType_isFinancialWaterfall: string | boolean

ngAcceptInputType_isFragment

ngAcceptInputType_isFragment: string | boolean

ngAcceptInputType_isGeographic

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_isHighlightingEnabled

ngAcceptInputType_isHighlightingEnabled: string | boolean

ngAcceptInputType_isHighlightOverlay

ngAcceptInputType_isHighlightOverlay: string | boolean

ngAcceptInputType_isIndexed

ngAcceptInputType_isIndexed: string | boolean

ngAcceptInputType_isLayer

ngAcceptInputType_isLayer: string | boolean

ngAcceptInputType_isLineContour

ngAcceptInputType_isLineContour: string | boolean

ngAcceptInputType_isLineOnly

ngAcceptInputType_isLineOnly: string | boolean

ngAcceptInputType_isMarkerlessDisplayPreferred

ngAcceptInputType_isMarkerlessDisplayPreferred: string | boolean

ngAcceptInputType_isNegativeColorSupported

ngAcceptInputType_isNegativeColorSupported: string | boolean

ngAcceptInputType_isPie

ngAcceptInputType_isPie: string | boolean

ngAcceptInputType_isPixel

ngAcceptInputType_isPixel: string | boolean

ngAcceptInputType_isPolar

ngAcceptInputType_isPolar: string | boolean

ngAcceptInputType_isPolygon

ngAcceptInputType_isPolygon: string | boolean

ngAcceptInputType_isPolyline

ngAcceptInputType_isPolyline: string | boolean

ngAcceptInputType_isRadial

ngAcceptInputType_isRadial: string | boolean

ngAcceptInputType_isRange

ngAcceptInputType_isRange: string | boolean

ngAcceptInputType_isScatter

ngAcceptInputType_isScatter: string | boolean

ngAcceptInputType_isShape

ngAcceptInputType_isShape: string | boolean

ngAcceptInputType_isShapeControl

ngAcceptInputType_isShapeControl: string | boolean

ngAcceptInputType_isSpline

ngAcceptInputType_isSpline: string | boolean

ngAcceptInputType_isStacked

ngAcceptInputType_isStacked: string | boolean

ngAcceptInputType_isStep

ngAcceptInputType_isStep: string | boolean

ngAcceptInputType_isSummarizationSupported

ngAcceptInputType_isSummarizationSupported: string | boolean

ngAcceptInputType_isTile

ngAcceptInputType_isTile: string | boolean

ngAcceptInputType_isToolTipLayer

ngAcceptInputType_isToolTipLayer: string | boolean

ngAcceptInputType_isUsableInLegend

ngAcceptInputType_isUsableInLegend: string | boolean

ngAcceptInputType_isUserAnnotationLayer

ngAcceptInputType_isUserAnnotationLayer: string | boolean

ngAcceptInputType_isUserAnnotationToolTipLayer

ngAcceptInputType_isUserAnnotationToolTipLayer: string | boolean

ngAcceptInputType_isValueAxisInverted

ngAcceptInputType_isValueAxisInverted: string | boolean

ngAcceptInputType_isValueOverlay

ngAcceptInputType_isValueOverlay: string | boolean

ngAcceptInputType_isVertical

ngAcceptInputType_isVertical: string | boolean

ngAcceptInputType_isWaterfall

ngAcceptInputType_isWaterfall: string | boolean

ngAcceptInputType_layers

ngAcceptInputType_layers: string | IgxSeriesLayerCollection

ngAcceptInputType_legendItemBadgeMode

ngAcceptInputType_legendItemBadgeMode: any

ngAcceptInputType_legendItemBadgeShape

ngAcceptInputType_legendItemBadgeShape: any

ngAcceptInputType_legendItemVisibility

ngAcceptInputType_legendItemVisibility: any

ngAcceptInputType_lineCap

ngAcceptInputType_lineCap: any

ngAcceptInputType_lineJoin

ngAcceptInputType_lineJoin: any

ngAcceptInputType_markerFillOpacity

ngAcceptInputType_markerFillOpacity: string | number

ngAcceptInputType_mouseOverEnabled

ngAcceptInputType_mouseOverEnabled: string | boolean

ngAcceptInputType_opacity

ngAcceptInputType_opacity: string | number

ngAcceptInputType_outlineMode

ngAcceptInputType_outlineMode: string | SeriesOutlineMode

ngAcceptInputType_percentChange

ngAcceptInputType_percentChange: string | number

ngAcceptInputType_resolution

ngAcceptInputType_resolution: string | number

ngAcceptInputType_selectionThickness

ngAcceptInputType_selectionThickness: string | number

ngAcceptInputType_shadowBlur

ngAcceptInputType_shadowBlur: string | number

ngAcceptInputType_shadowOffsetX

ngAcceptInputType_shadowOffsetX: string | number

ngAcceptInputType_shadowOffsetY

ngAcceptInputType_shadowOffsetY: string | number

ngAcceptInputType_shouldAnimateOnDataSourceSwap

ngAcceptInputType_shouldAnimateOnDataSourceSwap: string | boolean

ngAcceptInputType_shouldHideAutoCallouts

ngAcceptInputType_shouldHideAutoCallouts: string | boolean

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden

ngAcceptInputType_shouldRemoveHighlightedDataOnLayerHidden: string | boolean

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush

ngAcceptInputType_shouldShiftOpacityForSafeActualBrush: string | boolean

ngAcceptInputType_showDefaultTooltip

ngAcceptInputType_showDefaultTooltip: string | boolean

ngAcceptInputType_thickness

ngAcceptInputType_thickness: string | number

ngAcceptInputType_transitionDuration

ngAcceptInputType_transitionDuration: string | number

ngAcceptInputType_transitionInDuration

ngAcceptInputType_transitionInDuration: string | number

ngAcceptInputType_transitionInSpeedType

ngAcceptInputType_transitionInSpeedType: string | TransitionInSpeedType

ngAcceptInputType_transitionOutDuration

ngAcceptInputType_transitionOutDuration: string | number

ngAcceptInputType_transitionOutSpeedType

ngAcceptInputType_transitionOutSpeedType: string | TransitionOutSpeedType

ngAcceptInputType_useItemWiseColors

ngAcceptInputType_useItemWiseColors: string | boolean

ngAcceptInputType_useSingleShadow

ngAcceptInputType_useSingleShadow: string | boolean

ngAcceptInputType_visibility

ngAcceptInputType_visibility: any

ngAcceptInputType_visibleRangeMarginBottom

ngAcceptInputType_visibleRangeMarginBottom: string | number

ngAcceptInputType_visibleRangeMarginLeft

ngAcceptInputType_visibleRangeMarginLeft: string | number

ngAcceptInputType_visibleRangeMarginRight

ngAcceptInputType_visibleRangeMarginRight: string | number

ngAcceptInputType_visibleRangeMarginTop

ngAcceptInputType_visibleRangeMarginTop: string | number

ngAcceptInputType_visibleRangeMode

ngAcceptInputType_visibleRangeMode: string | SeriesVisibleRangeMode

ɵcmp

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

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxSeriesComponent, never>

actualAreaFillOpacity

actualAreaFillOpacity: number

actualBrush

actualBrush: string

actualFocusBrush

actualFocusBrush: string

actualFocusMode

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

actualHighlightingFadeOpacity: number

actualHighlightingMode

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

actualHitTestMode: SeriesHitTestMode

actualLayers

actualLayers: IgxSeriesLayerCollection

actualLegendItemBadgeBrush

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

actualMarkerFillOpacity: number

actualOutline

actualOutline: string

actualResolution

actualResolution: number

actualSelectionBrush

actualSelectionBrush: string

actualSelectionMode

actualSelectionMode: SeriesSelectionMode

actualThickness

actualThickness: number

areaFillOpacity

areaFillOpacity: number

attachTooltipToRoot

attachTooltipToRoot: boolean

autoCalloutLabelFormat

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

autoCalloutValueLabelFormatSpecifiers: any[]

brush

brush: string

coercionMethods

coercionMethods: any

dashArray

dashArray: number[]

dataLegendGroup

dataLegendGroup: string

dataSource

dataSource: any

discreteLegendItemTemplate

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

expectFunctions: boolean

finalValue

finalValue: number

focusBrush

focusBrush: string

highlightedDataSource

highlightedDataSource: any

highlightedLegendItemVisibility

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

highlightedValuesExtraPropertyOverlays: IgxSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

highlightingFadeOpacity: number

hitTestMode

hitTestMode: SeriesHitTestMode

index

index: number

isActualLegendFinancial

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

isComponentHighlightingModeIgnored: boolean

isDefaultToolTipSelected

isDefaultToolTipSelected: boolean

isDropShadowEnabled

isDropShadowEnabled: boolean

isHighlightingEnabled

isHighlightingEnabled: boolean

layers

layers: IgxSeriesLayerCollection

legend

legend: any

legendItemBadgeMode

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

legendItemTemplate: IgDataTemplate

legendItemVisibility

legendItemVisibility: Visibility

lineCap

lineCap: PenLineCap

lineJoin

lineJoin: PenLineJoin

markerFillOpacity

markerFillOpacity: number

mouseOverEnabled

mouseOverEnabled: boolean

name

name: string

opacity

opacity: number

outline

outline: string

outlineMode

outlineMode: SeriesOutlineMode

percentChange

percentChange: number

resolution

resolution: number

safeActualBrush

safeActualBrush: string

selectionBrush

selectionBrush: string

selectionThickness

selectionThickness: number

shadowBlur

shadowBlur: number

shadowColor

shadowColor: string

shadowOffsetX

shadowOffsetX: number

shadowOffsetY

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

showDefaultTooltip: boolean

thickness

thickness: number

title

title: any

tooltipContainerTemplate

tooltipContainerTemplate: TemplateRef<any>

tooltipTemplate

tooltipTemplate: TemplateRef<any>

transitionDuration

transitionDuration: number

transitionEasingFunction

transitionEasingFunction: object

transitionInDuration

transitionInDuration: number

transitionInEasingFunction

transitionInEasingFunction: object

transitionInSpeedType

transitionInSpeedType: TransitionInSpeedType

transitionOutDuration

transitionOutDuration: number

transitionOutEasingFunction

transitionOutEasingFunction: object

transitionOutSpeedType

transitionOutSpeedType: TransitionOutSpeedType

useItemWiseColors

useItemWiseColors: boolean

useSingleShadow

useSingleShadow: boolean

visibility

visibility: Visibility

visibleRangeMarginBottom

visibleRangeMarginBottom: number

visibleRangeMarginLeft

visibleRangeMarginLeft: number

visibleRangeMarginRight

visibleRangeMarginRight: number

visibleRangeMarginTop

visibleRangeMarginTop: number

visibleRangeMode

visibleRangeMode: SeriesVisibleRangeMode

Accessors

actualCloseLabel

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

get actualCloseLabel(): string

Returns string

actualHighLabel

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

get actualHighLabel(): string

Returns string

actualLowLabel

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

get actualLowLabel(): string

Returns string

actualOpenLabel

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Returns whether the current series supports visual markers.

let hasMarkers: boolean = this.series.hasMarkers;

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

i

get i(): Series

Returns Series

isAnnotationCalloutLayer

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

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

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

get isAnnotationHoverLayer(): boolean

Returns boolean

isAnnotationLayer

Gets whether the series is an annotation layer.

let isAnnotationLayer: boolean = this.series.isAnnotationLayer;

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

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

let isAreaorLine: boolean = this.series.isAreaorLine;

get isAreaOrLine(): boolean

Returns boolean

isBar

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Gets whether the current series is a category type series.

let isCategory: boolean = this.series.isCategory;

get isCategory(): boolean

Returns boolean

isColoredItemwise

get isColoredItemwise(): boolean

Returns boolean

isColumn

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

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

IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

let isDefaultCrosshairBehaviorDisabled: boolean = this.series.isDefaultCrosshairBehaviorDisabled;

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

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

let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Gets whether the current series is a financial type series.

let isFinancial: boolean = this.series.isFinancial;

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Gets whether the current series is a stack fragment.

let isFragment: boolean = this.series.isFragment;

get isFragment(): boolean

Returns boolean

isGeographic

Gets whether the current series is a geographic series.

let isGeographic: boolean = this.series.isGeographic;

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

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

let isIndexed: boolean = this.series.isIndexed;

get isIndexed(): boolean

Returns boolean

isLayer

get isLayer(): boolean

Returns boolean

isLineContour

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Gets whether the current series is a polar type series.

let isPolar: boolean = this.series.isPolar;

get isPolar(): boolean

Returns boolean

isPolygon

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Gets whether the current series is a radial type series.

let isRadial: boolean = this.series.isRadial;

get isRadial(): boolean

Returns boolean

isRange

Gets whether the current series is a range type series.

let isRange: boolean = this.series.isRange;

get isRange(): boolean

Returns boolean

isScatter

Gets whether the current series is a scatter type series.

let isScatter: boolean = this.series.isScatter;

get isScatter(): boolean

Returns boolean

isShape

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Gets whether the current series is a stacked type series.

let isStacked: boolean = this.series.isStacked;

get isStacked(): boolean

Returns boolean

isStep

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Gets if the series should appear in any legends.

let isUsableInLegend: boolean = this.series.isUsableInLegend;

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Gets whether the current series is oriented vertically.

let isVertical: boolean = this.series.isVertical;

get isVertical(): boolean

Returns boolean

isWaterfall

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

renderRequested

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

get renderRequested(): EventEmitter<object>

Returns EventEmitter<object>

seriesInternal

get seriesInternal(): any

Returns any

transitionOutCompleted

Fired when a transition out has completed.

get transitionOutCompleted(): EventEmitter<object>

Returns EventEmitter<object>

Methods

bindAxes

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

bindSeries

bindSeries(series: IgxSeriesComponent[]): void

Parameters

series: IgxSeriesComponent[]

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

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

fromWorldPosition(world: IgPoint): IgPoint

Parameters

world: IgPoint

The world position from which to convert.

let pt: IgxPoint = this.series.fromWorldPosition({x:.5,y:.5});

Returns IgPoint

getEffectiveViewport

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

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

getExactItemIndex(world: IgPoint): number

Parameters

world: IgPoint

The world position for which to return the index.

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

Returns number

getItem

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

getItem(world: IgPoint): any

Parameters

world: IgPoint

The world coordinates to use.

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

Returns any

getItemIndex

Gets the item index associated with the specified world position

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

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

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

getItemSpan(): number

Returns number

getItemValue

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

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

getMemberPathValue(memberPathName: string): string

Parameters

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

Returns string

getNextOrExactIndex

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

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

getSeriesValueBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinate for which to get a value bounding box for
```
let box: IgxRect = this.series.getSeriesValueBoundingBox({x:.8,y:.8});
```

Returns IgRect

getSeriesValueFromSeriesPixel

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

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

getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinates for which to get a value marker bounding box for
```
let box: IgxRect = this.series.getSeriesValueMarkerBoundingBox({x:.8,y:.8});
```

Returns IgRect

getSeriesValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

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

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

Parameters

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

Returns number[]

getSeriesValueTypePosition

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Gets an unscaled position in terms of axis values from a viewport position.

getUnscaledPosition(pos: IgPoint): IgPoint

Parameters

pos: IgPoint
- The viewport relative position

Returns IgPoint

hideToolTips

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

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

moveCursorPoint(point: IgPoint): void

Parameters

point: IgPoint
- The cursor point, in world coordinates.
MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.
```
this.crosshair.moveCursorPoint({x:.5,y:.5});
```

Returns void

ngOnInit

ngOnInit(): void

Returns void

notifyIndexedPropertiesChanged

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

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

Returns void

removeAxes

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Replays the assigned transition in animation, if any.

this.series.replayTransitionIn();

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

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

scrollIntoView(item: any): boolean

Parameters

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

Returns boolean

setNegativeColors

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

point: IgPoint
- The pointer position relative to the series viewport over which to hover.
When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.
```
this.series.simulateHover({x:250,y:250});
```

Returns void

styleUpdated

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

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

toWorldPosition(seriesPoint: IgPoint): IgPoint

Parameters

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

Returns IgPoint

toWorldRect

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

toWorldRect(rect: IgRect): IgRect

Parameters

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

Returns IgRect

_createFromInternal

_createFromInternal(internal: any): IgxSeriesComponent

Parameters

internal: any