Represents a DataChartComponent range area series.

The RangeAreaSeries class represents the range area series of the DataChartComponent.

IgcRangeAreaSeriesComponent

new IgcRangeAreaSeriesComponent(): IgcRangeAreaSeriesComponent

Returns IgcRangeAreaSeriesComponent

htmlTagName: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualAreaFillOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualFocusBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualFocusMode: SeriesSelectionMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualHighlightedValuesFadeOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualHighlightingFadeOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualHitTestMode: SeriesHitTestMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualLayers: IgcSeriesLayerCollection

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualLegendItemBadgeBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualLegendItemBadgeOutline: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualMarkerBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualMarkerFillOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualMarkerOutline: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualMarkerTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualMarkerType: MarkerType

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualOutline: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualResolution: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualSelectionBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualSelectionMode: SeriesSelectionMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

actualThickness: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

areaFillOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

assigningCategoryMarkerStyle: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

assigningCategoryStyle: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

attachTooltipToRoot: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

autoCalloutLabelFormat: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgcHorizontalRangeCategorySeriesComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgcHorizontalRangeCategorySeriesComponent

brush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

categoryCollisionMode: CategoryCollisionMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

coercionMethods: any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

dashArray: number[]

Inherited from: IgcHorizontalRangeCategorySeriesComponent

dataLegendGroup: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

dataSource: any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

discreteLegendItemTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

expectFunctions: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

finalValue: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

focusBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedDataSource: any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedHighMemberPath: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedLegendItemVisibility: Visibility

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedLowMemberPath: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedTitleSuffix: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedValuesDataLegendGroup: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightedValuesFadeOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highlightingFadeOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highMemberAsLegendLabel: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highMemberAsLegendUnit: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

highMemberPath: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

hitTestMode: SeriesHitTestMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

index: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isActualLegendFinancial: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isComponentHighlightingModeIgnored: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isCustomCategoryMarkerStyleAllowed: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isCustomCategoryStyleAllowed: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isCustomMarkerCircular: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isDefaultToolTipSelected: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isDropShadowEnabled: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isHighlightingEnabled: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

isTransitionInEnabled: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

layers: IgcSeriesLayerCollection

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legend: any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legendItemTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

legendItemVisibility: Visibility

Inherited from: IgcHorizontalRangeCategorySeriesComponent

lineCap: PenLineCap

Inherited from: IgcHorizontalRangeCategorySeriesComponent

lineJoin: PenLineJoin

Inherited from: IgcHorizontalRangeCategorySeriesComponent

lowMemberAsLegendLabel: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

lowMemberAsLegendUnit: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

lowMemberPath: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerFillMode: MarkerFillMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerFillOpacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerOutline: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerOutlineMode: MarkerOutlineMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerSize: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerTemplate: IgDataTemplate

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerThickness: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

markerType: MarkerType

Inherited from: IgcHorizontalRangeCategorySeriesComponent

mouseOverEnabled: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

name: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

opacity: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

outline: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

outlineMode: SeriesOutlineMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

percentChange: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

renderRequested: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

resolution: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

safeActualBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

selectionBrush: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

selectionThickness: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shadowBlur: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shadowColor: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shadowOffsetX: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shadowOffsetY: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

showDefaultTooltip: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

thickness: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

title: any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

tooltipContainerTemplate: TemplateFunction

Inherited from: IgcHorizontalRangeCategorySeriesComponent

tooltipTemplate: TemplateFunction

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionDuration: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionEasingFunction: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionInDuration: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionInEasingFunction: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionInMode: CategoryTransitionInMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionOutCompleted: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionOutDuration: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionOutEasingFunction: object

Inherited from: IgcHorizontalRangeCategorySeriesComponent

transitionOutSpeedType: TransitionOutSpeedType

Inherited from: IgcHorizontalRangeCategorySeriesComponent

useHighMarkerFidelity: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

useItemWiseColors: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

useSingleShadow: boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibility: Visibility

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibleRangeMarginBottom: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibleRangeMarginLeft: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibleRangeMarginRight: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibleRangeMarginTop: number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

visibleRangeMode: SeriesVisibleRangeMode

Inherited from: IgcHorizontalRangeCategorySeriesComponent

xAxis: IgcCategoryAxisBaseComponent

Inherited from: IgcHorizontalRangeCategorySeriesComponent

xAxisName: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

yAxis: IgcNumericYAxisComponent

Inherited from: IgcHorizontalRangeCategorySeriesComponent

yAxisName: string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualCloseLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualHighLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualLowLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualOpenLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualRadiusLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualValueLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get actualVolumeLabel(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get isAnnotationDataLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is an annotation layer.

``

get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

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

Use the IsAreaOrLine property to check if the current series shows an area or line shape.

``

get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether or not this series is Category series

get isCategory(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a financial type series.

``

get isFinancial(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

``

get isIndexed(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

get isLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Checks if this series is a range series

You can use the IsRange to get the current series is a range type series.

``

get isRange(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is a stacked type series.

``

get isStacked(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets if the series should appear in any legends.

``

get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

get seriesInternal(): any

Returns any

get observedAttributes(): string[]

Returns string[]

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • name: string
  • oldValue: string
  • newValue: string

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

bindAxes(axes: IgcAxisComponent[]): void

Parameters

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

bindSeries(series: IgcSeriesComponent[]): void

Parameters

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    You can use the CanUseAsXAxis method to determine if object can be used as XAxis

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

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    You can use the CanUseAsYAxis method to determine if object can be used as YAxis

Returns boolean

connectedCallback(): void

Returns void

disconnectedCallback(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

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

 var x = this.financialSeries.CanUseAsXAxis(this.xAxis);
 N/A
getCategoryWidth(): number

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets the index of the item based on world coordinates.

getItemIndex(world: IgPoint): number

Parameters

  • world: IgPoint
    • The world coordinates to use.

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgcHorizontalRangeCategorySeriesComponent

getMainContentViewport(): IgRect

Returns IgRect

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

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

  var g = series.getOffsetValue();
 N/A
getOffsetValue(): number

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Returns number[]

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgcHorizontalRangeCategorySeriesComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

hideToolTips(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

hideToolTipsImmediate(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

notifyIndexedPropertiesChanged(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

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

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

scrollIntoView(item: any): boolean

Parameters

  • item: any
    • The data item (item) to scroll to.

    ScrollIntoView method Scrolls the series to display the item for the specified data item.

Returns boolean

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

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

Inherited from: IgcHorizontalRangeCategorySeriesComponent

_createFromInternal(internal: any): IgcSeriesComponent

Parameters

  • internal: any

Returns IgcSeriesComponent

register(): void

Returns void