Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the interface to 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 IPointMarker for specific point-marker types.

Hierarchy

Implemented by

Index

Properties

fill

fill: string

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

height

height: number

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

invalidateParentCallback

invalidateParentCallback: () => void

Callback to invalidate the parent 2D SciChartSurface

Type declaration

    • (): void
    • Returns void

opacity

opacity: number

Gets or sets the opacity of the point-marker

stroke

stroke: string

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

strokeThickness

strokeThickness: number

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

type

Type of the point marker

width

width: number

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

Methods

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

drawSprite

  • drawSprite(canvas: CanvasRenderingContext2D, spriteWidth: number, spriteHeight: number, stroke: string, strokeThickness: 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

    • canvas: CanvasRenderingContext2D

      the {@link CanvasRenderingContext2D} to draw to

    • spriteWidth: number

      the sprite target width

    • spriteHeight: number

      the sprite target height

    • stroke: string

      the stroke color

    • strokeThickness: number

      the thickness of the stroke

    • 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

  • Gets a CanvasTexture object which represents the point-marker sprite instance to draw

    remarks

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

    Returns CanvasTexture

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

Protected 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

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