IgcPolarLineSeriesComponent

Represents a DataChartComponent polar line series.

Constructors

new IgcPolarLineSeriesComponent(): IgcPolarLineSeriesComponent

Returns IgcPolarLineSeriesComponent

Properties

htmlTagName

htmlTagName: string

actualAreaFillOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

actualAreaFillOpacity: number

actualBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualBrush: string

actualFocusBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualFocusBrush: string

actualFocusMode

Inherited from: IgcPolarLineSeriesBaseComponent

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgcPolarLineSeriesBaseComponent

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgcPolarLineSeriesBaseComponent

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

Inherited from: IgcPolarLineSeriesBaseComponent

actualItemSearchMode: ScatterItemSearchMode

actualLayers

Inherited from: IgcPolarLineSeriesBaseComponent

actualLayers: IgcSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgcPolarLineSeriesBaseComponent

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgcPolarLineSeriesBaseComponent

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgcPolarLineSeriesBaseComponent

actualMarkerType: MarkerType

actualOutline

Inherited from: IgcPolarLineSeriesBaseComponent

actualOutline: string

actualResolution

Inherited from: IgcPolarLineSeriesBaseComponent

actualResolution: number

actualSelectionBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgcPolarLineSeriesBaseComponent

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgcPolarLineSeriesBaseComponent

actualThickness: number

actualTrendLineBrush

Inherited from: IgcPolarLineSeriesBaseComponent

actualTrendLineBrush: string

angleAxis

Inherited from: IgcPolarLineSeriesBaseComponent

angleAxis: IgcNumericAngleAxisComponent

angleAxisName

Inherited from: IgcPolarLineSeriesBaseComponent

angleAxisName: string

angleMemberAsLegendLabel

Inherited from: IgcPolarLineSeriesBaseComponent

angleMemberAsLegendLabel: string

angleMemberAsLegendUnit

Inherited from: IgcPolarLineSeriesBaseComponent

angleMemberAsLegendUnit: string

angleMemberPath

Inherited from: IgcPolarLineSeriesBaseComponent

angleMemberPath: string

areaFillOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

areaFillOpacity: number

assigningPolarMarkerStyle

Inherited from: IgcPolarLineSeriesBaseComponent

assigningPolarMarkerStyle: object

assigningPolarStyle

Inherited from: IgcPolarLineSeriesBaseComponent

assigningPolarStyle: object

attachTooltipToRoot

Inherited from: IgcPolarLineSeriesBaseComponent

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgcPolarLineSeriesBaseComponent

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgcPolarLineSeriesBaseComponent

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgcPolarLineSeriesBaseComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgcPolarLineSeriesBaseComponent

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgcPolarLineSeriesBaseComponent

brush: string

clipSeriesToBounds

Inherited from: IgcPolarLineSeriesBaseComponent

clipSeriesToBounds: boolean

coercionMethods

Inherited from: IgcPolarLineSeriesBaseComponent

coercionMethods: any

dashArray

Inherited from: IgcPolarLineSeriesBaseComponent

dashArray: number[]

dataLegendGroup

Inherited from: IgcPolarLineSeriesBaseComponent

dataLegendGroup: string

dataSource

Inherited from: IgcPolarLineSeriesBaseComponent

dataSource: any

discreteLegendItemTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgcPolarLineSeriesBaseComponent

expectFunctions: boolean

finalValue

Inherited from: IgcPolarLineSeriesBaseComponent

finalValue: number

focusBrush

Inherited from: IgcPolarLineSeriesBaseComponent

focusBrush: string

highlightedAngleMemberPath

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedAngleMemberPath: string

highlightedDataSource

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedLegendItemVisibility: Visibility

highlightedRadiusMemberPath

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedRadiusMemberPath: string

highlightedTitleSuffix

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgcPolarLineSeriesBaseComponent

hitTestMode: SeriesHitTestMode

index

Inherited from: IgcPolarLineSeriesBaseComponent

index: number

isActualLegendFinancial

Inherited from: IgcPolarLineSeriesBaseComponent

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgcPolarLineSeriesBaseComponent

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgcPolarLineSeriesBaseComponent

isCustomMarkerCircular: boolean

isCustomPolarMarkerStyleAllowed

Inherited from: IgcPolarLineSeriesBaseComponent

isCustomPolarMarkerStyleAllowed: boolean

isCustomPolarStyleAllowed

Inherited from: IgcPolarLineSeriesBaseComponent

isCustomPolarStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgcPolarLineSeriesBaseComponent

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgcPolarLineSeriesBaseComponent

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgcPolarLineSeriesBaseComponent

isHighlightingEnabled: boolean

itemSearchMode

Inherited from: IgcPolarLineSeriesBaseComponent

itemSearchMode: ScatterItemSearchMode

itemSearchThreshold

Inherited from: IgcPolarLineSeriesBaseComponent

itemSearchThreshold: number

layers

Inherited from: IgcPolarLineSeriesBaseComponent

layers: IgcSeriesLayerCollection

legend

Inherited from: IgcPolarLineSeriesBaseComponent

legend: any

legendItemBadgeMode

Inherited from: IgcPolarLineSeriesBaseComponent

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgcPolarLineSeriesBaseComponent

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgcPolarLineSeriesBaseComponent

legendItemVisibility: Visibility

lineCap

Inherited from: IgcPolarLineSeriesBaseComponent

lineCap: PenLineCap

lineJoin

Inherited from: IgcPolarLineSeriesBaseComponent

lineJoin: PenLineJoin

markerBrush

Inherited from: IgcPolarLineSeriesBaseComponent

markerBrush: string

markerFillMode

Inherited from: IgcPolarLineSeriesBaseComponent

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgcPolarLineSeriesBaseComponent

markerFillOpacity: number

markerOutline

Inherited from: IgcPolarLineSeriesBaseComponent

markerOutline: string

markerOutlineMode

Inherited from: IgcPolarLineSeriesBaseComponent

markerOutlineMode: MarkerOutlineMode

markerSize

Inherited from: IgcPolarLineSeriesBaseComponent

markerSize: number

markerTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgcPolarLineSeriesBaseComponent

markerThickness: number

markerType

Inherited from: IgcPolarLineSeriesBaseComponent

markerType: MarkerType

maximumMarkers

Inherited from: IgcPolarLineSeriesBaseComponent

maximumMarkers: number

mouseOverEnabled

Inherited from: IgcPolarLineSeriesBaseComponent

mouseOverEnabled: boolean

name

Inherited from: IgcPolarLineSeriesBaseComponent

name: string

opacity

Inherited from: IgcPolarLineSeriesBaseComponent

opacity: number

outline

Inherited from: IgcPolarLineSeriesBaseComponent

outline: string

outlineMode

Inherited from: IgcPolarLineSeriesBaseComponent

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgcPolarLineSeriesBaseComponent

percentChange: number

radiusAxis

Inherited from: IgcPolarLineSeriesBaseComponent

radiusAxis: IgcNumericRadiusAxisComponent

radiusAxisName

Inherited from: IgcPolarLineSeriesBaseComponent

radiusAxisName: string

radiusMemberAsLegendLabel

Inherited from: IgcPolarLineSeriesBaseComponent

radiusMemberAsLegendLabel: string

radiusMemberAsLegendUnit

Inherited from: IgcPolarLineSeriesBaseComponent

radiusMemberAsLegendUnit: string

radiusMemberPath

Inherited from: IgcPolarLineSeriesBaseComponent

radiusMemberPath: string

renderRequested

Inherited from: IgcPolarLineSeriesBaseComponent

renderRequested: object

resolution

Inherited from: IgcPolarLineSeriesBaseComponent

resolution: number

safeActualBrush

Inherited from: IgcPolarLineSeriesBaseComponent

safeActualBrush: string

selectionBrush

Inherited from: IgcPolarLineSeriesBaseComponent

selectionBrush: string

selectionThickness

Inherited from: IgcPolarLineSeriesBaseComponent

selectionThickness: number

shadowBlur

Inherited from: IgcPolarLineSeriesBaseComponent

shadowBlur: number

shadowColor

Inherited from: IgcPolarLineSeriesBaseComponent

shadowColor: string

shadowOffsetX

Inherited from: IgcPolarLineSeriesBaseComponent

shadowOffsetX: number

shadowOffsetY

Inherited from: IgcPolarLineSeriesBaseComponent

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgcPolarLineSeriesBaseComponent

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgcPolarLineSeriesBaseComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgcPolarLineSeriesBaseComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgcPolarLineSeriesBaseComponent

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgcPolarLineSeriesBaseComponent

showDefaultTooltip: boolean

thickness

Inherited from: IgcPolarLineSeriesBaseComponent

thickness: number

title

Inherited from: IgcPolarLineSeriesBaseComponent

title: any

tooltipContainerTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

tooltipContainerTemplate: TemplateFunction

tooltipTemplate

Inherited from: IgcPolarLineSeriesBaseComponent

tooltipTemplate: TemplateFunction

transitionDuration

Inherited from: IgcPolarLineSeriesBaseComponent

transitionDuration: number

transitionEasingFunction

Inherited from: IgcPolarLineSeriesBaseComponent

transitionEasingFunction: object

transitionInDuration

Inherited from: IgcPolarLineSeriesBaseComponent

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgcPolarLineSeriesBaseComponent

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgcPolarLineSeriesBaseComponent

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgcPolarLineSeriesBaseComponent

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgcPolarLineSeriesBaseComponent

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgcPolarLineSeriesBaseComponent

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgcPolarLineSeriesBaseComponent

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

Inherited from: IgcPolarLineSeriesBaseComponent

trendLineBrush: string

trendLineDashArray

Inherited from: IgcPolarLineSeriesBaseComponent

trendLineDashArray: number[]

trendLinePeriod

Inherited from: IgcPolarLineSeriesBaseComponent

trendLinePeriod: number

trendLineThickness

Inherited from: IgcPolarLineSeriesBaseComponent

trendLineThickness: number

trendLineType

Inherited from: IgcPolarLineSeriesBaseComponent

trendLineType: TrendLineType

trendLineZIndex

Inherited from: IgcPolarLineSeriesBaseComponent

trendLineZIndex: number

unknownValuePlotting

unknownValuePlotting: UnknownValuePlotting

useCartesianInterpolation

Inherited from: IgcPolarLineSeriesBaseComponent

useCartesianInterpolation: boolean

useItemWiseColors

Inherited from: IgcPolarLineSeriesBaseComponent

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgcPolarLineSeriesBaseComponent

useSingleShadow: boolean

visibility

Inherited from: IgcPolarLineSeriesBaseComponent

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgcPolarLineSeriesBaseComponent

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgcPolarLineSeriesBaseComponent

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgcPolarLineSeriesBaseComponent

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgcPolarLineSeriesBaseComponent

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgcPolarLineSeriesBaseComponent

visibleRangeMode: SeriesVisibleRangeMode

Accessors

actualCloseLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgcPolarLineSeriesBaseComponent

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgcPolarLineSeriesBaseComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgcPolarLineSeriesBaseComponent

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgcPolarLineSeriesBaseComponent

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

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgcPolarLineSeriesBaseComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgcPolarLineSeriesBaseComponent

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgcPolarLineSeriesBaseComponent

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

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgcPolarLineSeriesBaseComponent

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgcPolarLineSeriesBaseComponent

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgcPolarLineSeriesBaseComponent

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

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgcPolarLineSeriesBaseComponent

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

Inherited from: IgcPolarLineSeriesBaseComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgcPolarLineSeriesBaseComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgcPolarLineSeriesBaseComponent

Checks if this series is a polar series

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgcPolarLineSeriesBaseComponent

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgcPolarLineSeriesBaseComponent

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgcPolarLineSeriesBaseComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgcPolarLineSeriesBaseComponent

get seriesInternal(): any

Returns any

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

Inherited from: IgcPolarLineSeriesBaseComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

bindSeries

Inherited from: IgcPolarLineSeriesBaseComponent

bindSeries(series: IgcSeriesComponent[]): void

Parameters

series: IgcSeriesComponent[]

Returns void

canUseAsAngleAxis

Inherited from: IgcPolarLineSeriesBaseComponent

Determine if object can be used as AngleAxis

canUseAsAngleAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsRadiusAxis

Inherited from: IgcPolarLineSeriesBaseComponent

Determine if object can be used as RadiusAxis

canUseAsRadiusAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

findByName

Inherited from: IgcPolarLineSeriesBaseComponent

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

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

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

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgcPolarLineSeriesBaseComponent

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgcPolarLineSeriesBaseComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgcPolarLineSeriesBaseComponent

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgcPolarLineSeriesBaseComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgcPolarLineSeriesBaseComponent

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgcPolarLineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgcPolarLineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgcPolarLineSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgcPolarLineSeriesBaseComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgcPolarLineSeriesBaseComponent

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgcPolarLineSeriesBaseComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgcPolarLineSeriesBaseComponent

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Inherited from: IgcPolarLineSeriesBaseComponent

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgcPolarLineSeriesBaseComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Inherited from: IgcPolarLineSeriesBaseComponent

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgcPolarLineSeriesBaseComponent

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

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

_createFromInternal(internal: any): IgcSeriesComponent

Parameters

internal: any

Returns IgcSeriesComponent

register

register(): void