Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TitleRendererBase<TextStyleType>

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

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected desiredHeightProperty

desiredHeightProperty: number = 0

The height taken by the text considering current orientation orientation including padding

Protected desiredWidthProperty

desiredWidthProperty: number = 0

The width taken by the text considering current orientation orientation including padding

drawDebug

drawDebug: boolean = false

Protected nativeLineSpacing

nativeLineSpacing: number

The line spacing for native text calculated during measure

Protected nativeTextShiftX

nativeTextShiftX: number

Protected nativeTextShiftY

nativeTextShiftY: number

Protected originalTextStyle

originalTextStyle: TextStyleType

Current not adjusted text style for the title

Protected text

text: string | string[]

Current title

Protected textHeight

textHeight: number = 0

The height taken by the text with normal(horizontal) orientation including padding

Protected textStyle

textStyle: TextStyleType

Adjusted text style for the title

Protected textWidth

textWidth: number = 0

The width taken by the text with normal(horizontal) orientation including padding

Protected texture

texture: TTextureObject

The text texture corresponding to current title and text style.

remarks

The texture is created if {@link textStyle.useNativeText} is set to false

Protected textureManager

textureManager: TextureManager

Protected titlePosition

titlePosition: ETitlePosition

useCache

useCache: boolean = true

Protected useNativeTextProperty

useNativeTextProperty: boolean = false

Protected viewRectProperty

viewRectProperty: Rect = Rect.createZero()

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

viewRect

  • get viewRect(): Rect

  • Defines a bounding Rect containing the title text

    Returns Rect

Methods

delete

  • delete(): void

draw

  • draw(...params: any[]): void

  • Parameters

    • Rest ...params: any[]

    Returns void

Protected drawInternal

  • Performs rendering of the title

    Parameters

    Returns void

Protected drawTitleDebugViewRect

  • Parameters

    Returns void

Protected drawWithNativeText

Protected drawWithTexture

Protected getTextSize

  • Calculates width and hight of the title text

    Parameters

    Returns void

Protected getTitleTexture

  • getTitleTexture(): { bitmapTexture: TSRTexture; textureHeight: number; textureWidth: number }

  • Returns { bitmapTexture: TSRTexture; textureHeight: number; textureWidth: number }

    • bitmapTexture: TSRTexture
    • textureHeight: number
    • textureWidth: number

Protected getViewRect

  • Calculates the {@link TitleRenderer.viewRect}

    Parameters

    Returns Rect

invalidateCache

  • invalidateCache(): void

layout

  • layout(originRect: Rect): void

  • Parameters

    Returns void

measure

  • measure(...params: any[]): void

  • Parameters

    • Rest ...params: any[]

    Returns void

onDpiChanged

resetCache

  • resetCache(): void

Generated using TypeDoc