Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

MeasurementProperties

Type Alias MeasurementProperties

MeasurementProperties: {
    anchorPosition?: [number, number, number] | Float32Array;
    connectedNodeIds?: number[];
    contentOffset?: [number, number, number] | Float32Array;
    enabled?: boolean;
    name?: string;
    result?: MeasurementResult;
    state?: MeasurementState;
    targets?: MeasurementTarget[];
    type?: MeasurementType;
}

The properties of a measurement entity in the webvis context.

Type declaration

  • OptionalanchorPosition?: [number, number, number] | Float32Array

    The anchor position of the measurement annotation. Together with the contentOffset, this defines the position of the measurement annotation.

    Default

    [0,0,0]
  • Optional ReadonlyconnectedNodeIds?: number[]

    The IDs of nodes that are represented by or related to the targets of the measurement.

  • OptionalcontentOffset?: [number, number, number] | Float32Array

    The offset of the measurement annotation from its anchorPosition.

    Default

    [0,0,0]
  • Optionalenabled?: boolean

    Defines whether the measurement annotation is visible.

    Default

    true
  • Optionalname?: string

    The name of the measurement. This is independent of and does not influence the measurement's ID.

    Default

    undefined
  • Optional Readonlyresult?: MeasurementResult

    The result of the measurement. The content of the result depends on the type of the measurement.

  • Optional Readonlystate?: MeasurementState

    The state of the measurement.

  • Optional Readonlytargets?: MeasurementTarget[]

    The targets of the measurement. The content of this array depends on the type of the measurement.

  • Optional Readonlytype?: MeasurementType

    The type of the measurement.

See

MeasurementAPI