WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

A Feature generator for graticules: a uniform grid of meridians and parallels for showing projection distortion. The default graticule has meridians and parallels every 10° between ±80° latitude; for the polar regions, there are meridians every 90°.

Hierarchy

  • GeoGraticuleGenerator

Callable

  • Returns a GeoJSON MultiLineString geometry object representing all meridians and parallels for this graticule.

    Returns MultiLineString

Index

Methods

extent

  • extent(): [[number, number], [number, number]]
  • extent(extent: [[number, number], [number, number]])
  • Returns the current minor extent, which defaults to ⟨⟨-180°, -80° - ε⟩, ⟨180°, 80° + ε⟩⟩.

    Returns [[number, number], [number, number]]

  • Sets the major and minor extents of this graticule.

    Parameters

    • extent: [[number, number], [number, number]]

      Extent to use for major and minor extent of graticule.

extentMajor

  • extentMajor(): [[number, number], [number, number]]
  • extentMajor(extent: [[number, number], [number, number]])
  • Returns the current major extent, which defaults to ⟨⟨-180°, -90° + ε⟩, ⟨180°, 90° - ε⟩⟩.

    Returns [[number, number], [number, number]]

  • Sets the major extent of this graticule.

    Parameters

    • extent: [[number, number], [number, number]]

      Major extent of graticule.

extentMinor

  • extentMinor(): [[number, number], [number, number]]
  • extentMinor(extent: [[number, number], [number, number]])
  • Returns the current minor extent, which defaults to ⟨⟨-180°, -80° - ε⟩, ⟨180°, 80° + ε⟩⟩.

    Returns [[number, number], [number, number]]

  • Sets the minor extent of this graticule.

    Parameters

    • extent: [[number, number], [number, number]]

      Minor extent of graticule.

lines

  • Returns an array of GeoJSON LineString geometry objects, one for each meridian or parallel for this graticule.

    Returns LineString[]

outline

  • Returns a GeoJSON Polygon geometry object representing the outline of this graticule, i.e. along the meridians and parallels defining its extent.

    Returns Polygon

precision

  • precision(): number
  • precision(angle: number)
  • Returns the current precision, which defaults to 2.5°.

    Returns number

  • Sets the precision for this graticule, in degrees.

    Parameters

    • angle: number

      Precision in degrees.

step

  • step(): [number, number]
  • step(step: [number, number])
  • Returns the current minor step, which defaults to ⟨10°, 10°⟩.

    Returns [number, number]

  • Sets the major and minor step for this graticule

    Parameters

    • step: [number, number]

      Major and minor step to use for this graticule.

stepMajor

  • stepMajor(): [number, number]
  • stepMajor(step: [number, number])
  • Returns the current major step, which defaults to ⟨90°, 360°⟩.

    Returns [number, number]

  • Sets the major step for this graticule.

    Parameters

    • step: [number, number]

      Major step.

stepMinor

  • stepMinor(): [number, number]
  • stepMinor(step: [number, number])
  • Returns the current major step, which defaults to ⟨10°, 10°⟩.

    Returns [number, number]

  • Sets the minor step for this graticule.

    Parameters

    • step: [number, number]

      Minor step.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc