Class GeoPath

Hierarchy

GeoShape
- GeoPath

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GeoPath(splines: readonly GeoSpline[]): GeoPath

Overrides GeoShape.constructor
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:13
Parameters
- splines: readonly GeoSpline[]
Returns GeoPath

Properties

Readonly boundingBox

boundingBox: null | GeoBox

Readonly splines

splines: readonly GeoSpline[]

Accessors

bounds

get bounds(): GeoBox

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:31
Returns GeoBox

latMax

get latMax(): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:20
Returns number

latMin

get latMin(): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:18
Returns number

lngMax

get lngMax(): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:19
Returns number

lngMin

get lngMin(): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:17
Returns number

Methods

centroid

centroid(): GeoPoint

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:32
Returns GeoPoint

contains

contains(that: AnyGeoShape): boolean
contains(x: number, y: number): boolean

Overrides GeoShape.contains
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:24
Parameters
- that: AnyGeoShape
Returns boolean
Overrides GeoShape.contains
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:25
Parameters
- x: number
- y: number
Returns boolean

debug

debug(output: Output<unknown>): void

Implementation of Debug.debug
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:37
Parameters
- output: Output<unknown>
Returns void

equals

equals(that: unknown): boolean

Implementation of Equals.equals

Overrides GeoShape.equals
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:36
Parameters
- that: unknown
Returns boolean

equivalentTo

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

Implementation of Equivalent.equivalentTo
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:35
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

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:33
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
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:34
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

interpolate(u: number): GeoPoint

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:23
Parameters
- u: number
Returns GeoPoint

interpolateLat

interpolateLat(u: number): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:22
Parameters
- u: number
Returns number

interpolateLng

interpolateLng(u: number): number

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:21
Parameters
- u: number
Returns number

intersects

intersects(that: AnyGeoShape): boolean

Overrides GeoShape.intersects
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:26
Parameters
- that: AnyGeoShape
Returns boolean

isDefined

isDefined(): boolean

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:15
Returns boolean

project

project(f: GeoProjection): R2Path

Overrides GeoShape.project
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:29
Parameters
- f: GeoProjection
Returns R2Path

split

split(u: number): [GeoPath, GeoPath]

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:27
Parameters
- u: number
Returns [GeoPath, GeoPath]

subdivide

subdivide(u: number): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:28
Parameters
- u: number
Returns GeoPath

toString

toString(): string

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:38
Returns string

union

union(that: AnyGeoShape): GeoShape

Inherited from GeoShape.union
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoShape.d.ts:17
Parameters
- that: AnyGeoShape
Returns GeoShape

Static builder

builder(): GeoPathBuilder

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:47
Returns GeoPathBuilder

Static closed

closed(...curves: GeoCurve[]): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:42
Parameters
- Rest ...curves: GeoCurve[]
Returns GeoPath

Static empty

empty(): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:39
Returns GeoPath

Static fromAny

fromAny(value: AnyGeoPath): GeoPath
fromAny(value: AnyGeoShape): GeoShape

Overrides GeoShape.fromAny
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:45
Parameters
- value: AnyGeoPath
Returns GeoPath
Overrides GeoShape.fromAny
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:46
Parameters
- value: AnyGeoShape
Returns GeoShape

Static fromPoints

fromPoints(points: GeoSplinePoints): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:43
Parameters
- points: GeoSplinePoints
Returns GeoPath

Static fromSplines

fromSplines(values: GeoPathSplines): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:44
Parameters
- values: GeoPathSplines
Returns GeoPath

Static isAny

isAny(value: unknown): value is AnyGeoShape

Inherited from GeoShape.isAny
- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoShape.d.ts:22
Parameters
- value: unknown
Returns value is AnyGeoShape

Static isAnyPath

isAnyPath(value: unknown): value is AnyGeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:49
Parameters
- value: unknown
Returns value is AnyGeoPath

Static isSplines

isSplines(value: unknown): value is GeoPathSplines

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:48
Parameters
- value: unknown
Returns value is GeoPathSplines

Static of

of(...splines: GeoSpline[]): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:40
Parameters
- Rest ...splines: GeoSpline[]
Returns GeoPath

Static open

open(...curves: GeoCurve[]): GeoPath

- Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoPath.d.ts:41
Parameters
- Rest ...curves: GeoCurve[]
Returns GeoPath

Generated using TypeDoc