Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DpiHelper

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

A helper class with methods and properties for DPI scaling of canvases

Hierarchy

  • DpiHelper

Index

Properties

Methods

Properties

Static IsDpiScaleEnabled

IsDpiScaleEnabled: boolean = true

When true, automatically adjust chart resolution for sharper images on high DPI screens

Static PIXEL_RATIO

PIXEL_RATIO: number

Returns the current DPI scaling factor

remarks

Normal screen = 1, Retina display = 2, a Windows PC at 125% = 1.25

Static dpiChanged

dpiChanged: EventHandler<TDpiChangedEventArgs> = new EventHandler<TDpiChangedEventArgs>()

Event you can subscribe to for Dpi Changes. See EventHandler for subscription syntax. Remember to unsubscribe to prevent memory leaks!

Methods

Static adjustLineStyle

  • Parameters

    • lineStyle: ILineStyle
    • Default value dpiScale: number = DpiHelper.PIXEL_RATIO

    Returns ILineStyle

Static adjustStrokeSize

  • Parameters

    • gridLineStyle: TGridLineStyle
    • Default value dpiScale: number = DpiHelper.PIXEL_RATIO

    Returns TGridLineStyle

Static adjustTextStyle

  • Parameters

    • textStyle: TTextStyle
    • Default value dpiScale: number = DpiHelper.PIXEL_RATIO

    Returns TTextStyle

Static adjustThickness

  • Parameters

    • thickness: Thickness
    • Default value dpiScale: number = DpiHelper.PIXEL_RATIO

    Returns Thickness

Static createCanvas

  • createCanvas(desiredWidth?: number, desiredHeight?: number): HTMLCanvasElement

  • Creates a HTML Canvas element and applies the desired width, height using the PIXEL_RATIO DPI scaling factor

    Parameters

    • Default value desiredWidth: number = 0
    • Default value desiredHeight: number = 0

    Returns HTMLCanvasElement

Static initialize

  • initialize(): void

  • Static initialization function for DpiHelper. Is called once by the framework on startup

    Returns void

Static setHeight

  • setHeight(canvas: HTMLCanvasElement, desiredHeight: number): void

  • Sets the desired height on an HTML Canvas element using the PIXEL_RATIO DPI scaling factor

    Parameters

    • canvas: HTMLCanvasElement
    • desiredHeight: number

    Returns void

Static setSize

  • setSize(canvas: HTMLCanvasElement, desiredWidth: number, desiredHeight: number): void

  • Sets the desired size on an HTML Canvas element using the PIXEL_RATIO DPI scaling factor

    Parameters

    • canvas: HTMLCanvasElement
    • desiredWidth: number
    • desiredHeight: number

    Returns void

Static setWidth

  • setWidth(canvas: HTMLCanvasElement, desiredWidth: number): void

  • Sets the desired width on an HTML Canvas element using the PIXEL_RATIO DPI scaling factor

    Parameters

    • canvas: HTMLCanvasElement
    • desiredWidth: number

    Returns void

Generated using TypeDoc