BIM.works SDKs - v1.5.0-b164
    Preparing search index...

    Class TextAnnotation

    Text based Annotation

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    backgroundColor backgroundHoverColor borderColor borderHoverColor click color hoverColor lines maxDistanceMm

    Methods

    addLine

    Constructors

    Accessors

    • get click(): Function

      Returns Function

      The currently set click listener

    • set click(fn: Function): void

      Attach a click listener, only one click listener can be attached, previous one will be overwritten

      Parameters

      • fn: Function

        The method to call whenever this annotation is clicked

      Returns void

    • get maxDistanceMm(): number

      Returns number

      The currently set max distance in mm

    • set maxDistanceMm(distance: number): void

      Set the maximum distance from the annotation to the camera at which it will still be displayed. The default value of this is 0, which means that at any distance the annotation will be displayed

      Parameters

      • distance: number

        The max distance in mm

      Returns void

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods