Leaflet Map Polyline-用于在地图上绘制折线叠加层的类

Usage example

// create a red polyline from an array of LatLng points
var latlngs = [
    [45.51, -122.68],
    [37.77, -122.43],
    [34.04, -118.2]
];

var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);

// zoom the map to the polyline
map.fitBounds(polyline.getBounds());

You can also pass a multi-dimensional array to represent a MultiPolyline shape:

您还可以传递多维数组来表示 MultiPolyline 形状：

// create a red polyline from an array of arrays of LatLng points
var latlngs = [
    [[45.51, -122.68],
     [37.77, -122.43],
     [34.04, -118.2]],
    [[40.78, -73.91],
     [41.83, -87.62],
     [32.76, -96.72]]
];

Creation

Factory Description

L.polyline(<LatLng[]> latlngs,
<Polyline options> options?) Instantiates a polyline object given an array of geographical points and optionally an options object. You can create a Polyline object with multiple separate lines (MultiPolyline) by passing an array of arrays of geographic points.
在给定地理点数组和可选的选项对象的情况下实例化折线对象。您可以通过传递地理点数组的数组来创建具有多条单独线 (MultiPolyline) 的折线对象。

Factory	Description
`L.polyline(<LatLng[]> latlngs,` `<Polyline options> options?)`	Instantiates a polyline object given an array of geographical points and optionally an options object. You can create a `Polyline` object with multiple separate lines (`MultiPolyline`) by passing an array of arrays of geographic points. 在给定地理点数组和可选的选项对象的情况下实例化折线对象。您可以通过传递地理点数组的数组来创建具有多条单独线 (MultiPolyline) 的折线对象。

Options

Option	Type	Default	Description
`smoothFactor`	`Number`	`1.0`	How much to simplify the polyline on each zoom level. More means better performance and smoother look, and less means more accurate representation. 在每个缩放级别上简化多段线的程度。更多意味着更好的性能和更流畅的外观，更少意味着更准确的表示。
`noClip`	`Boolean`	`false`	Disable polyline clipping. 禁用折线剪裁。

▶ Options inherited from Path

从 Path 继承的选项

Option	Type	Default	Description
`stroke`	`Boolean`	`true`	Whether to draw stroke along the path. Set it to `false` to disable borders on polygons or circles. 是否沿路径绘制描边。将其设置为 false 以禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	Stroke color 描边颜色
`weight`	`Number`	`3`	Stroke width in pixels 笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	Stroke opacity 描边不透明度
`lineCap`	`String`	`'round'`	A string that defines shape to be used at the end of the stroke. 定义要在笔画末尾使用的形状的字符串。
`lineJoin`	`String`	`'round'`	A string that defines shape to be used at the corners of the stroke. 一个字符串，它定义了要在笔画角落使用的形状。
`dashArray`	`String`	`null`	A string that defines the stroke dash pattern. Doesn’t work on `Canvas`-powered layers in some old browsers. 定义笔划破折号模式的字符串。不适用于某些旧浏览器中基于 Canvas 的图层。
`dashOffset`	`String`	`null`	A string that defines the distance into the dash pattern to start the dash. Doesn’t work on `Canvas`-powered layers in some old browsers. 一个字符串，它定义到破折号模式的距离以开始破折号。不适用于某些旧浏览器中基于 Canvas 的图层。
`fill`	`Boolean`	`depends`	Whether to fill the path with color. Set it to `false` to disable filling on polygons or circles. 是否用颜色填充路径。将其设置为 false 以禁用对多边形或圆形的填充。
`fillColor`	`String`	`*`	Fill color. Defaults to the value of the `color` option 填色。默认为颜色选项的值
`fillOpacity`	`Number`	`0.2`	Fill opacity. 填充不透明度。
`fillRule`	`String`	`'evenodd'`	A string that defines how the inside of a shape is determined. 定义如何确定形状内部的字符串。
`bubblingMouseEvents`	`Boolean`	`true`	When `true`, a mouse event on this path will trigger the same event on the map (unless `L.DomEvent.stopPropagation` is used). 当为 true 时，此路径上的鼠标事件将触发地图上的相同事件（除非使用 L.DomEvent.stopPropagation）。
`renderer`	`Renderer`		Use this specific instance of `Renderer` for this path. Takes precedence over the map’s default renderer. 将此特定的渲染器实例用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	Custom class name set on an element. Only for SVG renderer. 在元素上设置的自定义类名。仅适用于 SVG 渲染器。

▶ Options inherited from Interactive layer

从交互层继承的选项

Option	Type	Default	Description
`interactive`	`Boolean`	`true`	If `false`, the layer will not emit mouse events and will act as a part of the underlying map. 如果为 false，则图层不会发出鼠标事件，而是作为底层地图的一部分。

▶ Options inherited from Layer

从图层继承的选项

Option	Type	Default	Description
`pane`	`String`	`'overlayPane'`	By default the layer will be added to the map’s overlay pane. Overriding this option will cause the layer to be placed on another pane by default. 默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致图层默认放置在另一个窗格上。
`attribution`	`String`	`null`	String to be shown in the attribution control, e.g. “© OpenStreetMap contributors”. It describes the layer data and is often a legal obligation towards copyright holders and tile providers. 要在归因控件中显示的字符串，例如“© OpenStreetMap 贡献者”。它描述了图层数据，并且通常是对版权所有者和切片提供者的法律义务。

Events

▶ Mouse events inherited from Interactive layer

从交互层继承的鼠标事件

Event	Data	Description
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer. 当用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer. 当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer. 当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer. 当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer. 当鼠标进入图层时触发。
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer. 当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press). 当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户按住单次触摸一秒钟（也称为长按）时，也会在移动设备上触发。

▶ Events inherited from Layer

从图层继承的事件

Event	Data	Description
`add`	`Event`	Fired after the layer is added to a map 在图层添加到地图后触发
`remove`	`Event`	Fired after the layer is removed from a map 从地图中移除图层后触发

▶ Popup events inherited from Layer

从图层继承的弹出事件

Event	Data	Description
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened 打开绑定到该层的弹出窗口时触发
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed 当绑定到该层的弹出窗口关闭时触发

▶ Tooltip events inherited from Layer

从图层继承的工具提示事件

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened. 打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed. 当绑定到该层的工具提示关闭时触发。

Methods

Method	Returns	Description
`toGeoJSON(<Number\|false> precision?)`	`Object`	Coordinates values are rounded with `formatNum` function with given `precision`. Returns a `GeoJSON` representation of the polyline (as a GeoJSON `LineString` or `MultiLineString` Feature). 坐标值使用给定精度的 formatNum 函数四舍五入。返回折线的 GeoJSON 表示（作为 GeoJSON LineString 或 MultiLineString 特征）。
`getLatLngs()`	`LatLng[]`	Returns an array of the points in the path, or nested arrays of points in case of multi-polyline. 返回路径中点的数组，或者在多折线的情况下返回点的嵌套数组。
`setLatLngs(<LatLng[]> latlngs)`	`this`	Replaces all the points in the polyline with the given array of geographical points. 用给定的地理点数组替换折线中的所有点。
`isEmpty()`	`Boolean`	Returns `true` if the Polyline has no LatLngs. 如果折线没有 LatLngs，则返回 true。
`closestLayerPoint(<Point> p)`	`Point`	Returns the point closest to `p` on the Polyline. 返回折线上最接近 p 的点。
`getCenter()`	`LatLng`	Returns the center (centroid) of the polyline. 返回折线的中心（质心）。
`getBounds()`	`LatLngBounds`	Returns the `LatLngBounds` of the path. 返回路径的 LatLngBounds。
`addLatLng(<LatLng> latlng,` `<LatLng[]> latlngs?)`	`this`	Adds a given point to the polyline. By default, adds to the first ring of the polyline in case of a multi-polyline, but can be overridden by passing a specific ring as a LatLng array (that you can earlier access with `getLatLngs`). 将给定点添加到折线。默认情况下，如果是多折线，则添加到折线的第一个环，但可以通过将特定环作为 LatLng 数组（您可以更早地使用 getLatLngs 访问）来覆盖。

▶ Methods inherited from Path

从 Path 继承的方法

Method	Returns	Description
`redraw()`	`this`	Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. 重绘图层。有时在更改路径使用的坐标后很有用。
`setStyle(<Path options> style)`	`this`	Changes the appearance of a Path based on the options in the `Path options` object. 根据路径选项对象中的选项更改路径的外观。
`bringToFront()`	`this`	Brings the layer to the top of all path layers. 将图层置于所有路径图层的顶部。
`bringToBack()`	`this`	Brings the layer to the bottom of all path layers. 将图层置于所有路径图层的底部。

▶ Methods inherited from Layer

从图层继承的方法

Method	Returns	Description
`addTo(<Map\|LayerGroup> map)`	`this`	Adds the layer to the given map or layer group. 将图层添加到给定的地图或图层组。
`remove()`	`this`	Removes the layer from the map it is currently active on. 从当前处于活动状态的地图中移除图层。
`removeFrom(<Map> map)`	`this`	Removes the layer from the given map 从给定地图中删除图层
`removeFrom(<LayerGroup> group)`	`this`	Removes the layer from the given `LayerGroup` 从给定的图层组中移除图层
`getPane(<String> name?)`	`HTMLElement`	Returns the `HTMLElement` representing the named pane on the map. If `name` is omitted, returns the pane for this layer. 返回表示地图上命名窗格的 HTMLElement。如果省略名称，则返回此图层的窗格。
`getAttribution()`	`String`	Used by the `attribution control`, returns the attribution option. 由归因控制使用，返回归因选项。

▶ Popup methods inherited from Layer

从图层继承的弹出方法

Method	Returns	Description
`bindPopup(<String\|HTMLElement\|` `Function\|Popup> content, <Popup options>` `options?)`	`this`	Binds a popup to the layer with the passed `content` and sets up the necessary event listeners. If a `Function` is passed it will receive the layer as the first argument and should return a `String` or `HTMLElement`. 使用传递的内容将弹出窗口绑定到图层并设置必要的事件侦听器。如果传递了一个函数，它将接收图层作为第一个参数，并应返回一个字符串或 HTMLElement。
`unbindPopup()`	`this`	Removes the popup previously bound with `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Opens the bound popup at the specified `latlng` or at the default popup anchor if no `latlng` is passed. 移除之前与 bindPopup 绑定的弹出窗口。
`closePopup()`	`this`	Closes the popup bound to this layer if it is open. 如果该层打开，则关闭绑定到该层的弹出窗口。
`togglePopup()`	`this`	Opens or closes the popup bound to this layer depending on its current state. 根据当前状态打开或关闭绑定到该层的弹出窗口。
`isPopupOpen()`	`boolean`	Returns `true` if the popup bound to this layer is currently open. 如果绑定到此图层的弹出窗口当前打开，则返回 true。
`setPopupContent(<String\|` `HTMLElement\|Popup>` `content)`	`this`	Sets the content of the popup bound to this layer. 设置绑定到该层的弹出窗口的内容。
`getPopup()`	`Popup`	Returns the popup bound to this layer. 返回绑定到该层的弹出窗口。

▶ Tooltip methods inherited from Layer

从图层继承的工具提示方法

Method	Returns	Description
`bindTooltip(<String\|` `HTMLElement\|Function\|` `Tooltip> content,` `<Tooltip options> options?)`	`this`	Binds a tooltip to the layer with the passed `content` and sets up the necessary event listeners. If a `Function` is passed it will receive the layer as the first argument and should return a `String` or `HTMLElement`. 使用传递的内容将工具提示绑定到图层并设置必要的事件侦听器。如果传递了一个函数，它将接收图层作为第一个参数，并应返回一个字符串或 HTMLElement。
`unbindTooltip()`	`this`	Removes the tooltip previously bound with `bindTooltip`. 移除之前与 bindTooltip 绑定的工具提示。
`openTooltip(<LatLng> latlng?)`	`this`	Opens the bound tooltip at the specified `latlng` or at the default tooltip anchor if no `latlng` is passed. 如果未传递任何 latlng，则在指定的 latlng 或默认的工具提示锚点处打开绑定的工具提示。
`closeTooltip()`	`this`	Closes the tooltip bound to this layer if it is open. 如果此图层打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	Opens or closes the tooltip bound to this layer depending on its current state. 根据其当前状态打开或关闭绑定到此图层的工具提示。
`isTooltipOpen()`	`boolean`	Returns `true` if the tooltip bound to this layer is currently open. 如果绑定到此图层的工具提示当前打开，则返回 true。
`setTooltipContent(<String\|` `HTMLElement\|Tooltip>` `content)`	`this`	Sets the content of the tooltip bound to this layer. 设置绑定到该图层的工具提示的内容。
`getTooltip()`	`Tooltip`	Returns the tooltip bound to this layer. 返回绑定到该图层的工具提示。

▶ Methods inherited from Evented

继承自 Evented 的方法

Method	Returns	Description
`on(<String> type, <Function>` `fn, <Object> context?)`	`this`	Adds a listener function (`fn`) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. `'click dblclick'`). 将侦听器函数 (fn) 添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this 关键字将指向的对象）。您还可以传递几种以空格分隔的类型（例如“click dblclick”）。
`on(<Object> eventMap)`	`this`	Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}` 添加一组类型/侦听器对，例如{点击：onClick，鼠标移动：onMouseMove}
`off(<String> type,` `<Function> fn?,` `<Object> context?)`	`this`	Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to `on`, you must pass the same context to `off` in order to remove the listener. 删除以前添加的侦听器函数。如果未指定函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给 on，则必须将相同的上下文传递给 off 才能移除侦听器。
`off(<Object> eventMap)`	`this`	Removes a set of type/listener pairs. 删除一组类型/侦听器对。
`off()`	`this`	Removes all listeners to all events on the object. This includes implicitly attached events. 删除对象上所有事件的所有侦听器。这包括隐式附加事件。
`fire(<String> type,` `<Object> data?,` `<Boolean> propagate?)`	`this`	Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event can optionally be propagated to event parents. 触发指定类型的事件。您可以选择提供一个数据对象——侦听器函数的第一个参数将包含其属性。可以选择将事件传播到事件父级。
`listens(<String> type,` `<Boolean> propagate?)`	`Boolean`	Returns `true` if a particular event type has any listeners attached to it. The verification can optionally be propagated, it will return `true` if parents have the listener attached to it. 如果特定事件类型附加了任何侦听器，则返回 true。验证可以选择传播，如果父母有监听器附加到它，它将返回 true。
`once(…)`	`this`	Behaves as `on(…)`, except the listener will only get fired once and then removed. 表现为 on(…)，除了监听器只会被触发一次然后被移除。
`addEventParent(<Evented> obj)`	`this`	Adds an event parent – an `Evented` that will receive propagated events 添加事件父级 – 将接收传播事件的事件
`removeEventParent(<Evented> obj)`	`this`	Removes an event parent, so it will stop receiving propagated events 删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	Alias to `on(…)`
`removeEventListener(…)`	`this`	Alias to `off(…)`
`clearAllEventListeners(…)`	`this`	Alias to `off()`
`addOneTimeEventListener(…)`	`this`	Alias to `once(…)`
`fireEvent(…)`	`this`	Alias to `fire(…)`
`hasEventListeners(…)`	`Boolean`	Alias to `listens(…)`

5 1 投票

文章评分