@d3-maps/core / graticule

graticule

Table of contents

• Functions
  • renderGraticule()
  • renderOutline()
• Interfaces
  • GraticuleConfig
  • MapGraticuleProps

Functions

renderGraticule()

function renderGraticule(context: MapContext, config?: GraticuleConfig): string | null;

Parameters

Parameter	Type
context	MapContext
config?	GraticuleConfig

Returns

string | null

---

renderOutline()

function renderOutline(context: MapContext): string | null;

Parameters

Parameter	Type
context	MapContext

Returns

string | null

Interfaces

GraticuleConfig

Extra graticule generator method calls to apply before rendering.

Uses d3-geo geoGraticule() setter method names as keys. Example: { step: [[10, 10]], precision: 2.5 }

See

https://d3js.org/d3-geo/shape#geoGraticule

Extends

• MethodsToModifiers<GeoGraticuleGenerator>

Properties

Property	Type	Inherited from
extent?	[[[number, number], [number, number]]]	MethodsToModifiers.extent
extentMajor?	[[[number, number], [number, number]]]	MethodsToModifiers.extentMajor
extentMinor?	[[[number, number], [number, number]]]	MethodsToModifiers.extentMinor
precision?	number	[number]
step?	[[number, number]]	MethodsToModifiers.step
stepMajor?	[[number, number]]	MethodsToModifiers.stepMajor
stepMinor?	[[number, number]]	MethodsToModifiers.stepMinor

---

MapGraticuleProps

Shared props contract for graticule layers.

Extends

• MapObjectProps<TStyle>

Type Parameters

Type Parameter	Default type
TStyle	unknown

Properties

Property	Type	Inherited from
background?	string	boolean
border?	string	boolean
config?	GraticuleConfig	-
styles?	Partial<Record<"default"	"hover"