Class GeoPath

constructor

• new GeoPath(splines): GeoPath

• Parameters

  • splines: readonly GeoSpline[]

  Returns GeoPath

Readonly splines

bounds

• get bounds(): GeoBox

• Returns GeoBox

latMax

• get latMax(): number

• Returns number

latMin

• get latMin(): number

• Returns number

lngMax

• get lngMax(): number

• Returns number

lngMin

• get lngMin(): number

• Returns number

centroid

• centroid(): GeoPoint

• Returns GeoPoint

contains

• contains(that): boolean

• Parameters

  • that: GeoShapeLike

  Returns boolean

• contains(x, y): boolean

• Parameters

  • x: number

  • y: number

  Returns boolean

debug

• debug<T>(output): Output<T>

• Type Parameters

  • T

  Parameters

  • output: Output<T>

  Returns Output<T>

equals

• equals(that): boolean

• Parameters

  • that: unknown

  Returns boolean

equivalentTo

• equivalentTo(that, epsilon?): boolean

• Parameters

  • that: unknown

  • Optional epsilon: number

  Returns boolean

forEachCoord

• forEachCoord<R>(callback): R

• Type Parameters

  • R

  Parameters

  • callback: ((lng, lat) => void | R)

    • • (lng, lat): void | R

      • Parameters

        • lng: number

        • lat: number

        Returns void | R

  Returns R

• forEachCoord<R, S>(callback, thisArg): R

• Type Parameters

  • R

  • S

  Parameters

  • callback: ((this, lng, lat) => void | R)

    • • (this, lng, lat): void | R

      • Parameters

        • this: S

        • lng: number

        • lat: number

        Returns void | R

  • thisArg: S

  Returns R

interpolate

• interpolate(u): GeoPoint

• Parameters

  • u: number

  Returns GeoPoint

interpolateLat

• interpolateLat(u): number

• Parameters

  • u: number

  Returns number

interpolateLng

• interpolateLng(u): number

• Parameters

  • u: number

  Returns number

intersects

• intersects(that): boolean

• Parameters

  • that: GeoShapeLike

  Returns boolean

isClosed

• isClosed(): boolean

• Returns boolean

isDefined

• isDefined(): boolean

• Returns boolean

Optional likeType

• likeType(like): void

• Parameters

  • like: GeoSplinePoints | GeoPathSplines

  Returns void

project

• project(f): R2Path

• Parameters

  • f: GeoProjection

  Returns R2Path

split

• split(u): [GeoPath, GeoPath]

• Parameters

  • u: number

  Returns [GeoPath, GeoPath]

subdivide

• subdivide(u): GeoPath

• Parameters

  • u: number

  Returns GeoPath

toString

• toString(): string

• Returns string

Static builder

• builder(): GeoPathBuilder

• Returns GeoPathBuilder

Static closed

• closed(...curves): GeoPath

• Parameters

  • Rest ...curves: GeoCurve[]

  Returns GeoPath

Static empty

• empty(): GeoPath

• Returns GeoPath

Static fromLike

• fromLike<T>(value): GeoPath | Uninitable<T>

• Type Parameters

  • T extends GeoPathLike

  Parameters

  • value: T

  Returns GeoPath | Uninitable<T>

• fromLike<T>(value): never

• Type Parameters

  • T extends GeoShapeLike

  Parameters

  • value: T

  Returns never

Static fromPoints

• fromPoints(points): GeoPath

• Parameters

  • points: GeoSplinePoints

  Returns GeoPath

Static fromSplines

• fromSplines(values): GeoPath

• Parameters

  • values: GeoPathSplines

  Returns GeoPath

Static of

• of(...splines): GeoPath

• Parameters

  • Rest ...splines: GeoSpline[]

  Returns GeoPath

Static open

• open(...curves): GeoPath

• Parameters

  • Rest ...curves: GeoCurve[]

  Returns GeoPath