Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeoSegment

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new GeoSegment(lng0: number, lat0: number, lng1: number, lat1: number): GeoSegment

  • Parameters

    • lng0: number
    • lat0: number
    • lng1: number
    • lat1: number

    Returns GeoSegment

Properties

Readonly lat0

lat0: number

Readonly lat1

lat1: number

Readonly lng0

lng0: number

Readonly lng1

lng1: number

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

containsPoint

  • containsPoint(that: GeoPoint): boolean

  • Parameters

    Returns boolean

containsSegment

  • Parameters

    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

hashCode

  • hashCode(): number

  • Returns number

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

interpolateTo

  • Parameters

    Returns Interpolator<GeoSegment>

  • Parameters

    • that: unknown

    Returns null | Interpolator<GeoSegment>

intersects

  • Parameters

    Returns boolean

intersectsPoint

  • intersectsPoint(that: GeoPoint): boolean

  • Parameters

    Returns boolean

intersectsSegment

  • Parameters

    Returns boolean

isDefined

  • isDefined(): boolean

  • Returns boolean

project

split

toAny

  • Returns GeoSegmentInit

toString

  • toString(): string

  • Returns string

union

Static fromAny

Static fromInit

  • Parameters

    Returns GeoSegment

Static isAny

  • Parameters

    • value: unknown

    Returns value is AnyGeoSegment

Static isInit

  • Parameters

    • value: unknown

    Returns value is GeoSegmentInit

Static of

  • of(lng0: number, lat0: number, lng1: number, lat1: number): GeoSegment

  • Parameters

    • lng0: number
    • lat0: number
    • lng1: number
    • lat1: number

    Returns GeoSegment

Generated using TypeDoc