Class Tooltip

Represents the content of a tooltip overlay.

Hierarchy

Tooltip

Implements

Serializable

Index

Constructors

constructor

Methods

Constructors

constructor

new Tooltip(content?: string | MeasurementValue | InspectionPlanItem | Measurement): Tooltip

- Defined in tooltips.ts:79
Initializes a new instance of the Tooltip class.

Parameters
- Optional content: string | MeasurementValue | InspectionPlanItem | Measurement
  
  The primary content of the tooltip. When specifying a measurement value or an inspection plan item, PiWeb will generate a generic tooltip for the entity.
Returns Tooltip

Methods

addCharacteristicInformations

addCharacteristicInformations(characteristic: InspectionPlanItem): void

- Defined in tooltips.ts:146
Generates a generic tooltip for the specified inspection plan item and adds the lines to the current tooltip.

Parameters
- characteristic: InspectionPlanItem
  
  The inspection plan item.
Returns void

addCollapsableText

addCollapsableText(text: string, className: string): void

- Defined in tooltips.ts:128
Adds a new collapsable line to the tooltip.

Parameters
- text: string
  
  The content of the tooltip line.
- className: string
  
  The group to which the line belongs.
Returns void

addDefectInformations

addDefectInformations(defect: Defect, image?: Bitmap, direction?: VolumeDirection): void

- Defined in tooltips.ts:215
Generates a generic tooltip for the specified defect and adds the lines to the current tooltip.

version

1.3

Parameters
- defect: Defect
  
  The defect.
- Optional image: Bitmap
  
  The image on which the defect is displayed.
- Optional direction: VolumeDirection
  
  The direction in which the defect is projected onto the image.
Returns void

addDrawingInformations

addDrawingInformations(name: string, drawing: Drawing): void

- Defined in tooltips.ts:203
Generates a tooltip for the specified drawing and adds the lines to the current tooltip.

version

1.3

Parameters
- name: string
  
  The title of the drawing.
- drawing: Drawing
Returns void

addFallbackText

addFallbackText(text: string): void

- Defined in tooltips.ts:137
Adds a fallback text line to the tooltip.

Parameters
- text: string
  
  Content of the fallback text line.
Returns void

addImageInformations

addImageInformations(name: string, image: Bitmap): void

- Defined in tooltips.ts:192
Generates a tooltip for the specified image and adds the lines to the current tooltip.

version

1.3

Parameters
- name: string
  
  The title of the image.
- image: Bitmap
  
  The image.
Returns void

addMeasurementInformations

addMeasurementInformations(measurement: Measurement): void

- Defined in tooltips.ts:172
Generates a generic tooltip for the specified measurement and adds the lines to the current tooltip.

version

1.3

Parameters
- measurement: Measurement
  
  The measurement.
Returns void

addMeasurementValueInformations

addMeasurementValueInformations(value: MeasurementValue): void

- Defined in tooltips.ts:181
Generates a generic tooltip for the specified measurement value and adds the lines to the current tooltip.

Parameters
- value: MeasurementValue
  
  The measurement value.
Returns void

addPartInformations

addPartInformations(part: InspectionPlanItem): void

- Defined in tooltips.ts:159
Generates a generic tooltip for the specified inspection plan item and adds the lines to the current tooltip.

version

1.3

Parameters
- part: InspectionPlanItem
  
  The inspection plan item.
Returns void

addText

addText(text: string): void

- Defined in tooltips.ts:118
Adds a new line to the tooltip.

Parameters
- text: string
  
  The content of the tooltip line.
Returns void

Private serialize

serialize(target: BufferWriter): void

- Defined in tooltips.ts:223
Parameters
- target: BufferWriter
Returns void

Generated using TypeDoc