Represents a DataChartComponent stacked area series.

IgrStackedAreaSeries

new IgrStackedAreaSeries(props: P): IgrStackedAreaSeries

Returns IgrStackedAreaSeries

Inherited from: IgrHorizontalStackedSeriesBase

The series actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing series from the manual series collection on the series property.

actualSeries: IgrStackedFragmentSeries<IIgrStackedFragmentSeriesProps>[]

Inherited from: IgrHorizontalStackedSeriesBase

contentSeries: IgrStackedFragmentSeries<IIgrStackedFragmentSeriesProps>[]

Inherited from: IgrHorizontalStackedSeriesBase

actualAreaFillOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

actualBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

actualFocusBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

actualFocusMode: SeriesSelectionMode

Inherited from: IgrHorizontalStackedSeriesBase

actualHighlightedValuesFadeOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

actualHighlightingFadeOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgrHorizontalStackedSeriesBase

actualHitTestMode: SeriesHitTestMode

Inherited from: IgrHorizontalStackedSeriesBase

actualLayers: IgrSeriesLayerCollection

Inherited from: IgrHorizontalStackedSeriesBase

actualLegendItemBadgeBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

actualLegendItemBadgeOutline: string

Inherited from: IgrHorizontalStackedSeriesBase

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

actualMarkerBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

actualMarkerFillOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

actualMarkerOutline: string

Inherited from: IgrHorizontalStackedSeriesBase

actualMarkerTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

actualMarkerType: MarkerType

Inherited from: IgrHorizontalStackedSeriesBase

actualOutline: string

Inherited from: IgrHorizontalStackedSeriesBase

actualResolution: number

Inherited from: IgrHorizontalStackedSeriesBase

actualSelectionBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

actualSelectionMode: SeriesSelectionMode

Inherited from: IgrHorizontalStackedSeriesBase

actualThickness: number

Inherited from: IgrHorizontalStackedSeriesBase

areaFillOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

assigningCategoryMarkerStyle: object

Inherited from: IgrHorizontalStackedSeriesBase

assigningCategoryStyle: object

Inherited from: IgrHorizontalStackedSeriesBase

attachTooltipToRoot: boolean

Inherited from: IgrHorizontalStackedSeriesBase

autoCalloutLabelFormat: string

Inherited from: IgrHorizontalStackedSeriesBase

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgrHorizontalStackedSeriesBase

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgrHorizontalStackedSeriesBase

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgrHorizontalStackedSeriesBase

autoGenerateSeries: boolean

Inherited from: IgrHorizontalStackedSeriesBase

brush: string

Inherited from: IgrHorizontalStackedSeriesBase

categoryCollisionMode: CategoryCollisionMode

Inherited from: IgrHorizontalStackedSeriesBase

coercionMethods: any

Inherited from: IgrHorizontalStackedSeriesBase

dashArray: number[]

Inherited from: IgrHorizontalStackedSeriesBase

dataLegendGroup: string

Inherited from: IgrHorizontalStackedSeriesBase

dataSource: any

Inherited from: IgrHorizontalStackedSeriesBase

discreteLegendItemTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

expectFunctions: boolean

Inherited from: IgrHorizontalStackedSeriesBase

finalValue: number

Inherited from: IgrHorizontalStackedSeriesBase

focusBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

highlightedDataSource: any

Inherited from: IgrHorizontalStackedSeriesBase

highlightedLegendItemVisibility: Visibility

Inherited from: IgrHorizontalStackedSeriesBase

highlightedTitleSuffix: string

Inherited from: IgrHorizontalStackedSeriesBase

highlightedValuesDataLegendGroup: string

Inherited from: IgrHorizontalStackedSeriesBase

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgrHorizontalStackedSeriesBase

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

Inherited from: IgrHorizontalStackedSeriesBase

highlightedValuesFadeOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

highlightingFadeOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

hitTestMode: SeriesHitTestMode

Inherited from: IgrHorizontalStackedSeriesBase

index: number

Inherited from: IgrHorizontalStackedSeriesBase

isActualLegendFinancial: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isComponentHighlightingModeIgnored: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isCustomCategoryMarkerStyleAllowed: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isCustomCategoryStyleAllowed: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isCustomMarkerCircular: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isDefaultToolTipSelected: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isDropShadowEnabled: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isHighlightingEnabled: boolean

Inherited from: IgrHorizontalStackedSeriesBase

isTransitionInEnabled: boolean

Inherited from: IgrHorizontalStackedSeriesBase

layers: IgrSeriesLayerCollection

Inherited from: IgrHorizontalStackedSeriesBase

legend: any

Inherited from: IgrHorizontalStackedSeriesBase

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgrHorizontalStackedSeriesBase

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgrHorizontalStackedSeriesBase

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

legendItemTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

legendItemVisibility: Visibility

Inherited from: IgrHorizontalStackedSeriesBase

lineCap: PenLineCap

Inherited from: IgrHorizontalStackedSeriesBase

lineJoin: PenLineJoin

Inherited from: IgrHorizontalStackedSeriesBase

markerBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

markerFillMode: MarkerFillMode

Inherited from: IgrHorizontalStackedSeriesBase

markerFillOpacity: number

Inherited from: IgrHorizontalStackedSeriesBase

markerOutline: string

Inherited from: IgrHorizontalStackedSeriesBase

markerOutlineMode: MarkerOutlineMode

Inherited from: IgrHorizontalStackedSeriesBase

markerTemplate: IgDataTemplate

Inherited from: IgrHorizontalStackedSeriesBase

markerThickness: number

Inherited from: IgrHorizontalStackedSeriesBase

markerType: MarkerType

Inherited from: IgrHorizontalStackedSeriesBase

mouseOverEnabled: boolean

Inherited from: IgrHorizontalStackedSeriesBase

name: string

Inherited from: IgrHorizontalStackedSeriesBase

opacity: number

Inherited from: IgrHorizontalStackedSeriesBase

outline: string

Inherited from: IgrHorizontalStackedSeriesBase

outlineMode: SeriesOutlineMode

Inherited from: IgrHorizontalStackedSeriesBase

percentChange: number

Inherited from: IgrHorizontalStackedSeriesBase

renderRequested: object

Inherited from: IgrHorizontalStackedSeriesBase

resolution: number

Inherited from: IgrHorizontalStackedSeriesBase

reverseLegendOrder: boolean

Inherited from: IgrHorizontalStackedSeriesBase

safeActualBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

selectionBrush: string

Inherited from: IgrHorizontalStackedSeriesBase

selectionThickness: number

Inherited from: IgrHorizontalStackedSeriesBase

seriesCreated: object

Inherited from: IgrHorizontalStackedSeriesBase

shadowBlur: number

Inherited from: IgrHorizontalStackedSeriesBase

shadowColor: string

Inherited from: IgrHorizontalStackedSeriesBase

shadowOffsetX: number

Inherited from: IgrHorizontalStackedSeriesBase

shadowOffsetY: number

Inherited from: IgrHorizontalStackedSeriesBase

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgrHorizontalStackedSeriesBase

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgrHorizontalStackedSeriesBase

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgrHorizontalStackedSeriesBase

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgrHorizontalStackedSeriesBase

showDefaultTooltip: boolean

Inherited from: IgrHorizontalStackedSeriesBase

thickness: number

Inherited from: IgrHorizontalStackedSeriesBase

title: any

Inherited from: IgrHorizontalStackedSeriesBase

tooltipContainerTemplate: any

Inherited from: IgrHorizontalStackedSeriesBase

tooltipTemplate: any

Inherited from: IgrHorizontalStackedSeriesBase

transitionDuration: number

Inherited from: IgrHorizontalStackedSeriesBase

transitionEasingFunction: object

Inherited from: IgrHorizontalStackedSeriesBase

transitionInDuration: number

Inherited from: IgrHorizontalStackedSeriesBase

transitionInEasingFunction: object

Inherited from: IgrHorizontalStackedSeriesBase

transitionInMode: CategoryTransitionInMode

Inherited from: IgrHorizontalStackedSeriesBase

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgrHorizontalStackedSeriesBase

transitionOutCompleted: object

Inherited from: IgrHorizontalStackedSeriesBase

transitionOutDuration: number

Inherited from: IgrHorizontalStackedSeriesBase

transitionOutEasingFunction: object

Inherited from: IgrHorizontalStackedSeriesBase

transitionOutSpeedType: TransitionOutSpeedType

Inherited from: IgrHorizontalStackedSeriesBase

useHighMarkerFidelity: boolean

Inherited from: IgrHorizontalStackedSeriesBase

useItemWiseColors: boolean

Inherited from: IgrHorizontalStackedSeriesBase

useSingleShadow: boolean

Inherited from: IgrHorizontalStackedSeriesBase

visibility: Visibility

Inherited from: IgrHorizontalStackedSeriesBase

visibleRangeMarginBottom: number

Inherited from: IgrHorizontalStackedSeriesBase

visibleRangeMarginLeft: number

Inherited from: IgrHorizontalStackedSeriesBase

visibleRangeMarginRight: number

Inherited from: IgrHorizontalStackedSeriesBase

visibleRangeMarginTop: number

Inherited from: IgrHorizontalStackedSeriesBase

visibleRangeMode: SeriesVisibleRangeMode

Inherited from: IgrHorizontalStackedSeriesBase

xAxis: IgrCategoryAxisBase

Inherited from: IgrHorizontalStackedSeriesBase

xAxisName: string

Inherited from: IgrHorizontalStackedSeriesBase

yAxis: IgrNumericYAxis

Inherited from: IgrHorizontalStackedSeriesBase

yAxisName: string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualCloseLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualHighLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualLowLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualOpenLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualRadiusLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualValueLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get actualVolumeLabel(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

Gets whether the series is an annotation layer.

``

get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

Inherited from: IgrHorizontalStackedSeriesBase

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

``

get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether or not this series is Category series

get isCategory(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

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

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a financial type series.

``

get isFinancial(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

``

get isIndexed(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

get isLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

get isPercentBased(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Checks if this series is a stacked series

get isStacked(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets if the series should appear in any legends.

``

get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

A collection or manually added series for the chart.

get series(): IgrStackedSeriesCollection

Returns IgrStackedSeriesCollection

Inherited from: IgrHorizontalStackedSeriesBase

get seriesInternal(): any

Returns any

get i(): Series

Returns Series

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

componentDidMount(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgrHorizontalStackedSeriesBase

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

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

getCategoryWidth(): number

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

getEffectiveViewport(): IgRect

Returns IgRect

Inherited from: IgrHorizontalStackedSeriesBase

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

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

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgrHorizontalStackedSeriesBase

getMainContentViewport(): IgRect

Returns IgRect

Inherited from: IgrHorizontalStackedSeriesBase

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

getOffsetValue(): number

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns IgPoint

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns IgPoint

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

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

Parameters

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

Returns number

Inherited from: IgrHorizontalStackedSeriesBase

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

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

Returns IgPoint

Inherited from: IgrHorizontalStackedSeriesBase

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgrHorizontalStackedSeriesBase

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

Inherited from: IgrHorizontalStackedSeriesBase

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

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

hideToolTips(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

hideToolTipsImmediate(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

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

notifyIndexedPropertiesChanged(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

render(): DetailedReactHTMLElement<object, HTMLElement>

Returns DetailedReactHTMLElement<object, HTMLElement>

Inherited from: IgrHorizontalStackedSeriesBase

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

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

Inherited from: IgrHorizontalStackedSeriesBase

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.

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

Inherited from: IgrHorizontalStackedSeriesBase

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.

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

Called when this series' Style is updated.

styleUpdated(): void

Returns void

Inherited from: IgrHorizontalStackedSeriesBase

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

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

_createFromInternal(internal: any): IgrStackedSeriesBase

Parameters

  • internal: any

Returns IgrStackedSeriesBase