Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeoSpline

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    • curves: readonly GeoCurve[]
    • closed: boolean

    Returns GeoSpline

Properties

Readonly boundingBox

boundingBox: null | GeoBox

Readonly closed

closed: boolean

Readonly curves

curves: readonly GeoCurve[]

Accessors

bounds

  • 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

Methods

contains

  • contains(that: AnyGeoShape): boolean
  • contains(lng: number, lat: number): boolean
  • Parameters

    Returns boolean

  • Parameters

    • lng: number
    • lat: number

    Returns boolean

debug

  • debug(output: Output<unknown>): void
  • Parameters

    Returns void

equals

  • equals(that: unknown): boolean
  • Parameters

    • that: unknown

    Returns boolean

equivalentTo

  • equivalentTo(that: unknown, epsilon?: number): boolean
  • Parameters

    • that: unknown
    • Optional epsilon: number

    Returns boolean

forEachCoord

  • forEachCoord<R>(callback: (lng: number, lat: number) => void | R): undefined | R
  • forEachCoord<R, S>(callback: (lng: number, lat: number) => void | R, thisArg: S): undefined | R
  • Type parameters

    • R

    Parameters

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

          • lng: number
          • lat: number

          Returns void | R

    Returns undefined | R

  • Type parameters

    • R

    • S

    Parameters

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

          • lng: number
          • lat: number

          Returns void | R

    • thisArg: S

    Returns undefined | R

forEachCoordRest

  • forEachCoordRest<R>(callback: (lng: number, lat: number) => void | R): undefined | R
  • forEachCoordRest<R, S>(callback: (lng: number, lat: number) => void | R, thisArg: S): undefined | R
  • Type parameters

    • R

    Parameters

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

          • lng: number
          • lat: number

          Returns void | R

    Returns undefined | R

  • Type parameters

    • R

    • S

    Parameters

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

          • lng: number
          • lat: number

          Returns void | R

    • thisArg: S

    Returns undefined | R

interpolate

  • Parameters

    • u: number

    Returns GeoPoint

interpolateLat

  • interpolateLat(u: number): number
  • Parameters

    • u: number

    Returns number

interpolateLng

  • interpolateLng(u: number): number
  • Parameters

    • u: number

    Returns number

intersects

  • Parameters

    Returns boolean

isClosed

  • isClosed(): boolean
  • Returns boolean

isDefined

  • isDefined(): boolean
  • Returns boolean

project

split

subdivide

  • Parameters

    • u: number

    Returns GeoSpline

toString

  • toString(): string
  • Returns string

union

Static builder

  • Returns GeoSplineBuilder

Static closed

  • Parameters

    Returns GeoSpline

Static empty

  • Returns GeoSpline

Static fromAny

  • Parameters

    Returns GeoSpline

  • Parameters

    Returns GeoShape

Static fromPoints

  • Parameters

    Returns GeoSpline

Static isAny

  • Parameters

    • value: unknown

    Returns value is AnyGeoShape

Static isAnySpline

  • Parameters

    • value: unknown

    Returns value is AnyGeoSpline

Static isPoints

  • Parameters

    • value: unknown

    Returns value is GeoSplinePoints

Static open

  • Parameters

    Returns GeoSpline

Generated using TypeDoc