IgrPolarSplineAreaSeries

Represents a DataChartComponent polar spline area series.

Constructors

new IgrPolarSplineAreaSeries(props: IIgrPolarSplineAreaSeriesProps): IgrPolarSplineAreaSeries

Returns IgrPolarSplineAreaSeries

Properties

actualAreaFillOpacity

Inherited from: IgrPolarLineSeriesBase

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrPolarLineSeriesBase

actualBrush: string

actualFocusBrush

Inherited from: IgrPolarLineSeriesBase

actualFocusBrush: string

actualFocusMode

Inherited from: IgrPolarLineSeriesBase

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrPolarLineSeriesBase

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrPolarLineSeriesBase

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrPolarLineSeriesBase

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrPolarLineSeriesBase

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

Inherited from: IgrPolarLineSeriesBase

actualItemSearchMode: ScatterItemSearchMode

actualLayers

Inherited from: IgrPolarLineSeriesBase

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrPolarLineSeriesBase

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrPolarLineSeriesBase

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrPolarLineSeriesBase

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgrPolarLineSeriesBase

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgrPolarLineSeriesBase

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgrPolarLineSeriesBase

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgrPolarLineSeriesBase

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgrPolarLineSeriesBase

actualMarkerType: MarkerType

actualOutline

Inherited from: IgrPolarLineSeriesBase

actualOutline: string

actualResolution

Inherited from: IgrPolarLineSeriesBase

actualResolution: number

actualSelectionBrush

Inherited from: IgrPolarLineSeriesBase

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrPolarLineSeriesBase

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrPolarLineSeriesBase

actualThickness: number

actualTrendLineBrush

Inherited from: IgrPolarLineSeriesBase

actualTrendLineBrush: string

angleAxis

Inherited from: IgrPolarLineSeriesBase

angleAxis: IgrNumericAngleAxis

angleAxisName

Inherited from: IgrPolarLineSeriesBase

angleAxisName: string

angleMemberAsLegendLabel

Inherited from: IgrPolarLineSeriesBase

angleMemberAsLegendLabel: string

angleMemberAsLegendUnit

Inherited from: IgrPolarLineSeriesBase

angleMemberAsLegendUnit: string

angleMemberPath

Inherited from: IgrPolarLineSeriesBase

angleMemberPath: string

areaFillOpacity

Inherited from: IgrPolarLineSeriesBase

areaFillOpacity: number

assigningPolarMarkerStyle

Inherited from: IgrPolarLineSeriesBase

assigningPolarMarkerStyle: object

assigningPolarStyle

Inherited from: IgrPolarLineSeriesBase

assigningPolarStyle: object

attachTooltipToRoot

Inherited from: IgrPolarLineSeriesBase

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrPolarLineSeriesBase

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrPolarLineSeriesBase

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgrPolarLineSeriesBase

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrPolarLineSeriesBase

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrPolarLineSeriesBase

brush: string

clipSeriesToBounds

Inherited from: IgrPolarLineSeriesBase

clipSeriesToBounds: boolean

coercionMethods

Inherited from: IgrPolarLineSeriesBase

coercionMethods: any

dashArray

Inherited from: IgrPolarLineSeriesBase

dashArray: number[]

dataLegendGroup

Inherited from: IgrPolarLineSeriesBase

dataLegendGroup: string

dataSource

Inherited from: IgrPolarLineSeriesBase

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrPolarLineSeriesBase

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrPolarLineSeriesBase

expectFunctions: boolean

finalValue

Inherited from: IgrPolarLineSeriesBase

finalValue: number

focusBrush

Inherited from: IgrPolarLineSeriesBase

focusBrush: string

highlightedAngleMemberPath

Inherited from: IgrPolarLineSeriesBase

highlightedAngleMemberPath: string

highlightedDataSource

Inherited from: IgrPolarLineSeriesBase

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrPolarLineSeriesBase

highlightedLegendItemVisibility: Visibility

highlightedRadiusMemberPath

Inherited from: IgrPolarLineSeriesBase

highlightedRadiusMemberPath: string

highlightedTitleSuffix

Inherited from: IgrPolarLineSeriesBase

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgrPolarLineSeriesBase

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrPolarLineSeriesBase

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrPolarLineSeriesBase

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrPolarLineSeriesBase

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgrPolarLineSeriesBase

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrPolarLineSeriesBase

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrPolarLineSeriesBase

index: number

isActualLegendFinancial

Inherited from: IgrPolarLineSeriesBase

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrPolarLineSeriesBase

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgrPolarLineSeriesBase

isCustomMarkerCircular: boolean

isCustomPolarMarkerStyleAllowed

Inherited from: IgrPolarLineSeriesBase

isCustomPolarMarkerStyleAllowed: boolean

isCustomPolarStyleAllowed

Inherited from: IgrPolarLineSeriesBase

isCustomPolarStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgrPolarLineSeriesBase

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrPolarLineSeriesBase

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrPolarLineSeriesBase

isHighlightingEnabled: boolean

itemSearchMode

Inherited from: IgrPolarLineSeriesBase

itemSearchMode: ScatterItemSearchMode

itemSearchThreshold

Inherited from: IgrPolarLineSeriesBase

itemSearchThreshold: number

layers

Inherited from: IgrPolarLineSeriesBase

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrPolarLineSeriesBase

legend: any

legendItemBadgeMode

Inherited from: IgrPolarLineSeriesBase

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrPolarLineSeriesBase

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrPolarLineSeriesBase

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrPolarLineSeriesBase

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrPolarLineSeriesBase

legendItemVisibility: Visibility

lineCap

Inherited from: IgrPolarLineSeriesBase

lineCap: PenLineCap

lineJoin

Inherited from: IgrPolarLineSeriesBase

lineJoin: PenLineJoin

markerBrush

Inherited from: IgrPolarLineSeriesBase

markerBrush: string

markerFillMode

Inherited from: IgrPolarLineSeriesBase

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgrPolarLineSeriesBase

markerFillOpacity: number

markerOutline

Inherited from: IgrPolarLineSeriesBase

markerOutline: string

markerOutlineMode

Inherited from: IgrPolarLineSeriesBase

markerOutlineMode: MarkerOutlineMode

markerTemplate

Inherited from: IgrPolarLineSeriesBase

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgrPolarLineSeriesBase

markerThickness: number

markerType

Inherited from: IgrPolarLineSeriesBase

markerType: MarkerType

maximumMarkers

Inherited from: IgrPolarLineSeriesBase

maximumMarkers: number

mouseOverEnabled

Inherited from: IgrPolarLineSeriesBase

mouseOverEnabled: boolean

name

Inherited from: IgrPolarLineSeriesBase

name: string

opacity

Inherited from: IgrPolarLineSeriesBase

opacity: number

outline

Inherited from: IgrPolarLineSeriesBase

outline: string

outlineMode

Inherited from: IgrPolarLineSeriesBase

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrPolarLineSeriesBase

percentChange: number

radiusAxis

Inherited from: IgrPolarLineSeriesBase

radiusAxis: IgrNumericRadiusAxis

radiusAxisName

Inherited from: IgrPolarLineSeriesBase

radiusAxisName: string

radiusMemberAsLegendLabel

Inherited from: IgrPolarLineSeriesBase

radiusMemberAsLegendLabel: string

radiusMemberAsLegendUnit

Inherited from: IgrPolarLineSeriesBase

radiusMemberAsLegendUnit: string

radiusMemberPath

Inherited from: IgrPolarLineSeriesBase

radiusMemberPath: string

renderRequested

Inherited from: IgrPolarLineSeriesBase

renderRequested: object

resolution

Inherited from: IgrPolarLineSeriesBase

resolution: number

safeActualBrush

Inherited from: IgrPolarLineSeriesBase

safeActualBrush: string

selectionBrush

Inherited from: IgrPolarLineSeriesBase

selectionBrush: string

selectionThickness

Inherited from: IgrPolarLineSeriesBase

selectionThickness: number

shadowBlur

Inherited from: IgrPolarLineSeriesBase

shadowBlur: number

shadowColor

Inherited from: IgrPolarLineSeriesBase

shadowColor: string

shadowOffsetX

Inherited from: IgrPolarLineSeriesBase

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrPolarLineSeriesBase

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrPolarLineSeriesBase

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrPolarLineSeriesBase

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrPolarLineSeriesBase

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrPolarLineSeriesBase

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrPolarLineSeriesBase

showDefaultTooltip: boolean

stiffness

stiffness: number

thickness

Inherited from: IgrPolarLineSeriesBase

thickness: number

title

Inherited from: IgrPolarLineSeriesBase

title: any

tooltipContainerTemplate

Inherited from: IgrPolarLineSeriesBase

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrPolarLineSeriesBase

tooltipTemplate: any

transitionDuration

Inherited from: IgrPolarLineSeriesBase

transitionDuration: number

transitionEasingFunction

Inherited from: IgrPolarLineSeriesBase

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrPolarLineSeriesBase

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrPolarLineSeriesBase

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgrPolarLineSeriesBase

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrPolarLineSeriesBase

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrPolarLineSeriesBase

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrPolarLineSeriesBase

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrPolarLineSeriesBase

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

Inherited from: IgrPolarLineSeriesBase

trendLineBrush: string

trendLineDashArray

Inherited from: IgrPolarLineSeriesBase

trendLineDashArray: number[]

trendLinePeriod

Inherited from: IgrPolarLineSeriesBase

trendLinePeriod: number

trendLineThickness

Inherited from: IgrPolarLineSeriesBase

trendLineThickness: number

trendLineType

Inherited from: IgrPolarLineSeriesBase

trendLineType: TrendLineType

trendLineZIndex

Inherited from: IgrPolarLineSeriesBase

trendLineZIndex: number

useCartesianInterpolation

Inherited from: IgrPolarLineSeriesBase

useCartesianInterpolation: boolean

useItemWiseColors

Inherited from: IgrPolarLineSeriesBase

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrPolarLineSeriesBase

useSingleShadow: boolean

visibility

Inherited from: IgrPolarLineSeriesBase

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrPolarLineSeriesBase

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrPolarLineSeriesBase

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrPolarLineSeriesBase

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrPolarLineSeriesBase

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrPolarLineSeriesBase

visibleRangeMode: SeriesVisibleRangeMode

Accessors

actualCloseLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrPolarLineSeriesBase

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrPolarLineSeriesBase

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgrPolarLineSeriesBase

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrPolarLineSeriesBase

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrPolarLineSeriesBase

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

Inherited from: IgrPolarLineSeriesBase

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrPolarLineSeriesBase

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrPolarLineSeriesBase

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrPolarLineSeriesBase

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrPolarLineSeriesBase

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrPolarLineSeriesBase

Checks if this series is a polar series

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrPolarLineSeriesBase

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrPolarLineSeriesBase

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrPolarLineSeriesBase

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrPolarLineSeriesBase

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrPolarLineSeriesBase

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrPolarLineSeriesBase

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrPolarLineSeriesBase

bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsAngleAxis

Inherited from: IgrPolarLineSeriesBase

Determine if object can be used as AngleAxis

canUseAsAngleAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsRadiusAxis

Inherited from: IgrPolarLineSeriesBase

Determine if object can be used as RadiusAxis

canUseAsRadiusAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrPolarLineSeriesBase

componentDidMount(): void

Returns void

findByName

Inherited from: IgrPolarLineSeriesBase

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrPolarLineSeriesBase

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

getEffectiveViewport

Inherited from: IgrPolarLineSeriesBase

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrPolarLineSeriesBase

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

Inherited from: IgrPolarLineSeriesBase

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.

Returns any

getItemIndex

Inherited from: IgrPolarLineSeriesBase

Gets the index of the item that resides at the provided world coordinates.

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint
- The world coordinates of the requested item.

Returns number

getItemSpan

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrPolarLineSeriesBase

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrPolarLineSeriesBase

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

Returns IgRect

getSeriesValuePosition

Inherited from: IgrPolarLineSeriesBase

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrPolarLineSeriesBase

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrPolarLineSeriesBase

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

Inherited from: IgrPolarLineSeriesBase

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrPolarLineSeriesBase

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrPolarLineSeriesBase

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrPolarLineSeriesBase

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrPolarLineSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrPolarLineSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrPolarLineSeriesBase

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrPolarLineSeriesBase

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrPolarLineSeriesBase

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrPolarLineSeriesBase

render(): any

Returns any

renderSeries

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrPolarLineSeriesBase

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrPolarLineSeriesBase

Scrolls the requested item into view, if possible.

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to scroll into view.

Returns boolean

setNegativeColors

Inherited from: IgrPolarLineSeriesBase

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrPolarLineSeriesBase

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

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: IgrPolarLineSeriesBase

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any