IgcSplineSeriesComponent

Represents a DataChartComponent spline series.

Constructors

new IgcSplineSeriesComponent(): IgcSplineSeriesComponent

Returns IgcSplineSeriesComponent

Properties

htmlTagName

htmlTagName: string

actualAreaFillOpacity

Inherited from: IgcSplineSeriesBaseComponent

actualAreaFillOpacity: number

actualBrush

Inherited from: IgcSplineSeriesBaseComponent

actualBrush: string

actualFocusBrush

Inherited from: IgcSplineSeriesBaseComponent

actualFocusBrush: string

actualFocusMode

Inherited from: IgcSplineSeriesBaseComponent

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgcSplineSeriesBaseComponent

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgcSplineSeriesBaseComponent

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgcSplineSeriesBaseComponent

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgcSplineSeriesBaseComponent

actualHitTestMode: SeriesHitTestMode

actualLayers

Inherited from: IgcSplineSeriesBaseComponent

actualLayers: IgcSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgcSplineSeriesBaseComponent

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgcSplineSeriesBaseComponent

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgcSplineSeriesBaseComponent

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgcSplineSeriesBaseComponent

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgcSplineSeriesBaseComponent

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgcSplineSeriesBaseComponent

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgcSplineSeriesBaseComponent

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgcSplineSeriesBaseComponent

actualMarkerType: MarkerType

actualOutline

Inherited from: IgcSplineSeriesBaseComponent

actualOutline: string

actualResolution

Inherited from: IgcSplineSeriesBaseComponent

actualResolution: number

actualSelectionBrush

Inherited from: IgcSplineSeriesBaseComponent

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgcSplineSeriesBaseComponent

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgcSplineSeriesBaseComponent

actualThickness: number

actualTrendLineBrush

Inherited from: IgcSplineSeriesBaseComponent

actualTrendLineBrush: string

areaFillOpacity

Inherited from: IgcSplineSeriesBaseComponent

areaFillOpacity: number

assigningCategoryMarkerStyle

Inherited from: IgcSplineSeriesBaseComponent

assigningCategoryMarkerStyle: object

assigningCategoryStyle

Inherited from: IgcSplineSeriesBaseComponent

assigningCategoryStyle: object

attachTooltipToRoot

Inherited from: IgcSplineSeriesBaseComponent

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgcSplineSeriesBaseComponent

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgcSplineSeriesBaseComponent

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgcSplineSeriesBaseComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgcSplineSeriesBaseComponent

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgcSplineSeriesBaseComponent

brush: string

categoryCollisionMode

Inherited from: IgcSplineSeriesBaseComponent

categoryCollisionMode: CategoryCollisionMode

coercionMethods

Inherited from: IgcSplineSeriesBaseComponent

coercionMethods: any

consolidatedItemHitTestBehavior

Inherited from: IgcSplineSeriesBaseComponent

consolidatedItemHitTestBehavior: ConsolidatedItemHitTestBehavior

dashArray

Inherited from: IgcSplineSeriesBaseComponent

dashArray: number[]

dataLegendGroup

Inherited from: IgcSplineSeriesBaseComponent

dataLegendGroup: string

dataSource

Inherited from: IgcSplineSeriesBaseComponent

dataSource: any

discreteLegendItemTemplate

Inherited from: IgcSplineSeriesBaseComponent

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgcSplineSeriesBaseComponent

expectFunctions: boolean

finalValue

Inherited from: IgcSplineSeriesBaseComponent

finalValue: number

focusBrush

Inherited from: IgcSplineSeriesBaseComponent

focusBrush: string

highlightedDataSource

Inherited from: IgcSplineSeriesBaseComponent

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgcSplineSeriesBaseComponent

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgcSplineSeriesBaseComponent

highlightedTitleSuffix: string

highlightedValueMemberPath

Inherited from: IgcSplineSeriesBaseComponent

highlightedValueMemberPath: string

highlightedValuesDataLegendGroup

Inherited from: IgcSplineSeriesBaseComponent

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgcSplineSeriesBaseComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgcSplineSeriesBaseComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgcSplineSeriesBaseComponent

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgcSplineSeriesBaseComponent

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgcSplineSeriesBaseComponent

hitTestMode: SeriesHitTestMode

index

Inherited from: IgcSplineSeriesBaseComponent

index: number

isActualLegendFinancial

Inherited from: IgcSplineSeriesBaseComponent

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgcSplineSeriesBaseComponent

isComponentHighlightingModeIgnored: boolean

isCustomCategoryMarkerStyleAllowed

Inherited from: IgcSplineSeriesBaseComponent

isCustomCategoryMarkerStyleAllowed: boolean

isCustomCategoryStyleAllowed

Inherited from: IgcSplineSeriesBaseComponent

isCustomCategoryStyleAllowed: boolean

isCustomMarkerCircular

Inherited from: IgcSplineSeriesBaseComponent

isCustomMarkerCircular: boolean

isDefaultToolTipSelected

Inherited from: IgcSplineSeriesBaseComponent

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgcSplineSeriesBaseComponent

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgcSplineSeriesBaseComponent

isHighlightingEnabled: boolean

isSplineShapePartOfRange

Inherited from: IgcSplineSeriesBaseComponent

isSplineShapePartOfRange: boolean

isTransitionInEnabled

Inherited from: IgcSplineSeriesBaseComponent

isTransitionInEnabled: boolean

layers

Inherited from: IgcSplineSeriesBaseComponent

layers: IgcSeriesLayerCollection

legend

Inherited from: IgcSplineSeriesBaseComponent

legend: any

legendItemBadgeMode

Inherited from: IgcSplineSeriesBaseComponent

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgcSplineSeriesBaseComponent

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgcSplineSeriesBaseComponent

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgcSplineSeriesBaseComponent

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgcSplineSeriesBaseComponent

legendItemVisibility: Visibility

lineCap

Inherited from: IgcSplineSeriesBaseComponent

lineCap: PenLineCap

lineJoin

Inherited from: IgcSplineSeriesBaseComponent

lineJoin: PenLineJoin

markerBrush

Inherited from: IgcSplineSeriesBaseComponent

markerBrush: string

markerCollisionAvoidance

Inherited from: IgcSplineSeriesBaseComponent

markerCollisionAvoidance: CategorySeriesMarkerCollisionAvoidance

markerFillMode

Inherited from: IgcSplineSeriesBaseComponent

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgcSplineSeriesBaseComponent

markerFillOpacity: number

markerOutline

Inherited from: IgcSplineSeriesBaseComponent

markerOutline: string

markerOutlineMode

Inherited from: IgcSplineSeriesBaseComponent

markerOutlineMode: MarkerOutlineMode

markerSize

Inherited from: IgcSplineSeriesBaseComponent

markerSize: number

markerTemplate

Inherited from: IgcSplineSeriesBaseComponent

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgcSplineSeriesBaseComponent

markerThickness: number

markerType

Inherited from: IgcSplineSeriesBaseComponent

markerType: MarkerType

mouseOverEnabled

Inherited from: IgcSplineSeriesBaseComponent

mouseOverEnabled: boolean

name

Inherited from: IgcSplineSeriesBaseComponent

name: string

opacity

Inherited from: IgcSplineSeriesBaseComponent

opacity: number

outline

Inherited from: IgcSplineSeriesBaseComponent

outline: string

outlineMode

Inherited from: IgcSplineSeriesBaseComponent

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgcSplineSeriesBaseComponent

percentChange: number

renderRequested

Inherited from: IgcSplineSeriesBaseComponent

renderRequested: object

resolution

Inherited from: IgcSplineSeriesBaseComponent

resolution: number

safeActualBrush

Inherited from: IgcSplineSeriesBaseComponent

safeActualBrush: string

selectionBrush

Inherited from: IgcSplineSeriesBaseComponent

selectionBrush: string

selectionThickness

Inherited from: IgcSplineSeriesBaseComponent

selectionThickness: number

shadowBlur

Inherited from: IgcSplineSeriesBaseComponent

shadowBlur: number

shadowColor

Inherited from: IgcSplineSeriesBaseComponent

shadowColor: string

shadowOffsetX

Inherited from: IgcSplineSeriesBaseComponent

shadowOffsetX: number

shadowOffsetY

Inherited from: IgcSplineSeriesBaseComponent

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgcSplineSeriesBaseComponent

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgcSplineSeriesBaseComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgcSplineSeriesBaseComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgcSplineSeriesBaseComponent

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgcSplineSeriesBaseComponent

showDefaultTooltip: boolean

splineType

Inherited from: IgcSplineSeriesBaseComponent

splineType: SplineType

thickness

Inherited from: IgcSplineSeriesBaseComponent

thickness: number

title

Inherited from: IgcSplineSeriesBaseComponent

title: any

tooltipContainerTemplate

Inherited from: IgcSplineSeriesBaseComponent

tooltipContainerTemplate: TemplateFunction

tooltipTemplate

Inherited from: IgcSplineSeriesBaseComponent

tooltipTemplate: TemplateFunction

transitionDuration

Inherited from: IgcSplineSeriesBaseComponent

transitionDuration: number

transitionEasingFunction

Inherited from: IgcSplineSeriesBaseComponent

transitionEasingFunction: object

transitionInDuration

Inherited from: IgcSplineSeriesBaseComponent

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgcSplineSeriesBaseComponent

transitionInEasingFunction: object

transitionInMode

Inherited from: IgcSplineSeriesBaseComponent

transitionInMode: CategoryTransitionInMode

transitionInSpeedType

Inherited from: IgcSplineSeriesBaseComponent

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgcSplineSeriesBaseComponent

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgcSplineSeriesBaseComponent

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgcSplineSeriesBaseComponent

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgcSplineSeriesBaseComponent

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

Inherited from: IgcSplineSeriesBaseComponent

trendLineBrush: string

trendLineDashArray

Inherited from: IgcSplineSeriesBaseComponent

trendLineDashArray: number[]

trendLinePeriod

Inherited from: IgcSplineSeriesBaseComponent

trendLinePeriod: number

trendLineThickness

Inherited from: IgcSplineSeriesBaseComponent

trendLineThickness: number

trendLineType

Inherited from: IgcSplineSeriesBaseComponent

trendLineType: TrendLineType

useHighMarkerFidelity

Inherited from: IgcSplineSeriesBaseComponent

useHighMarkerFidelity: boolean

useItemWiseColors

Inherited from: IgcSplineSeriesBaseComponent

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgcSplineSeriesBaseComponent

useSingleShadow: boolean

valueMemberAsLegendLabel

Inherited from: IgcSplineSeriesBaseComponent

valueMemberAsLegendLabel: string

valueMemberAsLegendUnit

Inherited from: IgcSplineSeriesBaseComponent

valueMemberAsLegendUnit: string

valueMemberPath

Inherited from: IgcSplineSeriesBaseComponent

valueMemberPath: string

visibility

Inherited from: IgcSplineSeriesBaseComponent

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgcSplineSeriesBaseComponent

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgcSplineSeriesBaseComponent

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgcSplineSeriesBaseComponent

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgcSplineSeriesBaseComponent

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgcSplineSeriesBaseComponent

visibleRangeMode: SeriesVisibleRangeMode

xAxis

Inherited from: IgcSplineSeriesBaseComponent

xAxis: IgcCategoryAxisBaseComponent

xAxisName

Inherited from: IgcSplineSeriesBaseComponent

xAxisName: string

yAxis

Inherited from: IgcSplineSeriesBaseComponent

yAxis: IgcNumericYAxisComponent

yAxisName

Inherited from: IgcSplineSeriesBaseComponent

yAxisName: string

Accessors

actualCloseLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgcSplineSeriesBaseComponent

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgcSplineSeriesBaseComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the markers for the current series are in circular shape

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgcSplineSeriesBaseComponent

Returns whether the current series supports visual markers.

HasMarkers property is overriden, it returns whether the current series supports visual markers. You can use it like this:

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgcSplineSeriesBaseComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgcSplineSeriesBaseComponent

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

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgcSplineSeriesBaseComponent

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

get isAnnotationHoverLayer(): boolean

Returns boolean

isAnnotationLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgcSplineSeriesBaseComponent

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgcSplineSeriesBaseComponent

Gets whether or not this series is Category series

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgcSplineSeriesBaseComponent

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgcSplineSeriesBaseComponent

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.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Inherited from: IgcSplineSeriesBaseComponent

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgcSplineSeriesBaseComponent

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

get isIndexed(): boolean

Returns boolean

isLayer

Inherited from: IgcSplineSeriesBaseComponent

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgcSplineSeriesBaseComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgcSplineSeriesBaseComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgcSplineSeriesBaseComponent

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

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgcSplineSeriesBaseComponent

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgcSplineSeriesBaseComponent

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgcSplineSeriesBaseComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgcSplineSeriesBaseComponent

get seriesInternal(): any

Returns any

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcSplineSeriesBaseComponent

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

Inherited from: IgcSplineSeriesBaseComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

bindSeries

Inherited from: IgcSplineSeriesBaseComponent

bindSeries(series: IgcSeriesComponent[]): void

Parameters

series: IgcSeriesComponent[]

Returns void

canUseAsXAxis

Inherited from: IgcSplineSeriesBaseComponent

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check
You can use the CanUseAsXAxis method to determine if object can be used as XAxis
```
 var x = this.financialSeries.CanUseAsXAxis(this.xAxis);
```

Returns boolean

canUseAsYAxis

Inherited from: IgcSplineSeriesBaseComponent

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check
You can use the CanUseAsYAxis method to determine if object can be used as YAxis
```
 N/A
```

Returns boolean

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

findByName

Inherited from: IgcSplineSeriesBaseComponent

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgcSplineSeriesBaseComponent

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.

Returns IgPoint

getCategoryWidth

Inherited from: IgcSplineSeriesBaseComponent

Returns the width of the category grouping this series is in.

You can use the GetCategoryWidth to get the width of the category grouping a series is in.

 var x = this.financialSeries.CanUseAsXAxis(this.xAxis);

N/A

getCategoryWidth(): number

Returns number

getEffectiveViewport

Inherited from: IgcSplineSeriesBaseComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgcSplineSeriesBaseComponent

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.

Returns number

getItem

Inherited from: IgcSplineSeriesBaseComponent

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

getItem(world: IgPoint): any

Parameters

world: IgPoint
- The world coordinates to use.
The getItem method is used to gets the item that is the best match for the specified world coordinates.
```
let item: number = this.series.getItem({x:.5,y:.5});
```

Returns any

getItemIndex

Inherited from: IgcSplineSeriesBaseComponent

Gets the index of the item based on world coordinates.

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint
- The world coordinates to use.

Returns number

getItemSpan

Inherited from: IgcSplineSeriesBaseComponent

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

getItemSpan(): number

Returns number

getItemValue

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgcSplineSeriesBaseComponent

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgcSplineSeriesBaseComponent

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

getMemberPathValue(memberPathName: string): string

Parameters

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

Returns string

getNextOrExactIndex

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getOffsetValue

Inherited from: IgcSplineSeriesBaseComponent

Returns the offset value for this series if grouped on a category axis.

You can use the GetOffsetValue to get the offset value for this series if grouped on a category axis.

  var g = series.getOffsetValue();

N/A

getOffsetValue(): number

Returns number

getPreviousOrExactIndex

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgcSplineSeriesBaseComponent

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

Returns IgRect

getSeriesValueFromSeriesPixel

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgcSplineSeriesBaseComponent

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
You can use the GetCategoryWidth to get the width of the category grouping a series is in.
```
var x = financialSeries.GetSeriesValueMarkerBoundingBox(new IgxPoint());
```
```
 N/A
```

Returns IgRect

getSeriesValuePosition

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgcSplineSeriesBaseComponent

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

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

Parameters

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

Returns number[]

getSeriesValueTypePosition

Inherited from: IgcSplineSeriesBaseComponent

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgcSplineSeriesBaseComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgcSplineSeriesBaseComponent

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

getUnscaledPosition(pos: IgPoint): IgPoint

Parameters

pos: IgPoint
- The viewport relative position

Returns IgPoint

hideToolTips

Inherited from: IgcSplineSeriesBaseComponent

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgcSplineSeriesBaseComponent

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgcSplineSeriesBaseComponent

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

notifyIndexedPropertiesChanged

Inherited from: IgcSplineSeriesBaseComponent

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgcSplineSeriesBaseComponent

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgcSplineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgcSplineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgcSplineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgcSplineSeriesBaseComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgcSplineSeriesBaseComponent

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgcSplineSeriesBaseComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgcSplineSeriesBaseComponent

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

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

Returns void

removeAxes

Inherited from: IgcSplineSeriesBaseComponent

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Inherited from: IgcSplineSeriesBaseComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Inherited from: IgcSplineSeriesBaseComponent

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgcSplineSeriesBaseComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgcSplineSeriesBaseComponent

Scrolls the series to display the item for the specified data item. The series is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.

scrollIntoView(item: any): boolean

Parameters

item: any
- The data item (item) to scroll to.
The ScrollIntoView method is used to notifies the target axis or series that it should scroll the requested data item into view.
```
this.series.scrollIntoView(dataItem);
```

Returns boolean

setNegativeColors

Inherited from: IgcSplineSeriesBaseComponent

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Inherited from: IgcSplineSeriesBaseComponent

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

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

Returns void

styleUpdated

Inherited from: IgcSplineSeriesBaseComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgcSplineSeriesBaseComponent

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

toWorldPosition(seriesPoint: IgPoint): IgPoint

Parameters

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

Returns IgPoint

toWorldRect

Inherited from: IgcSplineSeriesBaseComponent

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

toWorldRect(rect: IgRect): IgRect

Parameters

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

Returns IgRect

_createFromInternal

Inherited from: IgcSplineSeriesBaseComponent

_createFromInternal(internal: any): IgcSeriesComponent

Parameters

internal: any

Returns IgcSeriesComponent

register

register(): void