Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebGlPen

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

The WebGlPen is a pen for polygon stroke, line strokes, which can be passed to SciChart's WebGL / WebAssembly graphics engine

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new WebGlPen(scrtPen: SCRTPen, originalColor?: number): WebGlPen

  • Creates an instance of WebGlPen

    Parameters

    • scrtPen: SCRTPen

      the inner {@link SCRTPen} which can be passed to SciChart's WebAssembly WebGL engine

    • Optional originalColor: number

      the original color which is used to change the opacity

    Returns WebGlPen

Accessors

scrtPen

  • get scrtPen(): SCRTPen

  • the inner {@link SCRTPen} which can be passed to SciChart's WebAssembly WebGL engine

    Returns SCRTPen

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

getPenType

  • getPenType(): EDrawingTypes

  • Gets the type of the pen. See {@link EDrawingTypes} for list of values

    Returns EDrawingTypes

setOpacity

  • setOpacity(opacity: number): void

  • Allows setting an opacity override for the pen. This will be applied the next time the pen is used to draw

    Parameters

    • opacity: number

      An opacity number from 0..1

    Returns void

Generated using TypeDoc