Interface RulerProps<MS>

interface RulerProps<MS extends RulerMeasurementSystem> {
    measurementSystem?: MS;
    onActivate?: () => void;
    onDeactivate?: () => void;
    onMeasure?: (e: RulerMeasureEvent<MS>) => void;
    onMeasurePartial?: (e: RulerMeasureEvent<MS>) => void;
}

Type Parameters

MS extends RulerMeasurementSystem

Index

Properties

measurementSystem? onActivate? onDeactivate? onMeasure? onMeasurePartial?

Properties

`Optional`measurementSystem

measurementSystem?: MS

Defines which units be used in measure events

`Optional`onActivate

onActivate?: () => void

Control is activated

`Optional`onDeactivate

onDeactivate?: () => void

Control is deactivated

`Optional`onMeasure

onMeasure?: (e: RulerMeasureEvent<MS>) => void

Measure is complete, no new points can be added to the path

`Optional`onMeasurePartial

onMeasurePartial?: (e: RulerMeasureEvent<MS>) => void

New point is added to the path