OpenLayers

Module: ol/layer/Graticule

ol/layer/Graticule


Classes

Graticule

Type Definitions

GraticuleLabelDataType{Object}

Properties:
Name Type Description
geom module:ol/geom/Point~Point
text string

Options{Object}

Properties:
Name Type Argument Default Description
className string <optional>
 'ol-layer'

A CSS class name to set to the layer element.
opacity number <optional>
 1

Opacity (0, 1).
visible boolean <optional>
 true

Visibility.
extent module:ol/extent~Extent <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
zIndex number <optional>

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.
minResolution number <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number <optional>

The maximum resolution (exclusive) below which this layer will be visible.
maxLines number <optional>
 100

The maximum number of meridians and parallels from the center of the map. The default value of 100 means that at most 200 meridians and 200 parallels will be displayed. The default value is appropriate for conformal projections like Spherical Mercator. If you increase the value, more lines will be drawn and the drawing performance will decrease.
strokeStyle module:ol/style/Stroke~Stroke <optional>
 'rgba(0,0,0,0.2)'

The stroke style to use for drawing the graticule. If not provided, a not fully opaque black will be used.
targetSize number <optional>
 100

The target size of the graticule cells, in pixels.
showLabels boolean <optional>
 false

Render a label with the respective latitude/longitude for each graticule line.
lonLabelFormatter function <optional>

Label formatter for longitudes. This function is called with the longitude as argument, and should return a formatted string representing the longitude. By default, labels are formatted as degrees, minutes, seconds and hemisphere.
latLabelFormatter function <optional>

Label formatter for latitudes. This function is called with the latitude as argument, and should return a formatted string representing the latitude. By default, labels are formatted as degrees, minutes, seconds and hemisphere.
lonLabelPosition number <optional>
 0

Longitude label position in fractions (0..1) of view extent. 0 means at the bottom of the viewport, 1 means at the top.
latLabelPosition number <optional>
 1

Latitude label position in fractions (0..1) of view extent. 0 means at the left of the viewport, 1 means at the right.
lonLabelStyle module:ol/style/Text~Text <optional>

Longitude label text style. If not provided, the following style will be used:

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
  })
});

Note that the default's textBaseline configuration will not work well for lonLabelPosition configurations that position labels close to the top of the viewport.
latLabelStyle module:ol/style/Text~Text <optional>

Latitude label text style. If not provided, the following style will be used:

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
  })
});

Note that the default's textAlign configuration will not work well for latLabelPosition configurations that position labels close to the left of the viewport.
intervals Array.<number> <optional>
 [90, 45, 30, 20, 10, 5, 2, 1, 0.5, 0.2, 0.1, 0.05, 0.01, 0.005, 0.002, 0.001]

Intervals (in degrees) for the graticule. Example to limit graticules to 30 and 10 degrees intervals:

[30, 10]
wrapX boolean <optional>
 true

Whether to repeat the graticule horizontally.