MeasurementProperties

Interface MeasurementProperties

The properties of a measurement entity in the webvis context.

See

MeasurementAPI

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

Properties

anchorPosition? connectedNodeIds? contentOffset? enabled? name? result? state? targets? type?

Properties

OptionalanchorPosition

anchorPosition?: Float32Array<ArrayBufferLike> | [number, number, number]

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

connectedNodeIds?: number[]

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

OptionalcontentOffset

contentOffset?: Float32Array<ArrayBufferLike> | [number, number, number]

The offset of the measurement annotation from its anchorPosition.

Default

[0,0,0]

Optionalenabled

enabled?: boolean

Defines whether the measurement annotation is visible.

Default

true

Optionalname

name?: string

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

Default

undefined

Optional Readonlyresult

result?: MeasurementResult

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

Optional Readonlystate

state?: MeasurementState

The state of the measurement.

Optional Readonlytargets

targets?: MeasurementTarget[]

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

Optional Readonlytype

type?: MeasurementType

The type of the measurement.

Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: