Class GeoPolyline

constructor

• new GeoPolyline(): GeoPolyline

• 建立多點的線

  Returns GeoPolyline

  Example

  let polyline = new GeoPolyline(); // 預設建構子
  Copy

• new GeoPolyline(obj): GeoPolyline

• 建立多點的線

  Parameters

  • obj: GeoPolyline

    欲複製的GeoPolyline。

  Returns GeoPolyline

  Example

  let polyline = new GeoPolyline();
  let polylineCopy = new GeoPolyline(polyline); // 使用欲複製的GeoPolyline建立GeoPolyline
  Copy

• new GeoPolyline(obj): GeoPolyline

• 建立多點的線

  Parameters

  • obj: GeoLine

    欲轉換的GeoLine。

  Returns GeoPolyline

  Example

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

• new GeoPolyline(obj): GeoPolyline

• 建立多點的線

  Parameters

  • obj: PointLike[]

    GeoPoint陣列。

  Returns GeoPolyline

  Example

  let p1 = new GeoPoint(0, 0);
  let p2 = new GeoPoint(0, 1);
  let p3 = new GeoPoint(1, 0);
  let polyline = new GeoPolyline([p1, p2, p3]); // 使用GeoPoint陣列建立GeoPolyline
  Copy

• new GeoPolyline(obj): GeoPolyline

• 建立多點的線

  Parameters

  • obj: GeoPolygon

    欲轉換的GeoPolygon。

  Returns GeoPolyline

  Example

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

• new GeoPolyline(obj?): GeoPolyline

• 建立多點的線

  Parameters

  • Optional obj: GeoPolygon | GeoPolyline | GeoLine | PointLike[]

    欲複製的GeoPolyline; 欲轉換的GeoLine; GeoPoint陣列。

  Returns GeoPolyline

Buffer

Boundary

• get Boundary(): GeoBoundary

• 範圍

  Returns GeoBoundary

Center

• get Center(): GeoPoint

• 中心點

  Returns GeoPoint

Length

• get Length(): number

• 長度

  Returns number

length

• get length(): number

• 內含點位的數量

  Returns number

type

• get type(): 3

• 物件型態,值為 GEO_TYPE.POLYLINE

  Returns 3

Clone

• Clone(): GeoPolyline

• 產生一份新的自己。

  Returns GeoPolyline

  傳回複製的新的自己。

CopyFrom

• CopyFrom(obj): GeoPolyline

• 複製。

  Parameters

  • obj: GeoPolyline | GeoPoint[] | GeoLine

    複製的資料源。

  Returns GeoPolyline

  this

Distance

• Distance(obj): number

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

  Parameters

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

    要計算距離的幾何資料。

  Returns number

  距離。

FromGeoJSON

• FromGeoJSON(src): boolean

• 讀入 GeoJSON 數值。

  Parameters

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串 。

  Returns boolean

  回傳讀取是否成功。

Get3DNearPointFromPoint

• Get3DNearPointFromPoint(destPoint): ConditionalResult<{
      distance: number;
      pt: GeoPoint;
  }, {
      distance: 0;
      pt: null;
  }>

• 取得聚合線在線上與目標點最近的點(考慮z)，在平面中直接使用即可，在球型要先將線從Map轉成WorldMap再計算，算完再轉回Map。

  Parameters

  • destPoint: PointLike3D

    目標點。

  Returns ConditionalResult<{
      distance: number;
      pt: GeoPoint;
  }, {
      distance: 0;
      pt: null;
  }>

  success:是否成功,pt1:來源聚合線上的最近點,distance:目標聚合線上的最近點。

Get3DNearPointFromPolyline

• Get3DNearPointFromPolyline(destPolyline): {
      success: false;
  } | {
      success: true;
  } & {
      pt1: Geo3DPoint;
      pt2: Geo3DPoint;
  }

• 取得兩條聚合線在線上最近的兩點(考慮z)，在平面中直接使用即可，在球型要先將線從Map轉成WorldMap再計算，算完再轉回Map。

  Parameters

  • destPolyline: GeoPolyline

    目標聚合線。

  Returns {
      success: false;
  } | {
      success: true;
  } & {
      pt1: Geo3DPoint;
      pt2: Geo3DPoint;
  }

  success:是否成功,pt1:來源聚合線上的最近點,pt2:目標聚合線上的最近點。

GetAt

• GetAt(index): GeoPoint

• 取 Buffer 第index個點。

  Parameters

  • index: number

    索引。

  Returns GeoPoint

  第index個點

GetNearPoint

• GetNearPoint(p, ret): number

• 取得在此線段中，離 p 最近的點。

  Parameters

  • p: PointLike

    點。

  • ret: GeoPoint

    此為out，要在外面先配置好，會傳回最近的點。

  Returns number

  離最近的點的距離。

GetPointByDistance1

• GetPointByDistance1(distance, p): boolean

• 從起點開始，沿著聚合線走，找出沿著聚合線的距離為distance的點位。

  Parameters

  • distance: number

    想要的距離。

  • p: GeoPoint

    此為out參數，需再呼叫前先配置好，執行後，傳回找到的答案。

  Returns boolean

  是否有答案。

GetPointByDistance2

• GetPointByDistance2(distance, p): boolean

• 從起點開始，沿著聚合線走，找出某點離起點直線距離為distance的點位。

  Parameters

  • distance: number

    想要的距離。

  • p: GeoPoint

    此為out參數,需再呼叫前先配置好,執行後,傳回找到的答案。

  Returns boolean

  是否有答案。

InsertPoint

• InsertPoint(p): boolean

• 若輸入的點位於聚合線上，將點插於聚合線中的適當位置。

  Parameters

  • p: GeoPoint

    要插入的點。

  Returns boolean

  是否成功。

Intersect

• Intersect(polyline, buffer): number

• 計算與傳入的聚合線的交點。

  Parameters

  • polyline: GeoPolyline

    欲檢查的聚合線。

  • buffer: GeoPoint[]

    此為out參數,需先在外面配好變數，回傳時，代表交點。

  Returns number

  交點的數量。

Inverse

• Inverse(): void

• 將點位逆向排序。

  Returns void

IsIntersect

• IsIntersect(obj, slice?): boolean

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

  Parameters

  • obj: GeoPolygon | GeoPolygonSet | GeoPolyline

    判斷的幾何資料。

  • Optional slice: boolean

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

  Returns boolean

  傳回是否相交。

Join

• Join(polyline): boolean

• 傳入的聚合線若與本身可相連,則將聚合線連於自己。

  Parameters

  • polyline: GeoPolyline

    要相連的聚合線。

  Returns boolean

  是否成功。

MakeBuffer

• MakeBuffer(distance, polygonSet, twoSide?): boolean

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

  Parameters

  • distance: number

    環域的距離。

  • polygonSet: GeoPolygonSet

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

  • twoSide: boolean = true

    是否要兩邊，預設是

  Returns boolean

  回傳是否成功。

MidByDistance1

• MidByDistance1(distance1, distance2): boolean

• 將自己切成沿聚合線走，距離distance1與distance2之間的聚合線。

  Parameters

  • distance1: number

    切割的起始距離。

  • distance2: number

    切割的結束距離。

  Returns boolean

  是否切割成功。

MidByDistance2

• MidByDistance2(distance1, distance2): boolean

• 將自己切成沿聚合線走，離起點直線距離distance1與distance2之間的聚合線。

  Parameters

  • distance1: number

    切割的起始距離。

  • distance2: number

    切割的結束距離。

  Returns boolean

  是否切割成功。

Offset

• Offset(p): void

• 位移。

  Parameters

  • p: PointLike

    欲位移的距離。

  Returns void

RemoveAll

• RemoveAll(): void

• 移除所有點位資料。

  Returns void

SetAt

• SetAt(index, obj): void

• 設定 Buffer 第index個點。

  Parameters

  • index: number

    索引。

  • obj: GeoPoint

    要設定的值。

  Returns void

SimplifyByPointCount

• SimplifyByPointCount(count, delta, avoid?): number

• 指定希望點數簡約化聚合線。

  Parameters

  • count: number

    簡約化後希望的點數。

  • delta: number

    誤差值。

  • avoid: null | GeoPolyline[] = null

    簡約化過程中要避免相交的聚合線。

  Returns number

  簡約化後剩餘的點數。

SimplifyByTolerance

• SimplifyByTolerance(maxErr, avoid?): number

• 以指定誤差值簡約化聚合線。

  Parameters

  • maxErr: number

    誤差值。

  • avoid: null | GeoPolyline[] = null

    簡約化過程中要避免相交的聚合線。

  Returns number

  簡約化後剩餘的點數。

SplitByLine

• SplitByLine(line, buffer): boolean

• 以線段切割。

  Parameters

  • line: GeoLine

    切割的線段。

  • buffer: GeoPolyline[]

    此為out參數，需再呼叫前先配置好，執行完後，傳回切割的聚合線。

  Returns boolean

  切割的線數量。

SplitByPolygon

• SplitByPolygon(polygon, inside, outside): boolean

• 被多邊形切割。

  Parameters

  • polygon: GeoPolygon

    切割的多邊形。

  • inside: GeoPolyline[]

    此為out參數，需再呼叫前先配置好，執行完後，傳回被切後，在多邊形內的聚合線。

  • outside: GeoPolyline[]

    此為out參數，需再呼叫前先配置好，執行完後，傳回被切後，在多邊形外的聚合線。

  Returns boolean

  傳回被削下的所有聚合線的數量。

SplitByPolyline

• SplitByPolyline(line, retBuffer): boolean

• 以聚合線切割。

  Parameters

  • line: GeoPolyline

    切割的聚合線。

  • retBuffer: GeoPolyline[]

    此為out參數，需再呼叫前先配置好，執行完後，傳回切割的聚合線。

  Returns boolean

  切割的線數量。

ToGeoJSON

• ToGeoJSON(toString?, includeZ?): GeoJSON.Polyline

• 將幾何輸出成 GeoJSON 物件。

  Parameters

  • Optional toString: false

    是否把物件轉成JSON字串。

  • Optional includeZ: boolean

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

  Returns GeoJSON.Polyline

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

• 將幾何輸出成 GeoJSON 字串。

  Parameters

  • toString: true

    是否把物件轉成JSON字串。

  • Optional includeZ: boolean

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

  Returns string

  輸出轉換結果。