Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RolloverModifierRenderableSeriesProps

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

Hierarchy

  • RolloverModifierRenderableSeriesProps

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

height

height: number

marker

marker: RolloverMarkerSvgAnnotation

renderableSeries

renderableSeries: IRenderableSeries

rolloverModifier

rolloverModifier: IRolloverModifier

tooltip

tooltip: RolloverTooltipSvgAnnotation

tooltipLabelX

tooltipLabelX: string

tooltipLabelY

tooltipLabelY: string

tooltipLegendOffsetX

tooltipLegendOffsetX: number = 20

tooltipLegendOffsetY

tooltipLegendOffsetY: number = 20

tooltipTemplate

tooltipTemplate: TRolloverTooltipSvgTemplate

width

width: number

Accessors

markerColor

  • get markerColor(): string
  • set markerColor(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

shadowColor

  • get shadowColor(): string
  • set shadowColor(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

showRollover

  • get showRollover(): boolean
  • set showRollover(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

tooltipColor

  • get tooltipColor(): string
  • set tooltipColor(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

tooltipDataTemplate

  • get tooltipDataTemplate(): (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string) => string[]
  • set tooltipDataTemplate(value: (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string) => string[]): void

  • Returns (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string) => string[]

      • (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string): string[]

      • Parameters

        • seriesInfo: SeriesInfo
        • tooltipTitle: string
        • tooltipLabelX: string
        • tooltipLabelY: string

        Returns string[]

  • Parameters

    • value: (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string) => string[]
        • (seriesInfo: SeriesInfo, tooltipTitle: string, tooltipLabelX: string, tooltipLabelY: string): string[]

        • Parameters

          • seriesInfo: SeriesInfo
          • tooltipTitle: string
          • tooltipLabelX: string
          • tooltipLabelY: string

          Returns string[]

    Returns void

tooltipLegendTemplate

tooltipTextColor

  • get tooltipTextColor(): string
  • set tooltipTextColor(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

tooltipTitle

  • get tooltipTitle(): string
  • set tooltipTitle(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

calcTooltipHeight

  • calcTooltipHeight(lines: number): number

  • Calculates tooltip height from the number of text lines. Override this if using a custom tooltipTemplate with different sizing.

    Parameters

    • lines: number

    Returns number

calcTooltipWidth

  • calcTooltipWidth(textLength: number): number

  • Calculates tooltip width from the longest text line length. Override this if using a custom tooltipTemplate with different sizing.

    Parameters

    • textLength: number

    Returns number

delete

  • delete(): void

  • Returns void

getTooltipSize

  • getTooltipSize(seriesInfo: SeriesInfo): { height: number; width: number }

  • Pre-computes tooltip text lines and dimensions. Called by calcTooltipProps before positioning to ensure correct first-render placement. The resulting lines are cached on the tooltip annotation to avoid recomputation in the SVG template.

    Parameters

    Returns { height: number; width: number }

    • height: number
    • width: number

Protected notifyPropertyChanged

  • notifyPropertyChanged<T>(propertyName: string): void

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns void

setInvalidateParentCallback

  • setInvalidateParentCallback(callback: () => void): void

  • Parameters

    • callback: () => void
        • (): void

        • Returns void

    Returns void

Static copy

Generated using TypeDoc