Options
All
  • Public
  • Public/Protected
  • All
Menu

The Base class for a PointMarker in SciChart - High Performance JavaScript Charts.

description

PointMarkers may be displayed on Renderable Series to add scatter-points to charts. For example: setting the XyScatterRenderableSeries.pointMarker property or FastLineRenderableSeries.pointMarker property will render a point at each xy data-value

remarks

See derived types of BasePointMarker for specific point-marker types.

Hierarchy

Implements

Index

Constructors

Protected constructor

  • Creates an instance of the BasePointMarker

    Parameters

    • webAssemblyContext: TSciChart

      The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    • Optional options: IPointMarkerOptions

      Optional parameters of type IPointMarkerOptions used to configure the point-marker at instantiation time

    Returns BasePointMarker

Properties

invalidateParentCallback

invalidateParentCallback: () => void

Callback to invalidate the parent 2D SciChartSurface

Type declaration

    • (): void
    • Returns void

Abstract type

Protected webAssemblyContext

webAssemblyContext: TSciChart

The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Accessors

fill

  • get fill(): string
  • set fill(fill: string): void
  • Gets or sets the point-marker fill as an HTML Color Code

    Returns string

  • Gets or sets the point-marker fill as an HTML Color Code

    Parameters

    • fill: string

    Returns void

height

  • get height(): number
  • set height(height: number): void
  • Gets or sets the height of the point-marker in pixels

    Returns number

  • Gets or sets the height of the point-marker in pixels

    Parameters

    • height: number

    Returns void

opacity

  • get opacity(): number
  • set opacity(opacity: number): void
  • Gets or sets the opacity of the point-marker

    Returns number

  • Gets or sets the opacity of the point-marker

    Parameters

    • opacity: number

    Returns void

stroke

  • get stroke(): string
  • set stroke(stroke: string): void
  • Gets or sets the point-marker stroke as an HTML Color Code

    Returns string

  • Gets or sets the point-marker stroke as an HTML Color Code

    Parameters

    • stroke: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(strokeThickness: number): void
  • Gets or sets the stroke-thickness of the point-marker in pixels

    Returns number

  • Gets or sets the stroke-thickness of the point-marker in pixels

    Parameters

    • strokeThickness: number

    Returns void

width

  • get width(): number
  • set width(width: number): void
  • Gets or sets the width of the point-marker in pixels

    Returns number

  • Gets or sets the width of the point-marker in pixels

    Parameters

    • width: number

    Returns void

Methods

createCanvasTexture

  • Called internally - creates the CanvasTexture object and calls drawSprite for creating the cached texture to draw

    Returns ISpriteTextures

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

Abstract drawSprite

  • drawSprite(context: CanvasRenderingContext2D, spriteWidth: number, spriteHeight: number, stroke: string, dpiAdjustedStrokeThickness: number, fill: string): void
  • When overridden in a derived class, draw once the point-marker to the {@link CanvasRenderingContext2D}. This will create a sprite (image or bitmap) which will be repeated at each xy data-value using our fast WebGL WebAssembly graphics engine

    Parameters

    • context: CanvasRenderingContext2D

      the {@link CanvasRenderingContext2D} to draw to

    • spriteWidth: number

      the sprite target width, adjusted for DPI Scaling factor

    • spriteHeight: number

      the sprite target height, adjusted for DPI Scaling factor

    • stroke: string

      the stroke color

    • dpiAdjustedStrokeThickness: number

      the thickness of the stroke, adjusted for DPI Scaling factor

    • fill: string

      the fill color

    Returns void

getFillMask

  • Gets a CanvasTexture object which represents the fill mask sprite instance to use for points, which appearance is overridden by a Palette Provider

    remarks

    note CanvasTexture implements IDeletable and must be deleted manually to free memory

    Returns CanvasTexture

getPointMarkerStyle

getSprite

getStrokeMask

  • Gets a CanvasTexture object which represents the stroke mask sprite instance to use for points, which appearance is overridden by a Palette Provider

    remarks

    note CanvasTexture implements IDeletable and must be deleted manually to free memory

    Returns CanvasTexture

invalidateCache

  • invalidateCache(): void

Protected notifyPropertyChanged

  • notifyPropertyChanged<PropertyType>(propertyName: string, newValue: PropertyType, oldValue: PropertyType): void
  • Notifies listeners to invalidateParentCallback that a property has changed and redraw is required

    Type parameters

    • PropertyType

    Parameters

    • propertyName: string

      the property name

    • newValue: PropertyType

      the new value

    • oldValue: PropertyType

      the old value

    Returns void

onDpiChanged

  • Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor

    Parameters

    Returns void

resetCache

  • resetCache(): void
  • Returns void

resumeUpdates

  • resumeUpdates(): void
  • Resumes recreation of the PointMarker

    Returns void

suspendUpdates

  • suspendUpdates(): void
  • Suspends recreation of the PointMarker, used to increase performance when several properties of the PointMarker needs to be updated

    Returns void

toJSON

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

    Returns TPointMarkerDefinition

Generated using TypeDoc