類別 GeoPolygon

Buffer

Clone

• Clone(): GeoPolygon

  產生一份新的自己。

  回傳 GeoPolygon

  複製的新的自己。

CopyFrom

• CopyFrom(obj: GeoPolyline | GeoPolygon | GeoBoundary | PointLike[]): GeoPolygon

  複製。

  參數

  • obj: GeoPolyline | GeoPolygon | GeoBoundary | PointLike[]

    複製的資料源。

  回傳 GeoPolygon

  this。

RemoveAll

• RemoveAll(): void

  移除所有的點位資料。

  回傳 void

SetGeoData

• SetGeoData(buffer: PointLike[]): boolean

  設定幾何資料，會檢查順逆時針，將其調整成正確的順序。

  若已知順序，可直接設定 Buffer 變數，以增進效能。

  參數

  • buffer: PointLike[]

    要設定的點位資料。

  回傳 boolean

  是否設定成功。

GetAt

• GetAt(index: number): GeoPoint

  取 Buffer 第 index 個點。

  參數

  • index: number

    索引。

  回傳 GeoPoint

  第index個點。

SetAt

• SetAt(index: number, obj: GeoPoint): void

  設定 Buffer 第 index 個點。

  參數

  • index: number

    索引。
  • obj: GeoPoint

    要設定的值。

  回傳 void

PtInPolygon

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

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

  參數

  • p: PointLike

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

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

  回傳 boolean

  是否位於多邊形內 (含邊緣)。

GetArea

• GetArea(): number

  計算此多邊形的面積。

  回傳 number

  面積。

IsConvex

• IsConvex(): boolean

  判定此多邊形是否為凸多邊形。

  回傳 boolean

  是否為凸多邊形。

IsGood

• IsGood(errPoint?: GeoPoint): boolean

  判定此多邊形是否為好的多邊形 (順序對，沒和自己相交，有面積...)。

  參數

  • 可選errPoint: GeoPoint

  回傳 boolean

  是否為好的多邊形。

ClipLine

• ClipLine(line: GeoLine, result: GeoLine): boolean

  將傳入的線用此自己來切除,只剩在自己內的線。

  參數

  • line: GeoLine

    欲處理的線段資料。
  • result: GeoLine

    此為out參數,須在執行前先配置好,執行後,此為處理後的答案。

  回傳 boolean

  是否執行成功。

ClipPolygon

• ClipPolygon(toClip: GeoPolygon, result: GeoPolygon): boolean

  將傳入的多邊形用自己來切除,只剩在多邊形內的範圍。

  參數

  • toClip: GeoPolygon

    欲處理的多邊形資料。
  • result: GeoPolygon

    此為out參數，須在執行前先配置好，執行後，此為處理後的答案。

  回傳 boolean

  是否執行成功。

IsIntersect

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

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

  參數

  • obj: GeoPolyline | GeoPolygon | GeoPolygonSet | GeoLine

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

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

  回傳 boolean

  是否相交。

CombinPolygon

• CombinPolygon(
      polygon: GeoPolygon,
      polygonSet: GeoPolygonSet,
      combineType: number,
  ): boolean

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

  參數

  • polygon: GeoPolygon

    運算的多邊形資料。
  • polygonSet: GeoPolygonSet

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

    運算類型。

  回傳 boolean

  是否運算成功。

  已被棄用

  請使用CombinePolygon

CombinePolygon

• CombinePolygon(
      polygon: GeoPolygon,
      polygonSet: GeoPolygonSet,
      combineType: number,
  ): boolean

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

  參數

  • polygon: GeoPolygon

    運算的多邊形資料。
  • polygonSet: GeoPolygonSet

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

    運算類型。

  回傳 boolean

  是否運算成功。

SplitByLine

• SplitByLine(
      line: GeoLine,
      rightAnswer: GeoPolygon[],
      leftAnswer: GeoPolygon[],
  ): boolean

  將自己用傳入的線段來切成右與左兩部分的多邊形。

  參數

  • line: GeoLine

    切割的線段。
  • rightAnswer: GeoPolygon[]

    此為out參數,需在執行前先配置好,執行後,傳回右邊的多邊形。
  • leftAnswer: GeoPolygon[]

    此為out參數,需在執行前先配置好,執行後,傳回左邊的多邊形。

  回傳 boolean

  是否運算成功

SplitByPolyline

• SplitByPolyline(
      polyline: GeoPolyline,
      rightAnswer: GeoPolygon[],
      leftAnswer: GeoPolygon[],
  ): boolean

  將自己用傳入的聚合線來切成右與左兩部分的多邊形。

  參數

  • polyline: GeoPolyline

    切割的聚合線。
  • rightAnswer: GeoPolygon[]

    此為out參數,需在執行前先配置好,執行後,傳回右邊的多邊形。
  • leftAnswer: GeoPolygon[]

    此為out參數,需在執行前先配置好,執行後,傳回左邊的多邊形。

  回傳 boolean

  是否運算成功。

SplitByPolygon

• SplitByPolygon(
      polygon: GeoPolygon,
      inside: GeoPolygonSet,
      outside: GeoPolygonSet,
  ): boolean

  將自己用傳入的多邊形來切成內部與外部兩部分的複合多邊形。

  參數

  • polygon: GeoPolygon

    切割的多邊形。
  • inside: GeoPolygonSet

    此為out參數,需在執行前先配置好,執行後,傳回內部的複合多邊形。
  • outside: GeoPolygonSet

    此為out參數,需在執行前先配置好,執行後,傳回外部的複合多邊形。

  回傳 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

  是否包含幾何。

Distance

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

  計算自己與指定幾何的距離。

  參數

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

    指定幾何。

  回傳 number

  距離。

Offset

• Offset(p: PointLike): void

  位移。

  參數

  • p: PointLike

    欲位移的距離。

  回傳 void

MakeBuffer

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

  做出環域的複合多邊形。

  參數

  • distance: number

    環域的距離。
  • polygonSet: GeoPolygonSet

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

  回傳 boolean

  回傳是否成功。

SimplifyByTolerance

• SimplifyByTolerance(maxErr: number, avoid?: null | GeoPolyline[]): number

  以指定誤差值簡約化多邊形

  參數

  • maxErr: number

    誤差值。
  • avoid: null | GeoPolyline[] = null

    在過程中要避免相交的聚合線。

  回傳 number

  簡約化後剩餘的點數。

SimplifyByPointCount

• SimplifyByPointCount(count?: number): number

  以指定點數簡約化多邊形。

  參數

  • 可選count: number

    簡約化後希望的點數。

  回傳 number

  簡約化後剩餘的點數。

ConvertToPolyline

• ConvertToPolyline(): GeoPolyline

  將此多邊形轉為聚合線。

  回傳 GeoPolyline

  轉換後的聚合線。

ToGeoJSON

• ToGeoJSON(toString?: false): PolygonSet

  將幾何輸出成 GeoJSON 物件。

  參數

  • 可選toString: false

    是否把物件轉成JSON字串。

  回傳 PolygonSet

  輸出轉換結果。
• ToGeoJSON(toString: true): string

  將幾何輸出成 GeoJSON 字串。

  參數

  • toString: true

    是否把物件轉成JSON字串。

  回傳 string

  輸出轉換結果。

FromGeoJSON

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

  讀入GeoJSON 數值。

  參數

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串。

  回傳 boolean

  回傳讀取是否成功。

ToGeoBuffer

• ToGeoBuffer(): Float64Array<ArrayBuffer>

  輸出成Float64Array緩衝區物件。

  回傳 Float64Array<ArrayBuffer>

  回傳多邊形點位陣列。

FromGeoBuffer

• FromGeoBuffer(geoBuffer: Float64Array): GeoPolygon

  讀入Float64Array緩衝區物件。

  參數

  • geoBuffer: Float64Array

  回傳 GeoPolygon

  this

DistanceInBound

• DistanceInBound(p: PointLike): number

  計算傳入的點到多邊形邊緣上的距離。

  參數

  • p: PointLike

    要計算距離的點。

  回傳 number

  距離。

constructor

• new GeoPolygon(): GeoPolygon

  建立多邊形

  回傳 GeoPolygon

  範例

  let polygon = new GeoPolygon(); // 預設建構子
  複製

• new GeoPolygon(obj: GeoPolygon): GeoPolygon

  建立多邊形

  參數

  • obj: GeoPolygon

    欲複製的GeoPolygon。

  回傳 GeoPolygon

  範例

  let polygon = new GeoPolygon();
  let polygonCopy = new GeoPolygon(polygon); // 使用欲複製的GeoPolygon建立GeoPolygon
  複製

• new GeoPolygon(obj: GeoPolyline): GeoPolygon

  建立多邊形

  參數

  • obj: GeoPolyline

    欲轉換的GeoPolyline。

  回傳 GeoPolygon

  範例

  let polygon = new GeoPolygon(new GeoPolyline()); // 使用欲轉換的GeoPolyline建立GeoPolygon
  複製

• new GeoPolygon(obj: GeoBoundary): GeoPolygon

  建立多邊形

  參數

  • obj: GeoBoundary

    欲轉換的GeoBoundary。

  回傳 GeoPolygon

  範例

  let polygon = new GeoPolygon(new GeoBoundary()); // 使用欲轉換的GeoBoundary建立GeoPolygon
  複製

• new GeoPolygon(obj: PointLike[]): GeoPolygon

  建立多邊形

  參數

  • obj: PointLike[]

    GeoPoint陣列。

  回傳 GeoPolygon

  範例

  let p1 = new GeoPoint(0, 0);
  let p2 = new GeoPoint(0, 1);
  let p3 = new GeoPoint(1, 0);
  let polygon = new GeoPolygon([p1, p2, p3]); // 使用GeoPoint陣列建立GeoPolygon
  複製

type

• get type(): 4

  物件型態,值為 GEO_TYPE.POLYGON

  回傳 4

length

• get length(): number

  點位的數量

  回傳 number

Boundary

• get Boundary(): GeoBoundary

  此幾何的範圍

  回傳 GeoBoundary

Center

• get Center(): GeoPoint

  此幾何的中心點

  回傳 GeoPoint