类：经纬网

ol/layer/Graticule~经纬网


import Graticule from 'ol/layer/Graticule.js';

渲染坐标系网格的图层（当前仅支持 欧洲石油调查组织:4326）。请注意，视图投影必须同时定义范围和世界范围。

new Graticule(options)

layer/Graticule.js, line 185
Name Type 描述
className string (defaults to 'ol-layer')

要设置到图层元素上的 CSS 类名。
opacity number (defaults to 1)

不透明度 (0, 1)。
visible boolean (defaults to true)

可见.
extent Extent | undefined

图层渲染的边界范围。图层不会在此范围外渲染。
zIndex number | undefined

图层渲染的 Z-index。渲染时，图层将先按 Z-index 排序，再按位置排序。undefined, a zIndex对于添加到地图的图层，默认值为0。layers集合，或Infinity当图层的setMap()采用了该方法。
minResolution number | undefined

该图层可见的最小分辨率（含）。
maxResolution number | undefined

最大分辨率（排他性），低于此分辨率时图层可见。
minZoom number | undefined

最小缩放级别（不含），高于此级别时图层可见。
maxZoom number | undefined

该图层可见的最大视图缩放级别（包含）。
maxLines number (defaults to 100)

从地图中心辐射的经线和纬线的最大数量。默认值100表示最多显示200条经线和200条纬线。该默认值适用于保角投影，例如球面墨卡托投影。若增大该值，将绘制更多线条，绘制性能会随之下降。
strokeStyle Stroke | undefined

用于绘制经纬网的描边样式。如果未提供，将使用以下描边：

new Stroke({
  color: 'rgba(0, 0, 0, 0.2)' // a not fully opaque black
});
targetSize number (defaults to 100)

网格单元的目标大小（以像素为单位）。
showLabels boolean (defaults to false)

为每条经纬线标注其对应的纬度/经度。
lonLabelFormatter function | undefined

经度标签格式化器。该函数以经度值为参数进行调用，并应返回一个表示该经度的格式化字符串。默认情况下，标签格式为度、分、秒及方向（例如东经/西经）。
latLabelFormatter function | undefined

纬度标签格式化器。此函数以纬度为参数调用，应返回一个表示纬度的格式化字符串。默认情况下，标签格式为度、分、秒及半球。
lonLabelPosition number (defaults to 0)

经度标签位置相对于视图范围的比例（0到1），0表示视口底部，1表示视口顶部。
latLabelPosition number (defaults to 1)

纬度标签位置以视图范围的比例（0..1）表示。0表示位于视口左侧，1表示位于视口右侧。
lonLabelStyle Text | undefined

经度标签文本样式。若未提供，将使用以下样式：

new Text({
  font: '12px Calibri,sans-serif',
  textBaseline: 'bottom',
  fill: new Fill({
    color: 'rgba(0,0,0,1)'
  }),
  stroke: new Stroke({
    color: 'rgba(255,255,255,1)',
    width: 3
  })
});

请注意，默认设置textBaseline该配置不适用于lonLabelPosition将标签定位在靠近视口顶部的配置。
latLabelStyle Text | undefined

纬度标签的文本样式。若未提供，则使用以下样式：

new Text({
  font: '12px Calibri,sans-serif',
  textAlign: 'end',
  fill: new Fill({
    color: 'rgba(0,0,0,1)'
  }),
  stroke: Stroke({
    color: 'rgba(255,255,255,1)',
    width: 3
  })
});

请注意，默认设置。textAlign配置不适用于此latLabelPosition将标签定位在视口左侧附近的配置。
intervals Array.<number> (defaults to [90, 45, 30, 20, 10, 5, 2, 1, 30/60, 20/60, 10/60, 5/60, 2/60, 1/60, 30/3600, 20/3600, 10/3600, 5/3600, 2/3600, 1/3600])

经纬网间隔（单位：度）。示例：将经纬网间隔限制为 30 度和 10 度。

[30, 10]
wrapX boolean (defaults to true)

经纬网是否水平重复？
properties Object.<string, *> | undefined

任意可观察属性。可通过以下方式访问。#get()和#set().
触发事件：

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
extent Extent | undefined 是 change:extent

图层范围。
maxResolution number 是 change:maxresolution

图层的最大分辨率。
maxZoom number 是的 change:maxzoom

图层的最大缩放级别。
minResolution number 是的 change:minresolution

图层的最小分辨率。
minZoom number 是的 change:minzoom

图层的最小缩放级别。
opacity number 确认 change:opacity

图层不透明度。
source SourceType | null 是 change:source

图层源（或null如果尚未设置。
visible boolean 是的 change:visible

的值visible层的属性。
zIndex number | undefined 是的 change:zindex

图层的Z索引。

方法

changed() inherited

Observable.js, line 68

递增修订计数器并触发 change 事件。

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

分发事件并调用所有监听该类型事件的监听器。事件参数可以是字符串，也可以是包含 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。
返回：
false 如果事件对象上调用了 preventDefault 或任何侦听器返回 false。

get(key){*} inherited

Object.js, line 135

获取值。

Name Type 描述
key string

键名。
返回：
值。

getAttributions(view){Array.<string>} inherited

layer/Layer.js, line 344

获取给定视图中该图层源的归属。

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

视图或FrameState仅当图层未添加到地图中时才需要。
返回：
该图层在给定视图中的归属。

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

返回图层的 extent；若该图层无论范围如何均可见，则返回 undefined。

返回：
图层范围

getFeatures(pixel){Promise<Array<FeatureLike>>} inherited

layer/BaseVector.js, line 178

获取视口上给定像素相交的最顶层要素。返回一个Promise，该Promise解析为一个要素数组。当检测到命中时，数组将包含最顶层要素；否则，数组为空。

该命中检测算法为提升性能而优化，但精度低于 map.getFeaturesAtPixel() 中使用的算法。文本不被纳入检测范围，图标仅以其边界框近似表示，而非精确图像。

Name Type 描述
pixel Pixel

像素.
返回：
一个解析为要素数组的Promise。

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名称列表。

返回：
属性名称列表。

getMaxResolution(){number} inherited

layer/Base.js, line 220

返回图层的最大分辨率。若图层未设置最大分辨率，则返回 Infinity。

返回：
图层的最大分辨率。

getMaxZoom(){number} inherited

layer/Base.js, line 253

返回图层的最大缩放级别。若图层未设置最大缩放级别，则返回 Infinity。

返回：
图层的最大缩放级别

getMeridians(){Array<LineString>}

layer/Graticule.js, line 1106

获取经线列表。经线是经度相等的线。

返回：
经线。

getMinResolution(){number} inherited

layer/Base.js, line 231

返回图层的最小分辨率。若图层未设置最小分辨率，则返回 0。

返回：
图层的最小分辨率。

getMinZoom(){number} inherited

layer/Base.js, line 242

获取图层的最小缩放级别。若未设置，则返回 -Infinity。

返回：
图层的最小缩放级别。

getOpacity(){number} inherited

layer/Base.js, line 263

返回图层的不透明度（值在 0 到 1 之间）。

返回：
图层不透明度。

getParallels(){Array<LineString>}

layer/Graticule.js, line 1175

获取纬线列表。纬线是纬度相等的线。

返回：
纬线。

getProperties(){Object.<string, *>} inherited

Object.js, line 157

获取包含所有属性名称和值的对象。

返回：
对象。

getRevision(){number} inherited

Observable.js, line 79

获取此对象的版本号。每当对象被修改时，版本号将自动递增。

返回：
修订版。

getSource(){SourceType | null} inherited

layer/Layer.js, line 209

获取图层源。

返回：
图层源（若未设置，则使用 null）。

getStyle(){StyleLike | FlatStyleLike | null | undefined} inherited

layer/BaseVector.js, line 204

获取要素的样式。此方法返回在构造时传递给 style 选项或传递给 setStyle 方法的样式。

返回：
图层样式。

getStyleFunction(){StyleFunction | undefined} inherited

layer/BaseVector.js, line 213

获取样式函数。

返回：
图层样式函数。

getVisible(){boolean} inherited

layer/Base.js, line 282

返回此图层 visible 属性的值。如需确定图层在地图上是否可见，请使用 isVisible()。

返回：
图层的 visible 属性值

getZIndex(){number | undefined} inherited

layer/Base.js, line 293

返回图层的 Z-index，用于在渲染前对图层进行排序。若图层为非托管状态，则返回 undefined。

返回：
图层的Z索引。

isVisible(view){boolean} inherited

layer/Layer.js, line 300

图层在地图视图中可见，即位于其最小/最大分辨率、缩放级别或空间范围内，未设置为 visible: false，且不在设置为 visible: false 的图层组内。

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

视图或FrameState仅当图层未添加到地图时才需要。
返回：
该图层在地图视图中可见。

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。
listener function

监听器函数。
返回：
监听器的唯一键。如果以事件类型数组作为第一个参数调用，则返回将是键数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

一次性监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。
listener function

监听器函数。
返回：
监听器的唯一键。若以事件类型数组作为第一个参数调用，则返回键数组。

set(key, value, silent) inherited

Object.js, line 215

设置值。

Name Type 描述
key string

键名
value *

值。
silent boolean | undefined

更新时不触发事件。

setDeclutter(declutter) inherited

layer/BaseVector.js, line 288
Name Type 描述
declutter boolean | string | number

清理图像和文本。

setExtent(extent) inherited

layer/Base.js, line 313

设置图层的可见范围。如果 undefined，则图层在任何范围下均可见。

Name Type 描述
extent Extent | undefined

图层范围。

setMap(map) inherited

layer/Layer.js, line 439

设置需渲染于其他图层之上的图层。地图不会在其图层集合中管理该图层，此功能适用于临时图层。如需从地图中移除非托管图层，请使用 #setMap(null)。

要将图层添加到地图并由地图管理，请改用 addLayer。

Name Type 描述
map Map | null

地图.

setMaxResolution(maxResolution) inherited

layer/Base.js, line 323

设置图层可见的最大分辨率。

Name Type 描述
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom) inherited

layer/Base.js, line 345

设置图层可见的最大缩放级别（不包含该级别）。请注意，图层可见的缩放级别基于视图缩放级别，而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
maxZoom number

图层的最大缩放。

setMinResolution(minResolution) inherited

layer/Base.js, line 333

设置图层的最小可见分辨率。

Name Type 描述
minResolution number

图层的最小分辨率。

setMinZoom(minZoom) inherited

layer/Base.js, line 357

设置图层可见的最小缩放级别（包含该级别）。请注意，图层可见性的缩放级别基于视图缩放级别，而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
minZoom number

图层的最小缩放级别。

setOpacity(opacity) inherited

layer/Base.js, line 367

设置图层的不透明度，取值范围为 0 到 1。

Name Type 描述
opacity number

图层的不透明度。

setProperties(values, silent) inherited

Object.js, line 235

设置键值对集合。请注意，此操作将修改现有属性并添加新属性，但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。
silent boolean | undefined

更新时不触发事件。

setSource(source) inherited

layer/Layer.js, line 487

设置图层源。

Name Type 描述
source SourceType | null

图层源。

setStyle(style) inherited

layer/BaseVector.js, line 276

设置要素的样式。这可以是一个单个样式对象、一个样式数组，或一个接受要素和分辨率并返回样式数组的函数。如果设置为 null，则图层没有样式（null 样式），因此只有具有自身样式的要素才会在图层中渲染。调用不带参数的 setStyle() 来重置为默认样式。有关默认样式的信息，请参阅 the ol/style/Style module。

若图层采用静态样式，可直接使用 flat style 对象字面量，而非 Style 及符号构造函数（Fill、Stroke 等）。

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})
Name Type 描述
style StyleLike | FlatStyleLike | null | undefined

图层样式。

setVisible(visible) inherited

layer/Base.js, line 378

设置图层可见性（true 或 false）。

Name Type 描述
visible boolean

图层可见性。

setZIndex(zindex) inherited

layer/Base.js, line 389

设置图层的Z索引，用于在渲染前对图层进行排序。默认Z索引为0。

Name Type 描述
zindex number

图层的z-index

un(type, listener) inherited

Observable.js, line 173

取消监听某种类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型的数组
listener function

监听器函数。

unset(key, silent) inherited

Object.js, line 259

移除属性。

Name Type 描述
key string

键名
silent boolean | undefined

取消设置而不触发事件。