Skip to main content

MeasurementProperties

Other

User-configurable measurement appearance and type-specific editing properties. Properties that do not apply to the target measurement type are ignored by the setter.

Import​

import ScriptingApi as api

# Access the class
# MeasurementProperties is available via api.MeasurementProperties

Properties​

description​

Free-form description text. Applies to all measurement types.

Type: str

annotation_background_color​

Annotation frame RGB color [r, g, b]. Applies to measurements that render annotation text.

Type: list

annotation_background_opacity​

Annotation frame opacity in range [0.0, 1.0]. Applies to measurements that render annotation text.

Type: float

text_size​

Annotation font size in points. Applies to measurements that render annotation text.

Type: int

text_bold​

Annotation font bold state. Applies to measurements that render annotation text.

Type: bool

text_italic​

Annotation font italic state. Applies to measurements that render annotation text.

Type: bool

text_color​

Annotation text RGB color [r, g, b]. Applies to measurements that render annotation text.

Type: list

text_opacity​

Annotation text opacity in range [0.0, 1.0]. Applies to measurements that render annotation text.

Type: float

axes_3d_scale_factor​

3D axes scale factor. Only applies to non-contour measurements.

Type: float

axes_3d_line_width​

3D axes line width. Only applies to non-contour measurements.

Type: float

point_scale_factor​

Point handle scale factor. Applies to measurement handle widgets.

Type: float

point_color​

Point handle RGB color [r, g, b]. Applies to measurement handle widgets.

Type: list

point_opacity​

Point handle opacity in range [0.0, 1.0]. Applies to measurement handle widgets.

Type: float

follow_object_profile_enabled​

Follow-object-profile flag. Applies to all measurement types except box measurements.

Type: bool

line_width​

Line width. Only applies to non-point measurements.

Type: float

line_color​

Line RGB color [r, g, b]. Only applies to non-point measurements.

Type: list

line_opacity​

Line opacity in range [0.0, 1.0]. Only applies to non-point measurements.

Type: float

display_image_info_at_anchor_point​

If true, annotation measurements display image information at the anchor point instead of annotationText. Only applies to annotation measurements.

Type: bool

annotation_text​

Annotation text content. Only applies to annotation measurements and is ignored when displayImageInfoAtAnchorPoint is true.

Type: str

add_intermediate_node_on_contour​

Allows adding intermediate nodes while editing. Only applies to contour measurements.

Type: bool

closed_loop​

Closed-loop contour flag. Only applies to contour measurements.

Type: bool

maximum_curve_line_segments​

Maximum curve line segments. Only applies to contour measurements.

Type: int

See Also​