rulerSegmentModeType

layout rulerSegmentModeType cyclic ( "Single" | "Multiple" | "Auto" )

Description

Specifies the type of ruler created by the measurement.You can set the environment variable to one of the following values:

• Single: Creates a single-segment ruler. This is the measurement between points on the canvas.
• Multiple: Creates a multiple-segment ruler. In this mode, you can view the measurement between consecutive points that you specify.
• Auto: Creates a multiple-segment ruler. In this mode, points are automatically calculated. There are two ways in which the ruler is created in the auto mode:
  • An auto ruler is created between two specified points on the canvas.
  • You press the Shift key in the auto mode. In this case, an orthogonal ruler is created with all edges visible on the canvas in vertical or horizontal direction. In this case, the direction of the ruler is based on the edge closest to the pointer.

The default is Single.

GUI Equivalent

Command:	Tools – Create Measurement
Field:	Segment Mode

Examples

envGetVal("layout" "rulerSegmentModeType")

envSetVal("layout" "rulerSegmentModeType" 'cyclic "Multiple")

envSetVal("layout" "rulerSegmentModeType" 'cyclic "Auto")

Related Topics

Create Measurement Form

Return to top