類別 GeoPolyline

Buffer

Clone

• Clone(): GeoPolyline

  產生一份新的自己。

  回傳 GeoPolyline

  傳回複製的新的自己。

CopyFrom

• CopyFrom(obj: GeoPolyline | GeoLine | GeoPoint[]): GeoPolyline

  複製。

  參數

  • obj: GeoPolyline | GeoLine | GeoPoint[]

    複製的資料源。

  回傳 GeoPolyline

  this

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

Distance

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

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

  參數

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

    要計算距離的幾何資料。

  回傳 number

  距離。

GetNearPoint

• GetNearPoint(p: PointLike3D, ret: GeoPoint): number

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

  參數

  • p: PointLike3D

    點。
  • ret: GeoPoint

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

  回傳 number

  離最近的點的距離。

Intersect

• Intersect(polyline: GeoPolyline, buffer: GeoPoint[]): number

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

  參數

  • polyline: GeoPolyline

    欲檢查的聚合線。
  • buffer: GeoPoint[]

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

  回傳 number

  交點的數量。

IsIntersect

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

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

  參數

  • obj: GeoPolyline | GeoPolygon | GeoPolygonSet

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

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

  回傳 boolean

  傳回是否相交。

Offset

• Offset(p: PointLike): void

  位移。

  參數

  • p: PointLike

    欲位移的距離。

  回傳 void

MakeBuffer

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

  做出環域的複合多邊形。

  參數

  • distance: number

    環域的距離。
  • polygonSet: GeoPolygonSet

    out參數，環域計算的答案。
  • twoSide: boolean = true

    是否要兩邊，預設是

  回傳 boolean

  回傳是否成功。

SimplifyByTolerance

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

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

  參數

  • maxErr: number

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

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

  回傳 number

  簡約化後剩餘的點數。

SimplifyByPointCount

• SimplifyByPointCount(
      count: number,
      delta: number,
      avoid?: null | GeoPolyline[],
  ): number

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

  參數

  • count: number

    簡約化後希望的點數。
  • delta: number

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

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

  回傳 number

  簡約化後剩餘的點數。

SplitByLine

• SplitByLine(line: GeoLine, buffer: GeoPolyline[]): boolean

  以線段切割。

  參數

  • line: GeoLine

    切割的線段。
  • buffer: GeoPolyline[]

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

  回傳 boolean

  切割的線數量。

SplitByPolyline

• SplitByPolyline(line: GeoPolyline, retBuffer: GeoPolyline[]): boolean

  以聚合線切割。

  參數

  • line: GeoPolyline

    切割的聚合線。
  • retBuffer: GeoPolyline[]

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

  回傳 boolean

  切割的線數量。

SplitByPolygon

• SplitByPolygon(
      polygon: GeoPolygon,
      inside: GeoPolyline[],
      outside: GeoPolyline[],
  ): boolean

  被多邊形切割。

  參數

  • polygon: GeoPolygon

    切割的多邊形。
  • inside: GeoPolyline[]

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

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

  回傳 boolean

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

GetPointByDistance1

• GetPointByDistance1(distance: number, p: GeoPoint): boolean

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

  參數

  • distance: number

    想要的距離。
  • p: GeoPoint

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

  回傳 boolean

  是否有答案。

GetPointByDistance2

• GetPointByDistance2(distance: number, p: GeoPoint): boolean

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

  參數

  • distance: number

    想要的距離。
  • p: GeoPoint

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

  回傳 boolean

  是否有答案。

MidByDistance1

• MidByDistance1(distance1: number, distance2: number): boolean

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

  參數

  • distance1: number

    切割的起始距離。
  • distance2: number

    切割的結束距離。

  回傳 boolean

  是否切割成功。

MidByDistance2

• MidByDistance2(distance1: number, distance2: number): boolean

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

  參數

  • distance1: number

    切割的起始距離。
  • distance2: number

    切割的結束距離。

  回傳 boolean

  是否切割成功。

Inverse

• Inverse(): void

  將點位逆向排序。

  回傳 void

InsertPoint

• InsertPoint(p: GeoPoint): boolean

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

  參數

  • p: GeoPoint

    要插入的點。

  回傳 boolean

  是否成功。

RemoveAll

• RemoveAll(): void

  移除所有點位資料。

  回傳 void

Join

• Join(polyline: GeoPolyline): boolean

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

  參數

  • polyline: GeoPolyline

    要相連的聚合線。

  回傳 boolean

  是否成功。

ToGeoJSON

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

  將幾何輸出成 GeoJSON 物件。

  參數

  • 可選toString: false

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

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

  回傳 GeoJSON.Polyline

  輸出轉換結果。
• 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

  回傳讀取是否成功。

Get3DNearPointFromPolyline

• Get3DNearPointFromPolyline(
      destPolyline: GeoPolyline,
  ): ConditionalResult<{ pt1: GeoPoint; pt2: GeoPoint }>

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

  參數

  • destPolyline: GeoPolyline

    目標聚合線。

  回傳 ConditionalResult<{ pt1: GeoPoint; pt2: GeoPoint }>

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

Get3DNearPointFromPoint

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

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

  參數

  • destPoint: PointLike3D

    目標點。

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

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

constructor

• new GeoPolyline(): GeoPolyline

  建立多點的線

  回傳 GeoPolyline

  範例

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

• new GeoPolyline(obj: GeoPolyline): GeoPolyline

  建立多點的線

  參數

  • obj: GeoPolyline

    欲複製的GeoPolyline。

  回傳 GeoPolyline

  範例

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

• new GeoPolyline(obj: GeoLine): GeoPolyline

  建立多點的線

  參數

  • obj: GeoLine

    欲轉換的GeoLine。

  回傳 GeoPolyline

  範例

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

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

  建立多點的線

  參數

  • obj: PointLike[]

    GeoPoint陣列。

  回傳 GeoPolyline

  範例

  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
  複製

• new GeoPolyline(obj: GeoPolygon): GeoPolyline

  建立多點的線

  參數

  • obj: GeoPolygon

    欲轉換的GeoPolygon。

  回傳 GeoPolyline

  範例

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

• new GeoPolyline(
      obj?: GeoPolyline | GeoPolygon | GeoLine | PointLike[],
  ): GeoPolyline

  建立多點的線

  參數

  • 可選obj: GeoPolyline | GeoPolygon | GeoLine | PointLike[]

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

  回傳 GeoPolyline

type

• get type(): 3

  物件型態,值為 GEO_TYPE.POLYLINE

  回傳 3

length

• get length(): number

  內含點位的數量

  回傳 number

Length

• get Length(): number

  長度

  回傳 number

Boundary

• get Boundary(): GeoBoundary

  範圍

  回傳 GeoBoundary

Center

• get Center(): GeoPoint

  中心點

  回傳 GeoPoint