IgrRadialColumnSeries

Represents a DataChartComponent radial column series. Compare values across categories by using radial rectangles.

Constructors

new IgrRadialColumnSeries(props: IIgrRadialColumnSeriesProps): IgrRadialColumnSeries

Returns IgrRadialColumnSeries

Properties

actualAreaFillOpacity

Inherited from: IgrAnchoredRadialSeries

actualAreaFillOpacity: number

actualBrush

Inherited from: IgrAnchoredRadialSeries

actualBrush: string

actualFocusBrush

Inherited from: IgrAnchoredRadialSeries

actualFocusBrush: string

actualFocusMode

Inherited from: IgrAnchoredRadialSeries

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgrAnchoredRadialSeries

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgrAnchoredRadialSeries

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgrAnchoredRadialSeries

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgrAnchoredRadialSeries

actualHitTestMode: SeriesHitTestMode

actualLayers

Inherited from: IgrAnchoredRadialSeries

actualLayers: IgrSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgrAnchoredRadialSeries

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgrAnchoredRadialSeries

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgrAnchoredRadialSeries

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgrAnchoredRadialSeries

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgrAnchoredRadialSeries

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgrAnchoredRadialSeries

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgrAnchoredRadialSeries

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgrAnchoredRadialSeries

actualMarkerType: MarkerType

actualOutline

Inherited from: IgrAnchoredRadialSeries

actualOutline: string

actualResolution

Inherited from: IgrAnchoredRadialSeries

actualResolution: number

actualSelectionBrush

Inherited from: IgrAnchoredRadialSeries

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgrAnchoredRadialSeries

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgrAnchoredRadialSeries

actualThickness: number

actualTrendLineBrush

Inherited from: IgrAnchoredRadialSeries

actualTrendLineBrush: string

angleAxis

Inherited from: IgrAnchoredRadialSeries

angleAxis: IgrCategoryAngleAxis

angleAxisName

Inherited from: IgrAnchoredRadialSeries

angleAxisName: string

areaFillOpacity

Inherited from: IgrAnchoredRadialSeries

areaFillOpacity: number

assigningRadialMarkerStyle

Inherited from: IgrAnchoredRadialSeries

assigningRadialMarkerStyle: object

assigningRadialStyle

Inherited from: IgrAnchoredRadialSeries

assigningRadialStyle: object

attachTooltipToRoot

Inherited from: IgrAnchoredRadialSeries

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgrAnchoredRadialSeries

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutLabelPrecision

Inherited from: IgrAnchoredRadialSeries

autoCalloutLabelPrecision: number

autoCalloutLabelValueSeparator

Inherited from: IgrAnchoredRadialSeries

autoCalloutLabelValueSeparator: string

autoCalloutOthersLabelFormat

Inherited from: IgrAnchoredRadialSeries

autoCalloutOthersLabelFormat: string

autoCalloutOthersLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

autoCalloutOthersLabelFormatSpecifiers: any[]

autoCalloutPercentagePrecision

Inherited from: IgrAnchoredRadialSeries

autoCalloutPercentagePrecision: number

autoCalloutRadialLabelMode

Inherited from: IgrAnchoredRadialSeries

autoCalloutRadialLabelMode: RadialLabelMode

autoCalloutValueLabelFormat

Inherited from: IgrAnchoredRadialSeries

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgrAnchoredRadialSeries

brush: string

categoryCollisionMode

Inherited from: IgrAnchoredRadialSeries

categoryCollisionMode: CategoryCollisionMode

clipSeriesToBounds

Inherited from: IgrAnchoredRadialSeries

clipSeriesToBounds: boolean

coercionMethods

Inherited from: IgrAnchoredRadialSeries

coercionMethods: any

dashArray

Inherited from: IgrAnchoredRadialSeries

dashArray: number[]

dataLegendGroup

Inherited from: IgrAnchoredRadialSeries

dataLegendGroup: string

dataSource

Inherited from: IgrAnchoredRadialSeries

dataSource: any

discreteLegendItemTemplate

Inherited from: IgrAnchoredRadialSeries

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgrAnchoredRadialSeries

expectFunctions: boolean

finalValue

Inherited from: IgrAnchoredRadialSeries

finalValue: number

focusBrush

Inherited from: IgrAnchoredRadialSeries

focusBrush: string

highlightedDataSource

Inherited from: IgrAnchoredRadialSeries

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgrAnchoredRadialSeries

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgrAnchoredRadialSeries

highlightedTitleSuffix: string

highlightedValueMemberPath

Inherited from: IgrAnchoredRadialSeries

highlightedValueMemberPath: string

highlightedValuesDataLegendGroup

Inherited from: IgrAnchoredRadialSeries

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgrAnchoredRadialSeries

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgrAnchoredRadialSeries

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgrAnchoredRadialSeries

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgrAnchoredRadialSeries

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgrAnchoredRadialSeries

hitTestMode: SeriesHitTestMode

index

Inherited from: IgrAnchoredRadialSeries

index: number

isActualLegendFinancial

Inherited from: IgrAnchoredRadialSeries

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgrAnchoredRadialSeries

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgrAnchoredRadialSeries

isCustomMarkerCircular: boolean

isCustomRadialMarkerStyleAllowed

Inherited from: IgrAnchoredRadialSeries

isCustomRadialMarkerStyleAllowed: boolean

isCustomRadialStyleAllowed

Inherited from: IgrAnchoredRadialSeries

isCustomRadialStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgrAnchoredRadialSeries

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgrAnchoredRadialSeries

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgrAnchoredRadialSeries

isHighlightingEnabled: boolean

isTransitionInEnabled

Inherited from: IgrAnchoredRadialSeries

isTransitionInEnabled: boolean

layers

Inherited from: IgrAnchoredRadialSeries

layers: IgrSeriesLayerCollection

legend

Inherited from: IgrAnchoredRadialSeries

legend: any

legendItemBadgeMode

Inherited from: IgrAnchoredRadialSeries

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgrAnchoredRadialSeries

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgrAnchoredRadialSeries

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgrAnchoredRadialSeries

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgrAnchoredRadialSeries

legendItemVisibility: Visibility

legendProportionalRadialLabelFormat

Inherited from: IgrAnchoredRadialSeries

legendProportionalRadialLabelFormat: string

legendProportionalRadialLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

legendProportionalRadialLabelFormatSpecifiers: any[]

legendRadialLabelMode

Inherited from: IgrAnchoredRadialSeries

legendRadialLabelMode: RadialLabelMode

lineCap

Inherited from: IgrAnchoredRadialSeries

lineCap: PenLineCap

lineJoin

Inherited from: IgrAnchoredRadialSeries

lineJoin: PenLineJoin

markerBrush

Inherited from: IgrAnchoredRadialSeries

markerBrush: string

markerFillMode

Inherited from: IgrAnchoredRadialSeries

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgrAnchoredRadialSeries

markerFillOpacity: number

markerOutline

Inherited from: IgrAnchoredRadialSeries

markerOutline: string

markerOutlineMode

Inherited from: IgrAnchoredRadialSeries

markerOutlineMode: MarkerOutlineMode

markerTemplate

Inherited from: IgrAnchoredRadialSeries

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgrAnchoredRadialSeries

markerThickness: number

markerType

Inherited from: IgrAnchoredRadialSeries

markerType: MarkerType

mouseOverEnabled

Inherited from: IgrAnchoredRadialSeries

mouseOverEnabled: boolean

name

Inherited from: IgrAnchoredRadialSeries

name: string

opacity

Inherited from: IgrAnchoredRadialSeries

opacity: number

othersCategoryBrush

Inherited from: IgrAnchoredRadialSeries

othersCategoryBrush: string

othersCategoryOutline

Inherited from: IgrAnchoredRadialSeries

othersCategoryOutline: string

othersLegendProportionalRadialLabelFormat

Inherited from: IgrAnchoredRadialSeries

othersLegendProportionalRadialLabelFormat: string

othersLegendProportionalRadialLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

othersLegendProportionalRadialLabelFormatSpecifiers: any[]

othersProportionalRadialLabelFormat

Inherited from: IgrAnchoredRadialSeries

othersProportionalRadialLabelFormat: string

othersProportionalRadialLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

othersProportionalRadialLabelFormatSpecifiers: any[]

outline

Inherited from: IgrAnchoredRadialSeries

outline: string

outlineMode

Inherited from: IgrAnchoredRadialSeries

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgrAnchoredRadialSeries

percentChange: number

proportionalRadialLabelFormat

Inherited from: IgrAnchoredRadialSeries

proportionalRadialLabelFormat: string

proportionalRadialLabelFormatSpecifiers

Inherited from: IgrAnchoredRadialSeries

proportionalRadialLabelFormatSpecifiers: any[]

radiusX

radiusX: number

radiusY

radiusY: number

renderRequested

Inherited from: IgrAnchoredRadialSeries

renderRequested: object

resolution

Inherited from: IgrAnchoredRadialSeries

resolution: number

safeActualBrush

Inherited from: IgrAnchoredRadialSeries

safeActualBrush: string

selectionBrush

Inherited from: IgrAnchoredRadialSeries

selectionBrush: string

selectionThickness

Inherited from: IgrAnchoredRadialSeries

selectionThickness: number

shadowBlur

Inherited from: IgrAnchoredRadialSeries

shadowBlur: number

shadowColor

Inherited from: IgrAnchoredRadialSeries

shadowColor: string

shadowOffsetX

Inherited from: IgrAnchoredRadialSeries

shadowOffsetX: number

shadowOffsetY

Inherited from: IgrAnchoredRadialSeries

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgrAnchoredRadialSeries

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgrAnchoredRadialSeries

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrAnchoredRadialSeries

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrAnchoredRadialSeries

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgrAnchoredRadialSeries

showDefaultTooltip: boolean

thickness

Inherited from: IgrAnchoredRadialSeries

thickness: number

title

Inherited from: IgrAnchoredRadialSeries

title: any

tooltipContainerTemplate

Inherited from: IgrAnchoredRadialSeries

tooltipContainerTemplate: any

tooltipTemplate

Inherited from: IgrAnchoredRadialSeries

tooltipTemplate: any

transitionDuration

Inherited from: IgrAnchoredRadialSeries

transitionDuration: number

transitionEasingFunction

Inherited from: IgrAnchoredRadialSeries

transitionEasingFunction: object

transitionInDuration

Inherited from: IgrAnchoredRadialSeries

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgrAnchoredRadialSeries

transitionInEasingFunction: object

transitionInMode

Inherited from: IgrAnchoredRadialSeries

transitionInMode: CategoryTransitionInMode

transitionInSpeedType

Inherited from: IgrAnchoredRadialSeries

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgrAnchoredRadialSeries

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgrAnchoredRadialSeries

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgrAnchoredRadialSeries

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgrAnchoredRadialSeries

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

Inherited from: IgrAnchoredRadialSeries

trendLineBrush: string

trendLineDashArray

Inherited from: IgrAnchoredRadialSeries

trendLineDashArray: number[]

trendLinePeriod

Inherited from: IgrAnchoredRadialSeries

trendLinePeriod: number

trendLineThickness

Inherited from: IgrAnchoredRadialSeries

trendLineThickness: number

trendLineType

Inherited from: IgrAnchoredRadialSeries

trendLineType: TrendLineType

trendLineZIndex

Inherited from: IgrAnchoredRadialSeries

trendLineZIndex: number

useCategoryNormalizedValues

Inherited from: IgrAnchoredRadialSeries

useCategoryNormalizedValues: boolean

useItemWiseColors

Inherited from: IgrAnchoredRadialSeries

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgrAnchoredRadialSeries

useSingleShadow: boolean

valueAxis

Inherited from: IgrAnchoredRadialSeries

valueAxis: IgrNumericRadiusAxis

valueAxisName

Inherited from: IgrAnchoredRadialSeries

valueAxisName: string

valueMemberAsLegendLabel

Inherited from: IgrAnchoredRadialSeries

valueMemberAsLegendLabel: string

valueMemberAsLegendUnit

Inherited from: IgrAnchoredRadialSeries

valueMemberAsLegendUnit: string

valueMemberPath

Inherited from: IgrAnchoredRadialSeries

valueMemberPath: string

visibility

Inherited from: IgrAnchoredRadialSeries

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgrAnchoredRadialSeries

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgrAnchoredRadialSeries

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgrAnchoredRadialSeries

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgrAnchoredRadialSeries

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgrAnchoredRadialSeries

visibleRangeMode: SeriesVisibleRangeMode

Accessors

actualCloseLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgrAnchoredRadialSeries

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgrAnchoredRadialSeries

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgrAnchoredRadialSeries

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgrAnchoredRadialSeries

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

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrAnchoredRadialSeries

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrAnchoredRadialSeries

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgrAnchoredRadialSeries

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

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrAnchoredRadialSeries

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrAnchoredRadialSeries

get isColoredItemwise(): boolean

Returns boolean

isColumn

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrAnchoredRadialSeries

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

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrAnchoredRadialSeries

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrAnchoredRadialSeries

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

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Overridden by derived series classes to indicate when marker-less display is preferred or not.

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrAnchoredRadialSeries

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrAnchoredRadialSeries

Checks if this series is a radial series

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrAnchoredRadialSeries

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrAnchoredRadialSeries

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrAnchoredRadialSeries

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrAnchoredRadialSeries

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgrAnchoredRadialSeries

get seriesInternal(): any

Returns any

i

get i(): Series

Returns Series

Methods

bindAxes

Inherited from: IgrAnchoredRadialSeries

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

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrAnchoredRadialSeries

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

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

canUseAsAngleAxis

Inherited from: IgrAnchoredRadialSeries

Determine if object can be used as AngleAxis

canUseAsAngleAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsValueAxis

Inherited from: IgrAnchoredRadialSeries

Determine if object can be used as ValueAxis

canUseAsValueAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

componentDidMount

Inherited from: IgrAnchoredRadialSeries

componentDidMount(): void

Returns void

findByName

Inherited from: IgrAnchoredRadialSeries

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrAnchoredRadialSeries

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

getAngleFromWorld

Inherited from: IgrAnchoredRadialSeries

Gets the angle to the provided world position from the center of the radial series.

getAngleFromWorld(world: IgPoint): number

Parameters

world: IgPoint
- The world position to get the angle for

Returns number

getCategoryWidth

Inherited from: IgrAnchoredRadialSeries

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

getCategoryWidth(): number

Returns number

getEffectiveViewport

Inherited from: IgrAnchoredRadialSeries

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrAnchoredRadialSeries

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

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

Get the index of the item near the provided world coordinates.

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint
- The world coordinates for which to getch the item index.

Returns number

getItemSpan

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

getItemSpan(): number

Returns number

getItemValue

Inherited from: IgrAnchoredRadialSeries

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrAnchoredRadialSeries

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgrAnchoredRadialSeries

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

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getOffsetValue

Inherited from: IgrAnchoredRadialSeries

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

getOffsetValue(): number

Returns number

getPreviousOrExactIndex

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrAnchoredRadialSeries

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrAnchoredRadialSeries

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

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrAnchoredRadialSeries

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

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrAnchoredRadialSeries

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrAnchoredRadialSeries

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrAnchoredRadialSeries

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrAnchoredRadialSeries

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

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgrAnchoredRadialSeries

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrAnchoredRadialSeries

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

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

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

notifyVisualPropertiesChanged(): void

Returns void

onApplyTemplate

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.

onApplyTemplate(): void

Returns void

playTransitionIn

Inherited from: IgrAnchoredRadialSeries

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrAnchoredRadialSeries

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrAnchoredRadialSeries

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrAnchoredRadialSeries

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrAnchoredRadialSeries

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrAnchoredRadialSeries

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrAnchoredRadialSeries

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrAnchoredRadialSeries

render(): any

Returns any

renderSeries

Inherited from: IgrAnchoredRadialSeries

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

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrAnchoredRadialSeries

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrAnchoredRadialSeries

Scrolls the specified item into the view.

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to scroll into view.

Returns boolean

setNegativeColors

Inherited from: IgrAnchoredRadialSeries

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrAnchoredRadialSeries

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrAnchoredRadialSeries

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrAnchoredRadialSeries

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

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

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any