An
ImageryProvider that generates high-quality reference grids directly into globe tiles.
It supports geographic latitude/longitude cells, Uber H3 cells, and MGRS cells, with per-segment
styling that can be updated dynamically in response to application events.
| Name | Type | Description |
|---|---|---|
options |
ReferenceGridImageryProvider.ConstructorOptions | optional Object describing initialization options. |
Type Definitions
Initialization options for the ReferenceGridImageryProvider constructor.
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
tilingScheme |
TilingScheme |
<optional> |
new GeographicTilingScheme() | The tiling scheme to use for generated tiles. |
ellipsoid |
Ellipsoid |
<optional> |
Ellipsoid.default | The ellipsoid for the default geographic tiling scheme. |
gridType |
ReferenceGridImageryProviderGridType |
<optional> |
"latlon" | The grid family to render. |
tileWidth |
number |
<optional> |
256 | The width of generated tiles, in pixels. |
tileHeight |
number |
<optional> |
256 | The height of generated tiles, in pixels. |
minimumLevel |
number |
<optional> |
The minimum requestable level. | |
maximumLevel |
number |
<optional> |
The maximum requestable level. | |
backgroundColor |
Color |
<optional> |
Color.TRANSPARENT | Background color for each tile. |
lineColor |
Color |
<optional> |
Default minor boundary color. | |
majorLineColor |
Color |
<optional> |
Default major boundary color. | |
fillColor |
Color |
<optional> |
Default fill color. | |
labelColor |
Color |
<optional> |
Color.WHITE | Default label color. |
labelHaloColor |
Color |
<optional> |
Default label halo color. | |
glowColor |
Color |
<optional> |
Default line glow color. | |
lineWidth |
number |
<optional> |
1.2 | Default boundary line width, in pixels. |
majorLineWidth |
number |
<optional> |
2.0 | Default major boundary line width, in pixels. |
glowWidth |
number |
<optional> |
3.5 | Default boundary glow width, in pixels. |
opacity |
number |
<optional> |
1.0 | Global opacity multiplier. |
showLabels |
boolean |
<optional> |
Whether labels should be drawn by default. | |
labelFont |
string |
<optional> |
Default CSS font for labels. | |
segmentStyles |
object.<string, ReferenceGridImageryProvider.SegmentStyle> |
<optional> |
Per-segment style overrides keyed by segment ID. | |
segmentStyleEvaluator |
function |
<optional> |
Dynamic style resolver called during tile rendering. | |
latLonStepsDegrees |
Array.<number> |
<optional> |
Candidate latitude/longitude cell sizes in degrees for the lat/lon grid. | |
latLonLatitudeStepDegrees |
number |
<optional> |
Fixed latitude step in degrees for the lat/lon grid. | |
latLonLongitudeStepDegrees |
number |
<optional> |
Fixed longitude step in degrees for the lat/lon grid. | |
latLonOriginLatitudeDeg |
number |
<optional> |
-90.0 | Southern edge of the fixed lat/lon grid origin. |
latLonOriginLongitudeDeg |
number |
<optional> |
-180.0 | Western edge of the fixed lat/lon grid origin. |
latLonTargetCells |
number |
<optional> |
4 | Target number of cells across a tile for the lat/lon grid. |
h3ResolutionByLevel |
function |
<optional> |
Optional H3 resolution mapping callback. | |
h3MaxResolution |
number |
<optional> |
8 | Highest automatic H3 resolution to request. |
mgrsPrecisionByLevel |
function |
<optional> |
Optional MGRS precision mapping callback. | |
mgrsEdgeSamples |
number |
<optional> |
5 | Number of interpolation samples used for each MGRS cell edge. |
Styling overrides for a single rendered grid segment.
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
visible |
boolean |
<optional> |
true | Whether the segment should be drawn. |
lineColor |
Color |
<optional> |
Boundary color. | |
fillColor |
Color |
<optional> |
Fill color for the segment interior. | |
labelColor |
Color |
<optional> |
Label text color. | |
labelHaloColor |
Color |
<optional> |
Label halo color. | |
glowColor |
Color |
<optional> |
Outer halo color around segment boundaries. | |
lineWidth |
number |
<optional> |
Boundary line width, in pixels. | |
glowWidth |
number |
<optional> |
Glow line width, in pixels. | |
opacity |
number |
<optional> |
1.0 | Opacity multiplier applied to all segment colors. |
showLabel |
boolean |
<optional> |
Whether the segment label should be drawn. | |
labelFont |
string |
<optional> |
CSS font for labels. |