Merge pull request #3637 from Nemo157/leaflet-label

Add definitions for Leaflet.label

leaflet-label/leaflet-label-tests.ts

@@ -0,0 +1,142 @@
+/// <reference path="leaflet-label.d.ts" />
+
+var map: L.Map;
+var label: L.Label;
+
+// Icon
+var icon: L.Icon = new L.Icon({ labelAnchor: L.point(1, 1) });
+
+// CircleMarker
+var circleMarker: L.CircleMarker = new L.CircleMarker(new L.LatLng(0, 0), { labelAnchor: L.point(1, 1) });
+
+circleMarker = circleMarker.bindLabel('test', {
+	className: 'thingy',
+	clickable: true,
+	direction: 'right',
+	noHide: false,
+	offset: new L.Point(0, 0),
+	opacity: 0.5,
+	zoomAnimation: true,
+});
+
+circleMarker.showLabel();
+circleMarker.hideLabel();
+circleMarker.setLabelNoHide(true);
+circleMarker.updateLabelContent('test2');
+label = circleMarker.getLabel()
+circleMarker = circleMarker.unbindLabel();
+
+// Marker
+var marker = new L.Marker(new L.LatLng(0, 0));
+
+marker = marker.bindLabel('test', {
+	className: 'thingy',
+	clickable: true,
+	direction: 'right',
+	noHide: false,
+	offset: new L.Point(0, 0),
+	opacity: 0.5,
+	zoomAnimation: true,
+});
+
+marker.showLabel();
+marker.hideLabel();
+marker.setLabelNoHide(true);
+marker.updateLabelContent('test2');
+label = marker.getLabel()
+marker = marker.unbindLabel();
+marker.setOpacity(0.5);
+marker.setOpacity(0.5, true);
+
+// Path
+var path: L.Path = new L.Polyline([L.latLng(0, 0)]);
+
+path = path.bindLabel('test', {
+	className: 'thingy',
+	clickable: true,
+	direction: 'right',
+	noHide: false,
+	offset: new L.Point(0, 0),
+	opacity: 0.5,
+	zoomAnimation: true,
+});
+
+path.updateLabelContent('test2');
+
+path = path.unbindLabel();
+
+// Label
+
+label = new L.Label();
+
+label.setOpacity(0.7);
+label.updateZIndex(5);
+label.setLatLng(new L.LatLng(3, 3));
+label.setContent('thing');
+label.close();
+
+// Examples from the README
+var example: () => void;
+
+example = () => {
+	L.marker(L.latLng(-37.7772, 175.2606)).bindLabel('Look revealing label!').addTo(map);
+};
+
+example = () => {
+	L.polyline([
+		L.latLng(-37.7612, 175.2756),
+		L.latLng(-37.7702, 175.2796),
+		L.latLng(-37.7802, 175.2750),
+	]).bindLabel('Even polylines can have labels.').addTo(map);
+};
+
+example = () => {
+	L.marker(L.latLng(-37.785, 175.263))
+		.bindLabel('A sweet static label!', { noHide: true })
+		.addTo(map);
+};
+
+example = () => {
+	var myIcon = L.icon({
+		iconUrl: 'my-icon.png',
+		iconSize: L.point(20, 20),
+		iconAnchor: L.point(10, 10),
+		labelAnchor: L.point(6, 0) // as I want the label to appear 2px past the icon (10 + 2 - 6)
+	});
+	L.marker(L.latLng(-37.7772, 175.2606), {
+		icon: myIcon
+	}).bindLabel('My label', {
+		noHide: true,
+		direction: 'auto'
+	});
+};
+
+example = () => {
+	var myIcon = L.icon({
+		iconUrl: 'my-icon.png',
+		iconSize: L.point(20, 20),
+		iconAnchor: L.point(10, 10),
+		labelAnchor: L.point(6, 0) // as I want the label to appear 2px past the icon (10 + 2 - 6)
+	});
+	L.marker(L.latLng(-37.7772, 175.2606), {
+		icon: myIcon
+	}).bindLabel('Look revealing label!').addTo(map);
+};
+
+example = () => {
+	var markerLabel = L.marker(L.latLng(-37.7772, 175.2606)).bindLabel('Look revealing label!').addTo(map);
+
+	// Sets opacity of marker to 0.3 and opacity of label to 1
+	markerLabel.setOpacity(0.3);
+
+	// Sets opacity of marker to 0.3 and opacity of label to 0.3
+	markerLabel.setOpacity(0.3, true);
+
+	// Sets opacity of marker to 0 and opacity of label to 0
+	markerLabel.setOpacity(0);
+	markerLabel.setOpacity(0, true);
+
+	// Sets opacity of marker to 1 and opacity of label to 1
+	markerLabel.setOpacity(1);
+	markerLabel.setOpacity(1, true);
+};

leaflet-label/leaflet-label.d.ts

@@ -0,0 +1,76 @@
+// Type definitions for Leaflet.label v0.2.1
+// Project: https://github.com/Leaflet/Leaflet.label
+// Definitions by: Wim Looman <https://github.com/Nemo157>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../leaflet/leaflet.d.ts" />
+
+declare module L {
+	export interface IconOptions {
+		labelAnchor?: Point;
+	}
+
+	export interface CircleMarkerOptions {
+		labelAnchor?: Point;
+	}
+
+	export interface Marker {
+		showLabel(): Marker;
+		hideLabel(): Marker;
+		setLabelNoHide(noHide: boolean): void;
+		bindLabel(content: string, options?: LabelOptions): Marker;
+		unbindLabel(): Marker;
+		updateLabelContent(content: string): void;
+		getLabel(): Label;
+		setOpacity(opacity: number, labelHasSemiTransparency: boolean): void;
+	}
+
+	export interface CircleMarker {
+		showLabel(): CircleMarker;
+		hideLabel(): CircleMarker;
+		setLabelNoHide(noHide: boolean): void;
+		bindLabel(content: string, options?: LabelOptions): CircleMarker;
+		unbindLabel(): CircleMarker;
+		updateLabelContent(content: string): void;
+		getLabel(): Label;
+	}
+
+	export interface FeatureGroup<T extends ILayer> {
+		clearLayers(): FeatureGroup<T>;
+		bindLabel(content: string, options?: LabelOptions): FeatureGroup<T>;
+		unbindLabel(): FeatureGroup<T>;
+		updateLabelContent(content: string): FeatureGroup<T>;
+	}
+
+	export interface Path {
+		bindLabel(content: string, options?: LabelOptions): Path;
+		unbindLabel(): Path;
+		updateLabelContent(content: string): void;
+	}
+
+	export interface LabelOptions {
+		className?: string;
+		clickable?: boolean;
+		direction?: string; // 'left' | 'right' | 'auto';
+		noHide?: boolean;
+		offset?: Point;
+		opacity?: number;
+		zoomAnimation?: boolean;
+	}
+
+	export interface LabelStatic extends ClassStatic {
+		new(options?: LabelOptions): Label;
+	}
+
+	export var Label: LabelStatic;
+
+	export interface Label extends IEventPowered<Label> {
+		onAdd(map: Map): void;
+		onRemove(map: Map): void;
+		setLatLng(latlng: LatLng): Label;
+		setContent(content: string): Label;
+		close(): void;
+		updateZIndex(zIndex: number): void;
+		setOpacity(opacity: number): void;
+	}
+}