kvision-maps/io.kvision.maps.externals.leaflet.layer.vector/Polygon

Polygon

open external class Polygon<T : GeoJsonSingleOrMultiPolygon> : Polyline<GeoJsonSingleOrMultiLineString> (source)

A class for drawing polygon overlays on a map. Extends Polyline.

Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.

Parameters

io.kvision.maps.externals.geojson.Polygon or io.kvision.maps.externals.geojson.MultiPolygon

Inheritors

Rectangle

Constructors

Polygon

constructor(latlngs: Array<LatLng>, options: Polyline.PolylineOptions = definedExternally)

Create a polygon from an array of LatLng points.

constructor(latlngs: Array<Array<LatLng>>, options: Polyline.PolylineOptions = definedExternally)

constructor(latlngs: Array<Array<Array<LatLng>>>, options: Polyline.PolylineOptions = definedExternally)

Properties

feature

open var feature: Feature<GeoJsonCoordinatedGeometry>?

options

open var options: Polyline.PolylineOptions

Functions

addEventListener

open fun addEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun addEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented

open fun addEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented

addEventParent

open fun addEventParent(obj: Evented): Evented

addLatLng

open fun addLatLng(latlng: LatLng, latlngs: Array<LatLng> = definedExternally): Polyline<GeoJsonSingleOrMultiLineString>

open fun addLatLng(latlng: Array<LatLng>, latlngs: Array<LatLng> = definedExternally): Polyline<GeoJsonSingleOrMultiLineString>

addOneTimeEventListener

open fun addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun addOneTimeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented

addTo

open fun addTo(map: LayerGroup): Layer<Polyline.PolylineOptions>

open fun addTo(map: LeafletMap): Layer<Polyline.PolylineOptions>

beforeAdd

open fun beforeAdd(map: LeafletMap): Layer<Polyline.PolylineOptions>?

bindPopup

open fun bindPopup(content: Popup, options: Popup.PopupOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindPopup(content: (layer: Layer<Polyline.PolylineOptions>) -> Any, options: Popup.PopupOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindPopup(content: String, options: Popup.PopupOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindPopup(content: HTMLElement, options: Popup.PopupOptions = definedExternally): Layer<Polyline.PolylineOptions>

bindTooltip

open fun bindTooltip(content: Tooltip, options: Tooltip.TooltipOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindTooltip(content: (layer: Layer<Polyline.PolylineOptions>) -> Any, options: Tooltip.TooltipOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindTooltip(content: String, options: Tooltip.TooltipOptions = definedExternally): Layer<Polyline.PolylineOptions>

open fun bindTooltip(content: HTMLElement, options: Tooltip.TooltipOptions = definedExternally): Layer<Polyline.PolylineOptions>

bringToBack

open fun bringToBack(): Path<Polyline.PolylineOptions>

bringToFront

open fun bringToFront(): Path<Polyline.PolylineOptions>

clearAllEventListeners

open fun clearAllEventListeners(): Evented

closePopup

open fun closePopup(): Layer<Polyline.PolylineOptions>

closestLayerPoint

open fun closestLayerPoint(p: Point): Point

closeTooltip

open fun closeTooltip(): Layer<Polyline.PolylineOptions>

fire

open fun fire(type: String, data: Any = definedExternally, propagate: Boolean = definedExternally): Evented

fireEvent

open fun fireEvent(type: String, data: Any = definedExternally, propagate: Boolean = definedExternally): Evented

getAttribution

open fun getAttribution(): String?

getBounds

open fun getBounds(): LatLngBounds

getCenter

open fun getCenter(): LatLng

getElement

open fun getElement(): Element?

getEvents

open fun getEvents(): LeafletEventHandlerFn?

getLatLngs

open fun getLatLngs(): dynamic

getPane

open fun getPane(name: String = definedExternally): HTMLElement?

getPopup

open fun getPopup(): Popup?

getTooltip

open fun getTooltip(): Tooltip?

hasEventListeners

open fun hasEventListeners(type: String): Boolean

isEmpty

open fun isEmpty(): Boolean

isPopupOpen

open fun isPopupOpen(): Boolean

isTooltipOpen

open fun isTooltipOpen(): Boolean

listens

open fun listens(type: String): Boolean

off

open fun off(): Evented

open fun off(eventMap: LeafletEventHandlerFnMap): Evented

open fun off(type: LeafletAnyEventId): Evented

open fun off(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun off(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun on(eventMap: LeafletEventHandlerFnMap): Evented

open fun on(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented

open fun on(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented

onAdd

open fun onAdd(map: LeafletMap): Layer<Polyline.PolylineOptions>

once

open fun once(eventMap: LeafletEventHandlerFnMap): Evented

open fun once(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented

open fun once(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented

onRemove

open fun onRemove(map: LeafletMap): Layer<Polyline.PolylineOptions>

openPopup

open fun openPopup(): Layer<Polyline.PolylineOptions>

open fun openPopup(latlng: LatLng = definedExternally): Layer<Polyline.PolylineOptions>

openTooltip

open fun openTooltip(): Layer<Polyline.PolylineOptions>

open fun openTooltip(latlng: LatLng = definedExternally): Layer<Polyline.PolylineOptions>

redraw

open fun redraw(): Path<Polyline.PolylineOptions>

remove

open fun remove(): Layer<Polyline.PolylineOptions>

removeEventListener

open fun removeEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun removeEventListener(type: LeafletAnyEventId): Evented

open fun removeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

open fun removeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: Any = definedExternally): Evented

removeEventParent

open fun removeEventParent(obj: Evented): Evented

removeFrom

open fun removeFrom(map: LeafletMap): Layer<Polyline.PolylineOptions>

setLatLngs

open fun setLatLngs(latlngs: Array<LatLng>): Polyline<GeoJsonSingleOrMultiLineString>

open fun setLatLngs(latlngs: Array<Array<LatLng>>): Polyline<GeoJsonSingleOrMultiLineString>

open fun setLatLngs(latlngs: Array<Array<Array<LatLng>>>): Polyline<GeoJsonSingleOrMultiLineString>

setPopupContent

open fun setPopupContent(content: Popup): Layer<Polyline.PolylineOptions>

open fun setPopupContent(content: String): Layer<Polyline.PolylineOptions>

open fun setPopupContent(content: HTMLElement): Layer<Polyline.PolylineOptions>

setStyle

open fun setStyle(style: Path.PathOptions): Path<Polyline.PolylineOptions>

setTooltipContent

open fun setTooltipContent(content: Tooltip): Layer<Polyline.PolylineOptions>

open fun setTooltipContent(content: String): Layer<Polyline.PolylineOptions>

open fun setTooltipContent(content: HTMLElement): Layer<Polyline.PolylineOptions>

toGeoJSON

open fun toGeoJSON(precision: Number = definedExternally): Feature<GeoJsonSingleOrMultiLineString>

togglePopup

open fun togglePopup(): Layer<Polyline.PolylineOptions>

toggleTooltip

open fun toggleTooltip(): Layer<Polyline.PolylineOptions>

unbindPopup

open fun unbindPopup(): Layer<Polyline.PolylineOptions>

unbindTooltip

open fun unbindTooltip(): Layer<Polyline.PolylineOptions>