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

Index

Type aliases

GeoGeometryObjects

GeoGeometryObjects: GeometryObject | GeoSphere

Type Alias for GeoJSON Geometry Object and GeoSphere additional geometry supported by d3-geo

GeoPermissibleObjects

Type Alias for permissible objects which can be used with d3-geo methods

Functions

geoAlbers

  • The Albers’ equal area-conic projection. This is a U.S.-centric configuration of d3.geoConicEqualArea.

    Returns GeoConicProjection

geoAlbersUsa

  • A U.S.-centric composite projection of three d3.geoConicEqualArea projections: d3.geoAlbers is used for the lower forty-eight states, and separate conic equal-area projections are used for Alaska and Hawaii. Note that the scale for Alaska is diminished: it is projected at 0.35× its true relative area.

    Composite consist of several projections that are composed into a single display. The constituent projections have fixed clip, center and rotation, and thus composite projections do not support projection.center, projection.rotate, projection.clipAngle, or projection.clipExtent.

    Returns GeoProjection

geoArea

  • Returns the spherical area of the specified feature in steradians. (See also path.area, which computes the projected planar area.)

    Parameters

    Returns number

  • Returns the spherical area of the specified feature collection in steradians. (See also path.area, which computes the projected planar area.)

    Parameters

    Returns number

  • Returns the spherical area of the specified GeoJson Geometry Object or GeoSphere object in steradians. (See also path.area, which computes the projected planar area.)

    Parameters

    • feature: GeoGeometryObjects

      A GeoJson Geometry Object or GeoSphere object supported by d3-geo (An extension of GeoJSON).

    Returns number

  • Returns the spherical area of the specified geographic geometry collection in steradians. (See also path.area, which computes the projected planar area.)

    Parameters

    Returns number

geoAzimuthalEqualArea

  • The azimuthal equal-area projection.

    Returns GeoProjection

geoAzimuthalEqualAreaRaw

  • The raw azimuthal equal-area projection.

    Returns GeoRawProjection

geoAzimuthalEquidistant

  • The azimuthal equidistant projection.

    Returns GeoProjection

geoAzimuthalEquidistantRaw

  • The raw azimuthal equidistant projection.

    Returns GeoRawProjection

geoBounds

  • Returns the spherical bounding box for the specified feature. The bounding box is represented by a two-dimensional array: [[left, bottom], [right, top]], where left is the minimum longitude, bottom is the minimum latitude, right is maximum longitude, and top is the maximum latitude. All coordinates are given in degrees. (Note that in projected planar coordinates, the minimum latitude is typically the maximum y-value, and the maximum latitude is typically the minimum y-value.)

    Parameters

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

  • Returns the spherical bounding box for the specified feature collection. The bounding box is represented by a two-dimensional array: [[left, bottom], [right, top]], where left is the minimum longitude, bottom is the minimum latitude, right is maximum longitude, and top is the maximum latitude. All coordinates are given in degrees. (Note that in projected planar coordinates, the minimum latitude is typically the maximum y-value, and the maximum latitude is typically the minimum y-value.)

    Parameters

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

  • Returns the spherical bounding box for the specified GeoJson Geometry Object or GeoSphere object. The bounding box is represented by a two-dimensional array: [[left, bottom], [right, top]], where left is the minimum longitude, bottom is the minimum latitude, right is maximum longitude, and top is the maximum latitude. All coordinates are given in degrees. (Note that in projected planar coordinates, the minimum latitude is typically the maximum y-value, and the maximum latitude is typically the minimum y-value.)

    Parameters

    • feature: GeoGeometryObjects

      A GeoJson Geometry Object or GeoSphere object supported by d3-geo (An extension of GeoJSON).

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

  • Returns the spherical bounding box for the specified geometry collection. The bounding box is represented by a two-dimensional array: [[left, bottom], [right, top]], where left is the minimum longitude, bottom is the minimum latitude, right is maximum longitude, and top is the maximum latitude. All coordinates are given in degrees. (Note that in projected planar coordinates, the minimum latitude is typically the maximum y-value, and the maximum latitude is typically the minimum y-value.)

    Parameters

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

geoCentroid

  • Returns the spherical centroid of the specified feature in steradians. (See also path.centroid, which computes the projected planar centroid.)

    Parameters

    Returns [number, number]

  • Returns the spherical centroid of the specified feature collection in steradians. (See also path.centroid, which computes the projected planar centroid.)

    Parameters

    Returns [number, number]

  • Returns the spherical centroid of the specified GeoJson Geometry Object or GeoSphere object in steradians. (See also path.centroid, which computes the projected planar centroid.)

    Parameters

    • feature: GeoGeometryObjects

      A GeoJson Geometry Object or GeoSphere object supported by d3-geo (An extension of GeoJSON).

    Returns [number, number]

  • Returns the spherical centroid of the specified geographic geometry collection in steradians. (See also path.centroid, which computes the projected planar centroid.)

    Parameters

    Returns [number, number]

geoCircle

  • Returns a new geo circle generator

    Returns GeoCircleGenerator<any, any>

  • Returns a new geo circle generator

    The generic corresponds to the data type of the first argument passed into the geo circle generator and its accessor functions.

    Type parameters

    • Datum

    Returns GeoCircleGenerator<any, Datum>

  • Returns a new geo circle generator

    The first generic corresponds to the "this" context within which the geo circle generator and its accessors will be invoked.

    The second generic corresponds to the data type of the first argument passed into the geo circle generator and its accessor functions.

    Type parameters

    • This

    • Datum

    Returns GeoCircleGenerator<This, Datum>

geoConicConformal

  • The conic conformal projection. The parallels default to [30°, 30°] resulting in flat top.

    Returns GeoConicProjection

geoConicConformalRaw

  • The raw conic conformal projection.

    Parameters

    • phi0: number
    • phi1: number

    Returns GeoRawProjection

geoConicEqualArea

  • The Albers’ equal-area conic projection.

    Returns GeoConicProjection

geoConicEqualAreaRaw

  • The raw Albers’ equal-area conic projection.

    Parameters

    • phi0: number
    • phi1: number

    Returns GeoRawProjection

geoConicEquidistant

  • The conic equidistant projection.

    Returns GeoConicProjection

geoConicEquidistantRaw

  • The raw conic equidistant projection.

    Parameters

    • phi0: number
    • phi1: number

    Returns GeoRawProjection

geoDistance

  • geoDistance(a: [number, number], b: [number, number]): number
  • Returns the great-arc distance in radians between the two points a and b. Each point must be specified as a two-element array [longitude, latitude] in degrees.

    Parameters

    • a: [number, number]

      Point specified as a two-element array [longitude, latitude] in degrees.

    • b: [number, number]

      Point specified as a two-element array [longitude, latitude] in degrees.

    Returns number

geoEquirectangular

  • The equirectangular (plate carrée) projection.

    Returns GeoProjection

geoEquirectangularRaw

  • The raw equirectangular (plate carrée) projection.

    Returns GeoRawProjection

geoGnomonic

  • The gnomonic projection.

    Returns GeoProjection

geoGnomonicRaw

  • The raw gnomonic projection.

    Returns GeoRawProjection

geoGraticule

  • Constructs a feature generator for creating 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°.

    Returns GeoGraticuleGenerator

geoGraticule10

  • A convenience method for directly generating the default 10° global graticule as a GeoJSON MultiLineString geometry object.

    Returns MultiLineString

geoIdentity

  • Returns the identity transform which can be used to scale, translate and clip planar geometry.

    Returns GeoIdentityTranform

geoInterpolate

  • geoInterpolate(a: [number, number], b: [number, number]): function
  • Returns an interpolator function given two points a and b. Each point must be specified as a two-element array [longitude, latitude] in degrees.

    Parameters

    • a: [number, number]

      Point specified as a two-element array [longitude, latitude] in degrees.

    • b: [number, number]

      Point specified as a two-element array [longitude, latitude] in degrees.

    Returns function

      • (t: number): [number, number]
      • Parameters

        • t: number

        Returns [number, number]

geoLength

  • Returns the great-arc length of the specified feature in radians.

    Parameters

    Returns number

  • Returns the great-arc length of the specified feature collection in radians.

    Parameters

    Returns number

  • Returns the great-arc length of the specified GeoJson Geometry Object or GeoSphere object in radians.

    Parameters

    • feature: GeoGeometryObjects

      A GeoJson Geometry Object or GeoSphere object supported by d3-geo (An extension of GeoJSON).

    Returns number

  • Returns the great-arc length of the specified geographic geometry collection in radians.

    Parameters

    Returns number

geoMercator

  • The spherical Mercator projection. Defines a default projection.clipExtent such that the world is projected to a square, clipped to approximately ±85° latitude.

    Returns GeoProjection

geoMercatorRaw

  • The raw spherical Mercator projection.

    Returns GeoRawProjection

geoOrthographic

  • The orthographic projection.

    Returns GeoProjection

geoOrthographicRaw

  • The raw orthographic projection.

    Returns GeoRawProjection

geoPath

  • Creates a new geographic path generator.

    The default projection is the null projection. The null projection represents the identity transformation, i.e. the input geometry is not projected and is instead rendered directly in raw coordinates. This can be useful for fast rendering of pre-projected geometry, or for fast rendering of the equirectangular projection.

    The default context is null, which implies that the path generator will return an SVG path string.

    Parameters

    • Optional projection: GeoProjection | GeoStreamWrapper | null

      An (optional) current projection to be used. Typically this is one of D3’s built-in geographic projections; however, any object that exposes a projection.stream function can be used, enabling the use of custom projections. See D3’s transforms for more examples of arbitrary geometric transformations. Setting the projection to "null" uses the identity projection. The default value is "null", the identity projection.

    • Optional context: GeoContext | null

      An (optional) rendering context to be used. If a context is provided, it must at least implement the interface described by GeoContext, a subset of the CanvasRenderingContext2D API. Setting the context to "null" means that the path generator will return an SVG path string representing the to be rendered object. The default is "null".

    Returns GeoPath<any, GeoPermissibleObjects>

  • Creates a new geographic path generator with the default settings.

    The default projection is the null projection. The null projection represents the identity transformation: the input geometry is not projected and is instead rendered directly in raw coordinates. This can be useful for fast rendering of pre-projected geometry, or for fast rendering of the equirectangular projection.

    The default context is null, which implies that the path generator will return an SVG path string.

    The generic corresponds to the type of the DatumObject which will be passed into the geo path generator for rendering

    Type parameters

    Parameters

    • Optional projection: GeoProjection | GeoStreamWrapper | null

      An (optional) current projection to be used. Typically this is one of D3’s built-in geographic projections; however, any object that exposes a projection.stream function can be used, enabling the use of custom projections. See D3’s transforms for more examples of arbitrary geometric transformations. Setting the projection to "null" uses the identity projection. The default value is "null", the identity projection.

    • Optional context: GeoContext | null

      An (optional) rendering context to be used. If a context is provided, it must at least implement the interface described by GeoContext, a subset of the CanvasRenderingContext2D API. Setting the context to "null" means that the path generator will return an SVG path string representing the to be rendered object. The default is "null".

    Returns GeoPath<any, DatumObject>

  • Creates a new geographic path generator with the default settings.

    The default projection is the null projection. The null projection represents the identity transformation: the input geometry is not projected and is instead rendered directly in raw coordinates. This can be useful for fast rendering of pre-projected geometry, or for fast rendering of the equirectangular projection.

    The default context is null, which implies that the path generator will return an SVG path string.

    The first generic corresponds to the "this"-context within which the geo path generator will be invoked. This could be e.g. the DOMElement bound to "this" when using selection.attr("d", ...) with the path generator.

    The second generic corresponds to the type of the DatumObject which will be passed into the geo path generator for rendering.

    Type parameters

    Parameters

    • Optional projection: GeoProjection | GeoStreamWrapper | null

      An (optional) current projection to be used. Typically this is one of D3’s built-in geographic projections; however, any object that exposes a projection.stream function can be used, enabling the use of custom projections. See D3’s transforms for more examples of arbitrary geometric transformations. Setting the projection to "null" uses the identity projection. The default value is "null", the identity projection.

    • Optional context: GeoContext | null

      An (optional) rendering context to be used. If a context is provided, it must at least implement the interface described by GeoContext, a subset of the CanvasRenderingContext2D API. Setting the context to "null" means that the path generator will return an SVG path string representing the to be rendered object. The default is "null".

    Returns GeoPath<This, DatumObject>

geoProjection

  • Constructs a new projection from the specified raw projection, project. The project function takes the longitude and latitude of a given point in radians, often referred to as lambda (λ) and phi (φ), and returns a two-element array [x, y] representing its unit projection. The project function does not need to scale or translate the point, as these are applied automatically by projection.scale, projection.translate, and projection.center. Likewise, the project function does not need to perform any spherical rotation, as projection.rotate is applied prior to projection.

    If the project function exposes an invert method, the returned projection will also expose projection.invert.

    Parameters

    Returns GeoProjection

geoProjectionMutator

  • geoProjectionMutator(factory: function): function
  • Constructs a new projection from the specified raw projection factory and returns a mutate function to call whenever the raw projection changes. The factory must return a raw projection. The returned mutate function returns the wrapped projection.

    When creating a mutable projection, the mutate function is typically not exposed.

    Parameters

    Returns function

geoRotation

  • geoRotation(angles: [number, number] | [number, number, number]): GeoRotation
  • Returns a rotation function for the given angles.

    Parameters

    • angles: [number, number] | [number, number, number]

      A two- or three-element array of numbers [lambda, phi, gamma] specifying the rotation angles in degrees about each spherical axis. (These correspond to yaw, pitch and roll.) If the rotation angle gamma is omitted, it defaults to 0.

    Returns GeoRotation

geoStereographic

  • The stereographic projection.

    Returns GeoProjection

geoStereographicRaw

  • The raw stereographic projection.

    Returns GeoRawProjection

geoStream

  • Streams the specified GeoJSON object to the specified projection stream. While both features and geometry objects are supported as input, the stream interface only describes the geometry, and thus additional feature properties are not visible to streams.

    Parameters

    Returns void

  • Streams the specified GeoJSON object to the specified projection stream. While both features and geometry objects are supported as input, the stream interface only describes the geometry, and thus additional feature properties are not visible to streams.

    Parameters

    Returns void

  • Streams the specified GeoJSON object to the specified projection stream. While both features and geometry objects are supported as input, the stream interface only describes the geometry, and thus additional feature properties are not visible to streams.

    Parameters

    Returns void

  • Streams the specified GeoJSON object to the specified projection stream. While both features and geometry objects are supported as input, the stream interface only describes the geometry, and thus additional feature properties are not visible to streams.

    Parameters

    Returns void

geoTransform

  • geoTransform<T>(methods: T): object
  • Defines an arbitrary transform using the methods defined on the specified methods object. Any undefined methods will use pass-through methods that propagate inputs to the output stream.

    Type parameters

    Parameters

    • methods: T

      An object with custom method implementations, which are used to create a transform projection.

    Returns object

    • stream: function

geoTransverseMercator

  • The transverse spherical Mercator projection. Defines a default projection.clipExtent such that the world is projected to a square, clipped to approximately ±85° latitude.

    Returns GeoProjection

geoTransverseMercatorRaw

  • The raw transverse spherical Mercator projection.

    Returns GeoRawProjection

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