Interface MeasurementProps

This is for special properties of the Measurement.

interface MeasurementProps {
    activeFeatureStyle?: StyleLike;
    finishedFeatureStyle?: StyleLike;
    map?: MapModel;
    onMeasurementsChange?: (event: MeasurementsChangeEvent) => void;
    predefinedMeasurements?: MeasurementGeometry[];
    [key: `data-${string}`]: unknown;
}

Hierarchy (View Summary)

CommonComponentProps
MapModelProps
- MeasurementProps

Indexable

[key: `data-${string}`]: unknown
Arbitrary data attributes.

NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

Index

Properties

activeFeatureStyle? finishedFeatureStyle? map? onMeasurementsChange? predefinedMeasurements?

Properties

`Optional`activeFeatureStyle

activeFeatureStyle?: StyleLike

The style for the active drawing feature's geometry.

`Optional`finishedFeatureStyle

finishedFeatureStyle?: StyleLike

The style for the finished drawn feature's geometry.

`Optional`map

The map model to use.

`Optional`onMeasurementsChange

onMeasurementsChange?: (event: MeasurementsChangeEvent) => void

Event handler that is called whenever a measurement is added or removed.

`Optional`predefinedMeasurements

predefinedMeasurements?: MeasurementGeometry[]

List of measurements to be rendered when the component is initialized.