@mapbox-controls/ruler
v6.0.0
Published
Measure distance between points on a map
Readme
📏 @mapbox-controls/ruler
Control to measure distance between points on a map.
npm i @mapbox-controls/rulerimport RulerControl from '@mapbox-controls/ruler';
import '@mapbox-controls/ruler/src/index.css';
map.addControl(new RulerControl(), 'bottom-right');
map.on('ruler.on', () => console.log('Ruler activated'));
map.on('ruler.off', () => console.log('Ruler deactivated'));
map.on('ruler.change', ({ coordinates }) => console.log('Ruler changed'));Options
export type ControlOptions = {
units?: import('@turf/helpers').Units;
labelFormat?: (n: number) => string;
lineLayout?: LineLayerSpecification['layout'];
linePaint?: LineLayerSpecification['paint'];
markerLayout?: CircleLayerSpecification['layout'];
markerPaint?: CircleLayerSpecification['paint'];
labelLayout?: SymbolLayerSpecification['layout'];
labelPaint?: SymbolLayerSpecification['paint'];
invisible?: boolean;
};Events
| event | description | | ------------- | ----------------- | | ruler.on | ruler activated | | ruler.off | ruler deactivated | | ruler.changed | ruler changed |
Methods
Methods are useful for programmatic control (when option invisible is true):
activate(): void;- activate controlsdeactivate(): void;- deactivate controladdCoordinate(coordinate: [number, number]): void;- add new coordinate
