類別 GeoPolygonSet

Bounds

Holes

Clone

• Clone(): GeoPolygonSet

  產生一份新的自己。

  回傳 GeoPolygonSet

  複製的新的自己。

CopyFrom

• CopyFrom(obj: GeoPolygon | GeoPolygonSet): GeoPolygonSet

  複製。

  參數

  • obj: GeoPolygon | GeoPolygonSet

    複製的資料源。

  回傳 GeoPolygonSet

  this

RemoveAll

• RemoveAll(): void

  移除所有的點位資料。

  回傳 void

CombinePolygonSet

• CombinePolygonSet(
      polygonSet: GeoPolygonSet,
      retPolygonSet: GeoPolygonSet,
      combineType: number,
  ): boolean

  將自己與傳入的複合多邊形做合併運算。

  參數

  • polygonSet: GeoPolygonSet

    運算的複合多邊形資料。
  • retPolygonSet: GeoPolygonSet

    此為out參數,需先在外面配好變數，合併後的結果。
  • combineType: number

    運算類型。

  回傳 boolean

  是否運算成功

GetArea

• GetArea(): number

  計算此複合多邊形的面積。

  回傳 number

  面積。

IsIntersect

• IsIntersect(
      obj: GeoPolyline | GeoPolygon | GeoPolygonSet,
      slice?: boolean,
  ): boolean

  判斷自己與傳入幾何是否相交。

  參數

  • obj: GeoPolyline | GeoPolygon | GeoPolygonSet

    判斷的幾何資料。
  • 可選slice: boolean

    指定若只交在節點上,算不算相交。

  回傳 boolean

  是否相交。

Include

• Include(obj: GeoPolyline | PointLike | GeoLine): boolean

  判斷自己是否包含指定的幾何。

  參數

  • obj: GeoPolyline | PointLike | GeoLine

    指定的幾何。

  回傳 boolean

  是否包含幾何。
• Include(obj: GeoPolygon | GeoPolygonSet, bound?: boolean): boolean

  判斷自己是否包含指定的幾何。

  參數

  • obj: GeoPolygon | GeoPolygonSet

    指定的幾何。
  • 可選bound: boolean

    指示相交於邊上是否算包含。

  回傳 boolean

  是否包含幾何。
• Include(
      obj: GeoPolyline | GeoPolygon | GeoPolygonSet | PointLike | GeoLine,
      bound?: boolean,
  ): boolean

  判斷自己是否包含指定的幾何。

  參數

  • obj: GeoPolyline | GeoPolygon | GeoPolygonSet | PointLike | GeoLine

    指定的幾何。
  • 可選bound: boolean

  回傳 boolean

  是否包含幾何。

Distance

• Distance(
      obj: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoLine,
  ): number

  計算自己與傳入幾何的距離。

  參數

  • obj: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoLine

    要計算距離的幾何資料。

  回傳 number

  距離。

PtInPolygonSet

• PtInPolygonSet(p: PointLike, obj: { InBound?: boolean }): boolean

  檢查傳入的點是否位於此複合多邊形內。

  參數

  • p: PointLike

    欲檢查的點。
  • obj: { InBound?: boolean }

    此為out參數,需在執行前先配置好,執行後, obj.InBound 代表是否位於邊緣上。

  回傳 boolean

  是否位於複合多邊形內。

Offset

• Offset(p: PointLike): void

  位移。

  參數

  • p: PointLike

    欲位移的距離。

  回傳 void

MakeBuffer

• MakeBuffer(distance: number, polygonSet: GeoPolygonSet): boolean

  做出環域的複合多邊形。

  參數

  • distance: number

    環域的距離。
  • polygonSet: GeoPolygonSet

    out參數，環域計算的答案。

  回傳 boolean

  是否成功。

ToGeoJSON

• ToGeoJSON(toString?: false, includeZ?: boolean): PolygonSet

  將幾何輸出成 GeoJSON 物件。

  參數

  • 可選toString: false

    是否把物件轉成JSON字串。
  • 可選includeZ: boolean

    是否包含Z，標準GeoJSON不包含Z (可不給，預設false)。

  回傳 PolygonSet

  輸出轉換結果。
• ToGeoJSON(toString: true, includeZ?: boolean): string

  將幾何輸出成 GeoJSON 字串。

  參數

  • toString: true

    是否把物件轉成JSON字串。
  • 可選includeZ: boolean

    是否包含Z，標準GeoJSON不包含Z (可不給，預設false)。

  回傳 string

  輸出轉換結果。

FromGeoJSON

• FromGeoJSON(src: string | GeoJSON.Geometry): boolean

  讀入GeoJSON 數值。

  參數

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串。

  回傳 boolean

  是否讀取成功。

ToGeoBuffer

• ToGeoBuffer(): [
      bounds: Float64Array<ArrayBufferLike>[],
      holes: Float64Array<ArrayBufferLike>[],
  ]

  輸出成緩衝區物件。

  回傳 [
      bounds: Float64Array<ArrayBufferLike>[],
      holes: Float64Array<ArrayBufferLike>[],
  ]

  回傳多邊形集合緩衝區陣列。

constructor

• new GeoPolygonSet(obj?: GeoPolygon | GeoPolygonSet | GeoBoundary): GeoPolygonSet

  建立複合多邊形

  參數

  • 可選obj: GeoPolygon | GeoPolygonSet | GeoBoundary

    欲複製的GeoPolygonSet、欲轉換的GeoPolygon / GeoBoundary。

  回傳 GeoPolygonSet

  範例

  let polygonSet = new GeoPolygonSet();//預設建構子
  let polygonSetCopy = new GeoPolygonSet(polygonSet);//使用欲複製的GeoPolygonSet建立GeoPolygonSet
  let polygonToSet = new GeoPolygonSet(new GeoPolygon());//使用欲轉換的GeoPolygon建立GeoPolygonSet
  let boundToSet = new GeoPolygonSet(new GeoBoundary());//使用欲轉換的GeoBoundary建立GeoPolygonSet
  複製

type

• get type(): 5

  物件型態,值為 GEO_TYPE.POLYGONSET

  回傳 5

Boundary

• get Boundary(): GeoBoundary

  範圍

  回傳 GeoBoundary

PointCount

• get PointCount(): number

  內含點位的數量

  回傳 number

Center

• get Center(): GeoPoint

  中心點

  回傳 GeoPoint