Copyright © 2021 by K4.org
  (v.0.48.124)

A UIOverlay is an empty container for other controls showing over the geometry viewer. In order to use it, add a UIOverlay-based design as a child of the geometry viewer. For positioning the overlay specify one or more location-specific rules: top, bottom, left, right. You can specify a maximum of 3 out of 4 location-specific rules.

note:

The overlay must not overlap with visible geometry viewer controls, such as view cube or toolbar. If they overlap, the overlay controls will not be operational.

example

Set top to '10px' and right to '10px' to align the overlay container to top-right corner of the viewer. Note that this overlay will likely overlap the view cube; it is recommended to hide the view cube or use a top value greater than 200px.

example:

Set bottom, left, and right to '0px' will make a bottom-aligned full width overlay. The same can be done by specifying bottom as '0px' and width (from UIContainerMixin) to 'full'

Index

Rules

bottom

bottom: String

The inset from the bottom of the UIGeometryViewer.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

controlType

controlType: String

Internal Use Only

Flags : Cached (Note this is uncached)

Expression : "Overlay"

dragEnable

dragEnable: Boolean

Allows this overlay to be dragged.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

hideOnClickOutside

hideOnClickOutside: Boolean

When true, the rule visibility is set to 'hidden' on clicking outside the overlay. Default is false.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

left

left: String

The inset from the left of the UIGeometryViewer.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

right

right: String

The inset from the right of the UIGeometryViewer.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

top

top: String

The inset from the top of the UIGeometryViewer.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""