Class GeoPolygon

constructor

• new GeoPolygon(): GeoPolygon

• 建立多邊形

  Returns GeoPolygon

  Example

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

• new GeoPolygon(obj): GeoPolygon

• 建立多邊形

  Parameters

  • obj: GeoPolygon

    欲複製的GeoPolygon。

  Returns GeoPolygon

  Example

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

• new GeoPolygon(obj): GeoPolygon

• 建立多邊形

  Parameters

  • obj: GeoPolyline

    欲轉換的GeoPolyline。

  Returns GeoPolygon

  Example

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

• new GeoPolygon(obj): GeoPolygon

• 建立多邊形

  Parameters

  • obj: GeoBoundary

    欲轉換的GeoBoundary。

  Returns GeoPolygon

  Example

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

• new GeoPolygon(obj): GeoPolygon

• 建立多邊形

  Parameters

  • obj: PointLike[]

    GeoPoint陣列。

  Returns GeoPolygon

  Example

  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
  Copy

Buffer

Boundary

• get Boundary(): GeoBoundary

• 此幾何的範圍

  Returns GeoBoundary

Center

• get Center(): GeoPoint

• 此幾何的中心點

  Returns GeoPoint

length

• get length(): number

• 點位的數量

  Returns number

type

• get type(): 4

• 物件型態,值為 GEO_TYPE.POLYGON

  Returns 4

ClipLine

• ClipLine(line, result): boolean

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

  Parameters

  • line: GeoLine

    欲處理的線段資料。

  • result: GeoLine

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

  Returns boolean

  是否執行成功。

ClipPolygon

• ClipPolygon(toClip, result): boolean

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

  Parameters

  • toClip: GeoPolygon

    欲處理的多邊形資料。

  • result: GeoPolygon

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

  Returns boolean

  是否執行成功。

Clone

• Clone(): GeoPolygon

• 產生一份新的自己。

  Returns GeoPolygon

  複製的新的自己。

CombinPolygon

• CombinPolygon(polygon, polygonSet, combineType): boolean

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

  Parameters

  • polygon: GeoPolygon

    運算的多邊形資料。

  • polygonSet: GeoPolygonSet

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

  • combineType: number

    運算類型。

  Returns boolean

  是否運算成功。

ConvertToPolyline

• ConvertToPolyline(): GeoPolyline

• 將此多邊形轉為聚合線。

  Returns GeoPolyline

  轉換後的聚合線。

CopyFrom

• CopyFrom(obj): GeoPolygon

• 複製。

  Parameters

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

    複製的資料源。

  Returns GeoPolygon

  this。

Distance

• Distance(obj): number

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

  Parameters

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

    指定幾何。

  Returns number

  距離。

DistanceInBound

• DistanceInBound(p): number

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

  Parameters

  • p: PointLike

    要計算距離的點。

  Returns number

  距離。

FromGeoBuffer

• FromGeoBuffer(geoBuffer): GeoPolygon

• 讀入Float64Array緩衝區物件。

  Parameters

  • geoBuffer: Float64Array

  Returns GeoPolygon

  this

FromGeoJSON

• FromGeoJSON(src): boolean

• 讀入GeoJSON 數值。

  Parameters

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串。

  Returns boolean

  回傳讀取是否成功。

GetArea

• GetArea(): number

• 計算此多邊形的面積。

  Returns number

  面積。

GetAt

• GetAt(index): GeoPoint

• 取 Buffer 第 index 個點。

  Parameters

  • index: number

    索引。

  Returns GeoPoint

  第index個點。

Include

• Include(obj): boolean

• 自己是否包含傳入的幾何資料。

  Parameters

  • obj: GeoPolyline | PointLike | GeoLine

    判斷的幾何資料。

  Returns boolean

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

• 自己是否包含傳入的幾何資料。

  Parameters

  • obj: GeoPolygon | GeoPolygonSet

    判斷的幾何資料。

  • bound: boolean

    相交於邊上是否算包含。預設否。

  Returns boolean

  是否包含幾何。

IsConvex

• IsConvex(): boolean

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

  Returns boolean

  是否為凸多邊形。

IsGood

• IsGood(ErrPoint?): boolean

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

  Parameters

  • Optional ErrPoint: GeoPoint

  Returns boolean

  是否為好的多邊形。

IsIntersect

• IsIntersect(obj, slice?): boolean

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

  Parameters

  • obj: GeoPolygon | GeoPolyline | GeoPolygonSet | GeoLine

    判斷的幾何資料。

  • Optional slice: boolean

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

  Returns boolean

  是否相交。

MakeBuffer

• MakeBuffer(distance, polygonSet): boolean

• 做出環域的複合多邊形。

  Parameters

  • distance: number

    環域的距離。

  • polygonSet: GeoPolygonSet

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

  Returns boolean

  回傳是否成功。

Offset

• Offset(p): void

• 位移。

  Parameters

  • p: PointLike

    欲位移的距離。

  Returns void

PtInPolygon

• PtInPolygon(p, obj): boolean

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

  Parameters

  • p: PointLike

    欲檢查的點。

  • obj: {
        InBound?: boolean;
    }

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

    • Optional InBound?: boolean

  Returns boolean

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

RemoveAll

• RemoveAll(): void

• 移除所有的點位資料。

  Returns void

SetAt

• SetAt(index, obj): void

• 設定 Buffer 第 index 個點。

  Parameters

  • index: number

    索引。

  • obj: GeoPoint

    要設定的值。

  Returns void

SetGeoData

• SetGeoData(buffer): boolean

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

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

  Parameters

  • buffer: PointLike[]

    要設定的點位資料。

  Returns boolean

  是否設定成功。

SimplifyByPointCount

• SimplifyByPointCount(count): number

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

  Parameters

  • count: undefined | number

    簡約化後希望的點數。

  Returns number

  簡約化後剩餘的點數。

SimplifyByTolerance

• SimplifyByTolerance(maxErr, avoid?): number

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

  Parameters

  • maxErr: number

    誤差值。

  • avoid: null | GeoPolyline[] = null

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

  Returns number

  簡約化後剩餘的點數。

SplitByLine

• SplitByLine(line, rightAnswer, leftAnswer): boolean

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

  Parameters

  • line: GeoLine

    切割的線段。

  • rightAnswer: GeoPolygon[]

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

  • leftAnswer: GeoPolygon[]

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

  Returns boolean

  是否運算成功

SplitByPolygon

• SplitByPolygon(polygon, inside, outside): boolean

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

  Parameters

  • polygon: GeoPolygon

    切割的多邊形。

  • inside: GeoPolygonSet

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

  • outside: GeoPolygonSet

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

  Returns boolean

  是否運算成功。

SplitByPolyline

• SplitByPolyline(polyline, rightAnswer, leftAnswer): boolean

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

  Parameters

  • polyline: GeoPolyline

    切割的聚合線。

  • rightAnswer: GeoPolygon[]

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

  • leftAnswer: GeoPolygon[]

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

  Returns boolean

  是否運算成功。

ToGeoBuffer

• ToGeoBuffer(): Float64Array

• 輸出成Float64Array緩衝區物件。

  Returns Float64Array

  回傳多邊形點位陣列。

ToGeoJSON

• ToGeoJSON(toString?): PolygonSet

• 將幾何輸出成 GeoJSON 物件。

  Parameters

  • Optional toString: false

    是否把物件轉成JSON字串。

  Returns PolygonSet

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

• 將幾何輸出成 GeoJSON 字串。

  Parameters

  • toString: true

    是否把物件轉成JSON字串。

  Returns string

  輸出轉換結果。