@yaga/leaflet-ng2
Version:
Angular2 module for Leaflet
40 lines (39 loc) • 1.83 kB
TypeScript
import { OnDestroy } from "@angular/core";
import { LayerProvider } from "./layer.provider";
import { LayersControlProvider } from "./layers-control.provider";
import * as i0 from "@angular/core";
/**
* Angular2 directive for adding layers to the layers-control of Leaflet as base-layer.
*
* *You can use this directive in an Angular2 template after importing `YagaModule`.*
*
* How to use in a template:
* ```html
* <yaga-map>
* <yaga-layers-control>
* <!-- This can be any other layer... -->
* <yaga-tile-layer yaga-base-layer [caption]="'OSM'"></yaga-tile-layer>
* </yaga-attribution-control>
* </yaga-map>
* ```
*
* @link http://leafletjs.com/reference-1.2.0.html#control-layers-addbaselayer Original Leaflet documentation
* @link https://leaflet-ng2.yagajs.org/latest/browser-test?grep=Base-Layer%20Directive Unit-Test
* @link https://leaflet-ng2.yagajs.org/latest/coverage/lcov-report/lib/base-layer.directive.js.html
* Test coverage
* @link https://leaflet-ng2.yagajs.org/latest/typedoc/classes/baselayerdirective.html API documentation
* @example https://leaflet-ng2.yagajs.org/latest/examples/layers-control-directive/
*/
export declare class BaseLayerDirective implements OnDestroy {
protected layer: LayerProvider;
layersControlProvider: LayersControlProvider;
constructor(layer: LayerProvider, layersControlProvider: LayersControlProvider);
set caption(value: string);
get caption(): string;
/**
* Internal method to provide the removal from the control in Leaflet, when removing it from the Angular template
*/
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<BaseLayerDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<BaseLayerDirective, "[yaga-base-layer]", never, { "caption": "caption"; }, {}, never>;
}