Class: RulerMeasurement

RulerMeasurement(geoJSON)

Represents a ruler/measurement annotation: MultiLineString with subtype 'Measurement', storing units, measured lengths, and display settings in geometry.properties.

Constructor

new RulerMeasurement(geoJSON)

Parameters:
Name Type Description
geoJSON Object GeoJSON feature with geometry.type === 'MultiLineString', geometry.properties.subtype === 'Measurement'
Source:

Extends

  • MultiLinestring

Methods

getProperties()

Return geometry.properties (no subtype; base toGeoJSONGeometry adds it from getGeoJSONType).
Source:

refreshSegmentLabel(segmentGroup)

Update label content and position for one segment group (content from path length + item.data.ruler). Used by the ruler tool when refreshing a single segment (e.g. after drag) or all segments.
Parameters:
Name Type Description
segmentGroup paper.Group group with [halo, path, labelGroup] where labelGroup has [strokeLabel, fillLabel]
Source:

refreshSegmentLabels()

Update label content and position for all segment groups. Used by the ruler tool when units/settings change.
Source: