Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Highlight

A highlight marks sections or points of a plot. Highlights associated with measurement values will be shown in a plot if the associated measurement is activated by interactive elements in a report. Highlights associated with tooltips can be selected by the user and will be displayed in PiWeb Monitor.

Hierarchy

  • Highlight

Implements

Index

Constructors

constructor

  • Parameters

    • Optional tooltip: Tooltip | undefined
    • Optional measurementValue: MeasurementValue | undefined
    • Optional geometry: Geometry | undefined
    • Optional activeBorderBrush: Brush | undefined
    • Optional activeBackgroundBrush: Brush

    Returns Highlight

Properties

activeBackgroundBrush

activeBackgroundBrush: Brush | undefined

activeBorderBrush

activeBorderBrush: Brush | undefined

geometry

geometry: Geometry | undefined

measurementValue

measurementValue: MeasurementValue | undefined

tooltip

tooltip: Tooltip | undefined

Methods

Private serialize

  • serialize(writer: BufferWriter): void
  • Parameters

    • writer: BufferWriter

    Returns void

Static create

  • Returns the highlight that is defined by the specified description.

    Parameters

    Returns Highlight

Static createFromInspectionPlanItem

  • Returns a standard highlight which contains a standard tooltip wihtout geometry for a characteristic.

    Parameters

    Returns Highlight

Static createFromMeasurementValue

  • Returns a standard highlight which contains a standard tooltip wihtout geometry for a measurment value.

    Parameters

    Returns Highlight

Static createFromText

  • Returns a standard highlight which contains a standard tooltip wihtout geometry for a characteristic.

    Parameters

    • content: string

    Returns Highlight

Generated using TypeDoc