Base class for stacked series with a category x-axis and a numeric y-axis.

IgcHorizontalStackedSeriesBaseComponent

new IgcHorizontalStackedSeriesBaseComponent(): IgcHorizontalStackedSeriesBaseComponent

Returns IgcHorizontalStackedSeriesBaseComponent

Inherited from: IgcStackedSeriesBaseComponent

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

actualSeries: IgcStackedFragmentSeriesComponent[]

Inherited from: IgcStackedSeriesBaseComponent

contentSeries: IgcStackedFragmentSeriesComponent[]

Inherited from: IgcStackedSeriesBaseComponent

actualAreaFillOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

actualBrush: string

Inherited from: IgcStackedSeriesBaseComponent

actualFocusBrush: string

Inherited from: IgcStackedSeriesBaseComponent

actualFocusMode: SeriesSelectionMode

Inherited from: IgcStackedSeriesBaseComponent

actualHighlightedValuesFadeOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

actualHighlightingFadeOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgcStackedSeriesBaseComponent

actualHitTestMode: SeriesHitTestMode

Inherited from: IgcStackedSeriesBaseComponent

actualLayers: IgcSeriesLayerCollection

Inherited from: IgcStackedSeriesBaseComponent

actualLegendItemBadgeBrush: string

Inherited from: IgcStackedSeriesBaseComponent

actualLegendItemBadgeOutline: string

Inherited from: IgcStackedSeriesBaseComponent

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

actualMarkerBrush: string

Inherited from: IgcStackedSeriesBaseComponent

actualMarkerFillOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

actualMarkerOutline: string

Inherited from: IgcStackedSeriesBaseComponent

actualMarkerTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

actualMarkerType: MarkerType

Inherited from: IgcStackedSeriesBaseComponent

actualOutline: string

Inherited from: IgcStackedSeriesBaseComponent

actualResolution: number

Inherited from: IgcStackedSeriesBaseComponent

actualSelectionBrush: string

Inherited from: IgcStackedSeriesBaseComponent

actualSelectionMode: SeriesSelectionMode

Inherited from: IgcStackedSeriesBaseComponent

actualThickness: number

Inherited from: IgcStackedSeriesBaseComponent

areaFillOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

assigningCategoryMarkerStyle: object

Inherited from: IgcStackedSeriesBaseComponent

assigningCategoryStyle: object

Inherited from: IgcStackedSeriesBaseComponent

attachTooltipToRoot: boolean

Inherited from: IgcStackedSeriesBaseComponent

autoCalloutLabelFormat: string

Inherited from: IgcStackedSeriesBaseComponent

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgcStackedSeriesBaseComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgcStackedSeriesBaseComponent

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgcStackedSeriesBaseComponent

autoGenerateSeries: boolean

Inherited from: IgcStackedSeriesBaseComponent

brush: string

Inherited from: IgcStackedSeriesBaseComponent

categoryCollisionMode: CategoryCollisionMode

Inherited from: IgcStackedSeriesBaseComponent

coercionMethods: any

Inherited from: IgcStackedSeriesBaseComponent

dashArray: number[]

Inherited from: IgcStackedSeriesBaseComponent

dataLegendGroup: string

Inherited from: IgcStackedSeriesBaseComponent

dataSource: any

Inherited from: IgcStackedSeriesBaseComponent

discreteLegendItemTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

expectFunctions: boolean

Inherited from: IgcStackedSeriesBaseComponent

finalValue: number

Inherited from: IgcStackedSeriesBaseComponent

focusBrush: string

Inherited from: IgcStackedSeriesBaseComponent

highlightedDataSource: any

Inherited from: IgcStackedSeriesBaseComponent

highlightedLegendItemVisibility: Visibility

Inherited from: IgcStackedSeriesBaseComponent

highlightedTitleSuffix: string

Inherited from: IgcStackedSeriesBaseComponent

highlightedValuesDataLegendGroup: string

Inherited from: IgcStackedSeriesBaseComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgcStackedSeriesBaseComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

Inherited from: IgcStackedSeriesBaseComponent

highlightedValuesFadeOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

highlightingFadeOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

hitTestMode: SeriesHitTestMode

Inherited from: IgcStackedSeriesBaseComponent

index: number

Inherited from: IgcStackedSeriesBaseComponent

isActualLegendFinancial: boolean

Inherited from: IgcStackedSeriesBaseComponent

isComponentHighlightingModeIgnored: boolean

Inherited from: IgcStackedSeriesBaseComponent

isCustomCategoryMarkerStyleAllowed: boolean

Inherited from: IgcStackedSeriesBaseComponent

isCustomCategoryStyleAllowed: boolean

Inherited from: IgcStackedSeriesBaseComponent

isCustomMarkerCircular: boolean

Inherited from: IgcStackedSeriesBaseComponent

isDefaultToolTipSelected: boolean

Inherited from: IgcStackedSeriesBaseComponent

isDropShadowEnabled: boolean

Inherited from: IgcStackedSeriesBaseComponent

isHighlightingEnabled: boolean

Inherited from: IgcStackedSeriesBaseComponent

isTransitionInEnabled: boolean

Inherited from: IgcStackedSeriesBaseComponent

layers: IgcSeriesLayerCollection

Inherited from: IgcStackedSeriesBaseComponent

legend: any

Inherited from: IgcStackedSeriesBaseComponent

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgcStackedSeriesBaseComponent

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgcStackedSeriesBaseComponent

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

legendItemTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

legendItemVisibility: Visibility

Inherited from: IgcStackedSeriesBaseComponent

lineCap: PenLineCap

Inherited from: IgcStackedSeriesBaseComponent

lineJoin: PenLineJoin

Inherited from: IgcStackedSeriesBaseComponent

markerBrush: string

Inherited from: IgcStackedSeriesBaseComponent

markerFillMode: MarkerFillMode

Inherited from: IgcStackedSeriesBaseComponent

markerFillOpacity: number

Inherited from: IgcStackedSeriesBaseComponent

markerOutline: string

Inherited from: IgcStackedSeriesBaseComponent

markerOutlineMode: MarkerOutlineMode

Inherited from: IgcStackedSeriesBaseComponent

markerSize: number

Inherited from: IgcStackedSeriesBaseComponent

markerTemplate: IgDataTemplate

Inherited from: IgcStackedSeriesBaseComponent

markerThickness: number

Inherited from: IgcStackedSeriesBaseComponent

markerType: MarkerType

Inherited from: IgcStackedSeriesBaseComponent

mouseOverEnabled: boolean

Inherited from: IgcStackedSeriesBaseComponent

name: string

Inherited from: IgcStackedSeriesBaseComponent

opacity: number

Inherited from: IgcStackedSeriesBaseComponent

outline: string

Inherited from: IgcStackedSeriesBaseComponent

outlineMode: SeriesOutlineMode

Inherited from: IgcStackedSeriesBaseComponent

percentChange: number

Inherited from: IgcStackedSeriesBaseComponent

renderRequested: object

Inherited from: IgcStackedSeriesBaseComponent

resolution: number

Inherited from: IgcStackedSeriesBaseComponent

reverseLegendOrder: boolean

Inherited from: IgcStackedSeriesBaseComponent

safeActualBrush: string

Inherited from: IgcStackedSeriesBaseComponent

selectionBrush: string

Inherited from: IgcStackedSeriesBaseComponent

selectionThickness: number

Inherited from: IgcStackedSeriesBaseComponent

seriesCreated: object

Inherited from: IgcStackedSeriesBaseComponent

shadowBlur: number

Inherited from: IgcStackedSeriesBaseComponent

shadowColor: string

Inherited from: IgcStackedSeriesBaseComponent

shadowOffsetX: number

Inherited from: IgcStackedSeriesBaseComponent

shadowOffsetY: number

Inherited from: IgcStackedSeriesBaseComponent

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgcStackedSeriesBaseComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgcStackedSeriesBaseComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgcStackedSeriesBaseComponent

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgcStackedSeriesBaseComponent

showDefaultTooltip: boolean

Inherited from: IgcStackedSeriesBaseComponent

thickness: number

Inherited from: IgcStackedSeriesBaseComponent

title: any

Inherited from: IgcStackedSeriesBaseComponent

tooltipContainerTemplate: TemplateFunction

Inherited from: IgcStackedSeriesBaseComponent

tooltipTemplate: TemplateFunction

Inherited from: IgcStackedSeriesBaseComponent

transitionDuration: number

Inherited from: IgcStackedSeriesBaseComponent

transitionEasingFunction: object

Inherited from: IgcStackedSeriesBaseComponent

transitionInDuration: number

Inherited from: IgcStackedSeriesBaseComponent

transitionInEasingFunction: object

Inherited from: IgcStackedSeriesBaseComponent

transitionInMode: CategoryTransitionInMode

Inherited from: IgcStackedSeriesBaseComponent

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgcStackedSeriesBaseComponent

transitionOutCompleted: object

Inherited from: IgcStackedSeriesBaseComponent

transitionOutDuration: number

Inherited from: IgcStackedSeriesBaseComponent

transitionOutEasingFunction: object

Inherited from: IgcStackedSeriesBaseComponent

transitionOutSpeedType: TransitionOutSpeedType

Inherited from: IgcStackedSeriesBaseComponent

useHighMarkerFidelity: boolean

Inherited from: IgcStackedSeriesBaseComponent

useItemWiseColors: boolean

Inherited from: IgcStackedSeriesBaseComponent

useSingleShadow: boolean

Inherited from: IgcStackedSeriesBaseComponent

visibility: Visibility

Inherited from: IgcStackedSeriesBaseComponent

visibleRangeMarginBottom: number

Inherited from: IgcStackedSeriesBaseComponent

visibleRangeMarginLeft: number

Inherited from: IgcStackedSeriesBaseComponent

visibleRangeMarginRight: number

Inherited from: IgcStackedSeriesBaseComponent

visibleRangeMarginTop: number

Inherited from: IgcStackedSeriesBaseComponent

visibleRangeMode: SeriesVisibleRangeMode
xAxis: IgcCategoryAxisBaseComponent
xAxisName: string
yAxis: IgcNumericYAxisComponent
yAxisName: string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualCloseLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualHighLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualLowLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualOpenLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualRadiusLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualValueLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get actualVolumeLabel(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

Gets whether the series is an annotation layer.

``

get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

``

get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether or not this series is Category series

get isCategory(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

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

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a financial type series.

``

get isFinancial(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

``

get isIndexed(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

get isLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

get isPercentBased(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Checks if this series is a stacked series

get isStacked(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

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

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets if the series should appear in any legends.

``

get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgcStackedSeriesBaseComponent

A collection or manually added series for the chart.

get series(): IgcStackedSeriesCollection

Returns IgcStackedSeriesCollection

Inherited from: IgcStackedSeriesBaseComponent

get seriesInternal(): any

Returns any

get observedAttributes(): string[]

Returns string[]

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns void

bindAxes(axes: IgcAxisComponent[]): void

Parameters

Returns void

Inherited from: IgcStackedSeriesBaseComponent

bindSeries(series: IgcSeriesComponent[]): void

Parameters

Returns void

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

Returns boolean

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

Returns boolean

connectedCallback(): void

Returns void

disconnectedCallback(): void

Returns void

findByName(name: string): any

Parameters

  • name: string

Returns any

Inherited from: IgcStackedSeriesBaseComponent

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

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

getCategoryWidth(): number

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

Inherited from: IgcStackedSeriesBaseComponent

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

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

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgcStackedSeriesBaseComponent

getMainContentViewport(): IgRect

Returns IgRect

Inherited from: IgcStackedSeriesBaseComponent

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

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

getOffsetValue(): number

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

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

Parameters

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

Returns number

Inherited from: IgcStackedSeriesBaseComponent

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgcStackedSeriesBaseComponent

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

Parameters

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

Returns IgPoint

Inherited from: IgcStackedSeriesBaseComponent

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

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"

Inherited from: IgcStackedSeriesBaseComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

Inherited from: IgcStackedSeriesBaseComponent

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

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

hideToolTips(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

hideToolTipsImmediate(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

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

notifyIndexedPropertiesChanged(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgcStackedSeriesBaseComponent

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgcStackedSeriesBaseComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

Inherited from: IgcStackedSeriesBaseComponent

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

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

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

Inherited from: IgcStackedSeriesBaseComponent

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

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

_createFromInternal(internal: any): IgcStackedSeriesBaseComponent

Parameters

  • internal: any

Returns IgcStackedSeriesBaseComponent