IgcScatterBaseComponent

Represents the base class for all DataChartComponent scatter series

Constructors

new IgcScatterBaseComponent(): IgcScatterBaseComponent

Returns IgcScatterBaseComponent

Properties

actualAreaFillOpacity

Inherited from: IgcMarkerSeriesComponent

actualAreaFillOpacity: number

actualBrush

Inherited from: IgcMarkerSeriesComponent

actualBrush: string

actualFocusBrush

Inherited from: IgcMarkerSeriesComponent

actualFocusBrush: string

actualFocusMode

Inherited from: IgcMarkerSeriesComponent

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgcMarkerSeriesComponent

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgcMarkerSeriesComponent

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgcMarkerSeriesComponent

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgcMarkerSeriesComponent

actualHitTestMode: SeriesHitTestMode

actualItemSearchMode

actualItemSearchMode: ScatterItemSearchMode

actualLayers

Inherited from: IgcMarkerSeriesComponent

actualLayers: IgcSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgcMarkerSeriesComponent

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgcMarkerSeriesComponent

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgcMarkerSeriesComponent

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerBrush

Inherited from: IgcMarkerSeriesComponent

actualMarkerBrush: string

actualMarkerFillOpacity

Inherited from: IgcMarkerSeriesComponent

actualMarkerFillOpacity: number

actualMarkerOutline

Inherited from: IgcMarkerSeriesComponent

actualMarkerOutline: string

actualMarkerTemplate

Inherited from: IgcMarkerSeriesComponent

actualMarkerTemplate: IgDataTemplate

actualMarkerType

Inherited from: IgcMarkerSeriesComponent

actualMarkerType: MarkerType

actualOutline

Inherited from: IgcMarkerSeriesComponent

actualOutline: string

actualResolution

Inherited from: IgcMarkerSeriesComponent

actualResolution: number

actualSelectionBrush

Inherited from: IgcMarkerSeriesComponent

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgcMarkerSeriesComponent

actualSelectionMode: SeriesSelectionMode

actualThickness

Inherited from: IgcMarkerSeriesComponent

actualThickness: number

actualTrendLineBrush

actualTrendLineBrush: string

areaFillOpacity

Inherited from: IgcMarkerSeriesComponent

areaFillOpacity: number

assigningScatterMarkerStyle

assigningScatterMarkerStyle: object

assigningScatterStyle

assigningScatterStyle: object

attachTooltipToRoot

Inherited from: IgcMarkerSeriesComponent

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgcMarkerSeriesComponent

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgcMarkerSeriesComponent

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgcMarkerSeriesComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgcMarkerSeriesComponent

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgcMarkerSeriesComponent

brush: string

coercionMethods

Inherited from: IgcMarkerSeriesComponent

coercionMethods: any

dashArray

Inherited from: IgcMarkerSeriesComponent

dashArray: number[]

dataLegendGroup

Inherited from: IgcMarkerSeriesComponent

dataLegendGroup: string

dataSource

Inherited from: IgcMarkerSeriesComponent

dataSource: any

discreteLegendItemTemplate

Inherited from: IgcMarkerSeriesComponent

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgcMarkerSeriesComponent

expectFunctions: boolean

finalValue

Inherited from: IgcMarkerSeriesComponent

finalValue: number

focusBrush

Inherited from: IgcMarkerSeriesComponent

focusBrush: string

highlightedDataSource

Inherited from: IgcMarkerSeriesComponent

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgcMarkerSeriesComponent

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgcMarkerSeriesComponent

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgcMarkerSeriesComponent

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgcMarkerSeriesComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgcMarkerSeriesComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgcMarkerSeriesComponent

highlightedValuesFadeOpacity: number

highlightedXMemberPath

highlightedXMemberPath: string

highlightedYMemberPath

highlightedYMemberPath: string

highlightingFadeOpacity

Inherited from: IgcMarkerSeriesComponent

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgcMarkerSeriesComponent

hitTestMode: SeriesHitTestMode

index

Inherited from: IgcMarkerSeriesComponent

index: number

isActualLegendFinancial

Inherited from: IgcMarkerSeriesComponent

isActualLegendFinancial: boolean

isComponentHighlightingModeIgnored

Inherited from: IgcMarkerSeriesComponent

isComponentHighlightingModeIgnored: boolean

isCustomMarkerCircular

Inherited from: IgcMarkerSeriesComponent

isCustomMarkerCircular: boolean

isCustomScatterMarkerStyleAllowed

isCustomScatterMarkerStyleAllowed: boolean

isCustomScatterStyleAllowed

isCustomScatterStyleAllowed: boolean

isDefaultToolTipSelected

Inherited from: IgcMarkerSeriesComponent

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgcMarkerSeriesComponent

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgcMarkerSeriesComponent

isHighlightingEnabled: boolean

itemSearchMode

itemSearchMode: ScatterItemSearchMode

itemSearchThreshold

itemSearchThreshold: number

layers

Inherited from: IgcMarkerSeriesComponent

layers: IgcSeriesLayerCollection

legend

Inherited from: IgcMarkerSeriesComponent

legend: any

legendItemBadgeMode

Inherited from: IgcMarkerSeriesComponent

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgcMarkerSeriesComponent

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgcMarkerSeriesComponent

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgcMarkerSeriesComponent

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgcMarkerSeriesComponent

legendItemVisibility: Visibility

lineCap

Inherited from: IgcMarkerSeriesComponent

lineCap: PenLineCap

lineJoin

Inherited from: IgcMarkerSeriesComponent

lineJoin: PenLineJoin

markerBrush

Inherited from: IgcMarkerSeriesComponent

markerBrush: string

markerCollisionAvoidance

markerCollisionAvoidance: CollisionAvoidanceType

markerFillMode

Inherited from: IgcMarkerSeriesComponent

markerFillMode: MarkerFillMode

markerFillOpacity

Inherited from: IgcMarkerSeriesComponent

markerFillOpacity: number

markerOutline

Inherited from: IgcMarkerSeriesComponent

markerOutline: string

markerOutlineMode

Inherited from: IgcMarkerSeriesComponent

markerOutlineMode: MarkerOutlineMode

markerSize

Inherited from: IgcMarkerSeriesComponent

markerSize: number

markerTemplate

Inherited from: IgcMarkerSeriesComponent

markerTemplate: IgDataTemplate

markerThickness

Inherited from: IgcMarkerSeriesComponent

markerThickness: number

markerType

Inherited from: IgcMarkerSeriesComponent

markerType: MarkerType

maximumMarkers

maximumMarkers: number

mouseOverEnabled

Inherited from: IgcMarkerSeriesComponent

mouseOverEnabled: boolean

name

Inherited from: IgcMarkerSeriesComponent

name: string

opacity

Inherited from: IgcMarkerSeriesComponent

opacity: number

outline

Inherited from: IgcMarkerSeriesComponent

outline: string

outlineMode

Inherited from: IgcMarkerSeriesComponent

outlineMode: SeriesOutlineMode

percentChange

Inherited from: IgcMarkerSeriesComponent

percentChange: number

renderRequested

Inherited from: IgcMarkerSeriesComponent

renderRequested: object

resolution

Inherited from: IgcMarkerSeriesComponent

resolution: number

safeActualBrush

Inherited from: IgcMarkerSeriesComponent

safeActualBrush: string

selectionBrush

Inherited from: IgcMarkerSeriesComponent

selectionBrush: string

selectionThickness

Inherited from: IgcMarkerSeriesComponent

selectionThickness: number

shadowBlur

Inherited from: IgcMarkerSeriesComponent

shadowBlur: number

shadowColor

Inherited from: IgcMarkerSeriesComponent

shadowColor: string

shadowOffsetX

Inherited from: IgcMarkerSeriesComponent

shadowOffsetX: number

shadowOffsetY

Inherited from: IgcMarkerSeriesComponent

shadowOffsetY: number

shouldAnimateOnDataSourceSwap

Inherited from: IgcMarkerSeriesComponent

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgcMarkerSeriesComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgcMarkerSeriesComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgcMarkerSeriesComponent

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgcMarkerSeriesComponent

showDefaultTooltip: boolean

thickness

Inherited from: IgcMarkerSeriesComponent

thickness: number

title

Inherited from: IgcMarkerSeriesComponent

title: any

tooltipContainerTemplate

Inherited from: IgcMarkerSeriesComponent

tooltipContainerTemplate: TemplateFunction

tooltipTemplate

Inherited from: IgcMarkerSeriesComponent

tooltipTemplate: TemplateFunction

transitionDuration

Inherited from: IgcMarkerSeriesComponent

transitionDuration: number

transitionEasingFunction

Inherited from: IgcMarkerSeriesComponent

transitionEasingFunction: object

transitionInDuration

Inherited from: IgcMarkerSeriesComponent

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgcMarkerSeriesComponent

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgcMarkerSeriesComponent

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgcMarkerSeriesComponent

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgcMarkerSeriesComponent

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgcMarkerSeriesComponent

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgcMarkerSeriesComponent

transitionOutSpeedType: TransitionOutSpeedType

trendLineBrush

trendLineBrush: string

trendLineDashArray

trendLineDashArray: number[]

trendLinePeriod

trendLinePeriod: number

trendLineThickness

trendLineThickness: number

trendLineType

trendLineType: TrendLineType

trendLineZIndex

trendLineZIndex: number

useItemWiseColors

Inherited from: IgcMarkerSeriesComponent

useItemWiseColors: boolean

useSingleShadow

Inherited from: IgcMarkerSeriesComponent

useSingleShadow: boolean

visibility

Inherited from: IgcMarkerSeriesComponent

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgcMarkerSeriesComponent

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgcMarkerSeriesComponent

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgcMarkerSeriesComponent

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgcMarkerSeriesComponent

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgcMarkerSeriesComponent

visibleRangeMode: SeriesVisibleRangeMode

xAxis

xAxis: IgcNumericXAxisComponent

xAxisName

xAxisName: string

xMemberAsLegendLabel

xMemberAsLegendLabel: string

xMemberAsLegendUnit

xMemberAsLegendUnit: string

xMemberPath

xMemberPath: string

yAxis

yAxis: IgcNumericYAxisComponent

yAxisName

yAxisName: string

yMemberAsLegendLabel

yMemberAsLegendLabel: string

yMemberAsLegendUnit

yMemberAsLegendUnit: string

yMemberPath

yMemberPath: string

Accessors

actualCloseLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgcMarkerSeriesComponent

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgcMarkerSeriesComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

effectiveIsMarkerCircular

Inherited from: IgcMarkerSeriesComponent

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

get effectiveIsMarkerCircular(): boolean

Returns boolean

hasMarkers

Inherited from: IgcMarkerSeriesComponent

Returns whether the current series supports visual markers.

HasMarkers property is overriden, it returns whether the current series supports visual markers. You can use it like this:

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgcMarkerSeriesComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgcMarkerSeriesComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgcMarkerSeriesComponent

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

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

get isAnnotationHoverLayer(): boolean

Returns boolean

isAnnotationLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgcMarkerSeriesComponent

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgcMarkerSeriesComponent

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgcMarkerSeriesComponent

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

IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Inherited from: IgcMarkerSeriesComponent

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgcMarkerSeriesComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgcMarkerSeriesComponent

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

get isIndexed(): boolean

Returns boolean

isLayer

Inherited from: IgcMarkerSeriesComponent

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgcMarkerSeriesComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgcMarkerSeriesComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Checks if this series is a scatter series

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgcMarkerSeriesComponent

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgcMarkerSeriesComponent

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgcMarkerSeriesComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgcMarkerSeriesComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgcMarkerSeriesComponent

get seriesInternal(): any

Returns any

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcMarkerSeriesComponent

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

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

bindSeries

Inherited from: IgcMarkerSeriesComponent

bindSeries(series: IgcSeriesComponent[]): void

Parameters

series: IgcSeriesComponent[]

Returns void

canUseAsXAxis

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

canUseAsYAxis

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

axis: any
- The object to check

Returns boolean

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgcMarkerSeriesComponent

Converts a point from world coordinates to coordinates within the viewport of the series.

fromWorldPosition(world: IgPoint): IgPoint

Parameters

world: IgPoint
- The world position from which to convert.

Returns IgPoint

getEffectiveViewport

Inherited from: IgcMarkerSeriesComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

getExactItemIndex(world: IgPoint): number

Parameters

world: IgPoint

The world position for which to return the index.

let index: number = this.series.getExactItemIndex({x:.5,y:.5});

Returns number

getItem

Gets the item that is the best match for the specified world coordinates.

getItem(world: IgPoint): any

Parameters

world: IgPoint
- The world coordinates to use.

Returns any

getItemIndex

Gets the index of the item that resides at the provided world coordinates.

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint
- The world coordinates of the requested item.

Returns number

getItemSpan

Inherited from: IgcMarkerSeriesComponent

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

getItemSpan(): number

Returns number

getItemValue

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgcMarkerSeriesComponent

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Gets the value of a requested member path from the series.

getMemberPathValue(memberPathName: string): string

Parameters

memberPathName: string
- The property name of a valid member path for the series

Returns string

getNextOrExactIndex

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgcMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgcMarkerSeriesComponent

If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

getSeriesValueBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinate for which to get a value bounding box for

Returns IgRect

getSeriesValueFromSeriesPixel

Inherited from: IgcMarkerSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.

getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinates for which to get a value marker bounding box for

Returns IgRect

getSeriesValuePosition

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgcMarkerSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Gets the numeric values from the X and Y axis associated with this scatter series that matches the desired value mode.

getSeriesValueType(mode: string | ValueLayerValueMode): number[]

Parameters

mode: string | ValueLayerValueMode
- The type of value desired from the series numeric axis.

Returns number[]

getSeriesValueTypePosition

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgcMarkerSeriesComponent

Gets an unscaled position in terms of axis values from a viewport position.

getUnscaledPosition(pos: IgPoint): IgPoint

Parameters

pos: IgPoint
- The viewport relative position

Returns IgPoint

hideToolTips

Inherited from: IgcMarkerSeriesComponent

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgcMarkerSeriesComponent

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgcMarkerSeriesComponent

Moves the cursor point to the provided world position. Some series may react to the current cursor position.

moveCursorPoint(point: IgPoint): void

Parameters

point: IgPoint
- The cursor point, in world coordinates.
MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.
```
this.crosshair.moveCursorPoint({x:.5,y:.5});
```

Returns void

notifyIndexedPropertiesChanged

Inherited from: IgcMarkerSeriesComponent

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

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgcMarkerSeriesComponent

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgcMarkerSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgcMarkerSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgcMarkerSeriesComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgcMarkerSeriesComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgcMarkerSeriesComponent

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgcMarkerSeriesComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgcMarkerSeriesComponent

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

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

Returns void

removeAxes

Inherited from: IgcMarkerSeriesComponent

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Inherited from: IgcMarkerSeriesComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

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

Returns void

replayTransitionIn

Inherited from: IgcMarkerSeriesComponent

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgcMarkerSeriesComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

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

setNegativeColors

Inherited from: IgcMarkerSeriesComponent

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Inherited from: IgcMarkerSeriesComponent

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

point: IgPoint
- The pointer position relative to the series viewport over which to hover.
When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.
```
this.series.simulateHover({x:250,y:250});
```

Returns void

styleUpdated

Inherited from: IgcMarkerSeriesComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgcMarkerSeriesComponent

Converts a point from coordinates within the series plot area to a world position within axis space.

toWorldPosition(seriesPoint: IgPoint): IgPoint

Parameters

seriesPoint: IgPoint
- The pixel location within the plot area of the series.
```
this.series.toWorldPosition({x:500,y:500});
```

Returns IgPoint

toWorldRect

Inherited from: IgcMarkerSeriesComponent

Converts a rect from coordinates within the series plot area to a world position within axis space.

toWorldRect(rect: IgRect): IgRect

Parameters

rect: IgRect
- The pixel rect within the plot area of the series.

Returns IgRect

_createFromInternal

Inherited from: IgcMarkerSeriesComponent

_createFromInternal(internal: any): IgcSeriesComponent

Parameters

internal: any