Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a bubble-series or JavaScript bubble chart type in the SciChart's High Performance Real-time JavaScript Charts

remarks

To add a bubble series to a SciChartSurface you need to declare both the RenderableSeries and a XyzDataSeries. Simplified code sample below:

const sciChartSurface: SciChartSurface;
const wasmContext: TSciChart;
// Create and fill the dataseries
const dataSeries = new XyzDataSeries(wasmContext);
dataSeries.append(1,2,3);
dataSeries.append(4,5,6);
// Create the renderableSeries
const bubbleSeries = new FastBubbleRenderableSeries(wasmContext);
bubbleSeries.dataSeries = dataSeries;
// append to the SciChartSurface
sciChartSurface.renderableSeries.add(bubbleSeries);

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected animationFSM

Protected animationQueue

animationQueue: SeriesAnimation[] = []

Protected currentRenderPassData

currentRenderPassData: RenderPassData

Protected dataSeriesProperty

dataSeriesProperty: IDataSeries

hitTestProvider

hitTestProvider: IHitTestProvider

Gets the current IHitTestProvider, used to call methods IHitTestProvider.hitTest, IHitTestProvider.hitTestXSlice and IHitTestProvider.hitTestDataPoint and provide info about the series data-points at mouse or touch locations

hovered

hovered: EventHandler<SeriesHoveredArgs> = new EventHandler<SeriesHoveredArgs>()

A hovered EventHandler. This event fires whenever the Series is hovered or unhovered by a mouse or pointer.

remarks

See EventHandler for how to subscribe

Readonly id

id: string

A unique Id for the IRenderableSeries

invalidateParentCallback

invalidateParentCallback: () => void

A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes

Type declaration

    • (): void
    • Returns void

Readonly isStacked

isStacked: boolean

Returns true if the series is a stacked series or not

isVisibleChanged

isVisibleChanged: EventHandler<SeriesVisibleChangedArgs> = new EventHandler<SeriesVisibleChangedArgs>()

An isVisible changed EventHandler. This event fires whenever the Series isVisible changes.

remarks

See EventHandler for how to subscribe

Protected opacityProperty

opacityProperty: number = 1

Protected paletteProviderProperty

paletteProviderProperty: IPaletteProvider = DefaultPaletteProvider.createEmpty()

Protected pointSeries

Protected resamplerHelper

resamplerHelper: ExtremeResamplerHelper

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this)

Readonly rolloverModifierProps1

rolloverModifierProps1: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this, true)

Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries

selected

selected: EventHandler<SeriesSelectedArgs> = new EventHandler<SeriesSelectedArgs>()

A selected EventHandler. This event fires whenever the Series is selected or deselected.

remarks

See EventHandler for how to subscribe

Readonly type

type: BubbleSeries = ESeriesType.BubbleSeries

Returns the type of the series. See ESeriesType for a list of values

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

animation

dataSeries

drawNaNAs

drawingProviders

effect

enableDrawingOptimisations

  • get enableDrawingOptimisations(): boolean

isDigitalLine

  • get isDigitalLine(): boolean
  • set isDigitalLine(isDigitalLine: boolean): void
  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Returns boolean

  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Parameters

    • isDigitalLine: boolean

    Returns void

isHovered

  • get isHovered(): boolean
  • set isHovered(isHovered: boolean): void
  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Parameters

    • isHovered: boolean

    Returns void

isRunningAnimation

  • get isRunningAnimation(): boolean
  • gets if the animation is currently running

    inheritdoc

    Returns boolean

isRunningDataAnimation

  • get isRunningDataAnimation(): boolean

isSelected

  • get isSelected(): boolean
  • set isSelected(isSelected: boolean): void
  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Parameters

    • isSelected: boolean

    Returns void

isSpline

  • get isSpline(): boolean
  • Returns true if the series uses spline interpolation

    inheritdoc

    Returns boolean

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void
  • When true, the series is visible and drawn

    inheritdoc

    Returns boolean

  • When true, the series is visible and drawn

    inheritdoc

    Parameters

    • isVisible: boolean

    Returns void

opacity

  • get opacity(): number
  • set opacity(value: number): void
  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Returns number

  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Parameters

    • value: number

    Returns void

paletteProvider

parentSurface

pointMarker

resamplingMode

resamplingPrecision

  • get resamplingPrecision(): number
  • set resamplingPrecision(value: number): void

stroke

  • get stroke(): string
  • set stroke(htmlColorCode: string): void
  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns string

  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • htmlColorCode: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(value: number): void
  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns number

  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • value: number

    Returns void

supportsResampling

  • get supportsResampling(): boolean

xAxis

xAxisId

  • get xAxisId(): string
  • set xAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

yAxis

yAxisId

  • get yAxisId(): string
  • set yAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

Methods

Protected afterAnimationComplete

  • afterAnimationComplete(): void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number): boolean

Protected dataSeriesDataChanged

  • dataSeriesDataChanged(): void

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

draw

enqueueAnimation

getBubbleDiameter

  • getBubbleDiameter(pointIndex: number): number
  • Gets the bubble diameter in pixels for the point index, by looking up the Z-value in the associated XyzDataSeries

    Parameters

    • pointIndex: number

    Returns number

getCurrentRenderPassData

getDataPointWidth

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getIndicesRange

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

getNativeZValues

  • getNativeZValues(): SCRTDoubleVector
  • Returns the {@link XyyDataSeries.getNativeZValues} for the associated dataSeries

    Returns SCRTDoubleVector

getSeriesInfo

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

Protected needsResampling

Protected newHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAnimate

  • onAnimate(timeElapsed: number): void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

pushPalettedColors

runAnimation

Protected setAnimationVectors

Protected setPaletteProvider

toJSON

  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Parameters

    • Default value excludeData: boolean = false

      if set true, data values will not be included in the json.

    Returns TSeriesDefinition

toPointSeries

Protected updateAnimationProperties

Protected valueChanged

  • valueChanged(oldValue: any, newValue: any): boolean

Generated using TypeDoc