類別 CVectorLayer

向量圖層。

範例

const vectorLayer = myMapDoc.NewVectorLayer({ Name: "test" });

層級 (查看層級一覽)

CLayer2D
- CVectorLayer

方法

NewPoint_Color

NewPoint_Color(
    p: GeoPoint,
    color: string,
    radius: number,
    unit?: UNIT,
    textStyle?: CTextStyle,
): string | number
新增點圖素 (圓形顏色)。
參數
- p: GeoPoint
  點中心位置。
- color: string
  顏色。
- radius: number
  圓半徑。
- 可選unit: UNIT
  圖素大小單位。
- 可選textStyle: CTextStyle
  標籤樣式，沒指定就不顯示標籤。
回傳 string | number
傳回圖素 ID。
已被棄用
棄用，建議使用 NewPoint。
範例
```
let id = vectorLayer.NewPoint_Color(new GeoPoint(), "#ffffff", 10, UNIT.PIXEL);
let id = vectorLayer.NewPoint_Color(new GeoPoint(), "rgb(0,0,0)", 10000, UNIT.MAP);
let id = vectorLayer.NewPoint_Color(new GeoPoint(), "rgb(0,0,0)", 10, UNIT.PIXEL, text);
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:120

NewPoint_Symbol

NewPoint_Symbol(
    p: GeoPoint,
    symbolUrl: string,
    size?: CSize,
    textStyle?: CTextStyle,
): string | number
新增點圖素 (符號)。
參數
- p: GeoPoint
  點中心位置。
- symbolUrl: string
  符號圖片的連結。
- 可選size: CSize
  符號大小，沒給則用符號圖片本身的大小。
- 可選textStyle: CTextStyle
  標籤樣式，沒指定就不顯示標籤。
回傳 string | number
傳回圖素 ID。
已被棄用
棄用，建議使用 NewPoint。
範例
```
let id = vectorLayer.NewPoint_Symbol(new GeoPoint(), "http://127.0.0.1:8080/Position48.png", new CSize(128, 128), text );
let id = vectorLayer.NewPoint_Symbol(new GeoPoint(), "http://127.0.0.1:8080/Position48.png");
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:170

NewPoint

NewPoint(param: PointEntityParameter): string | number | ol.Feature

新增點，若要大量新增建議使用 NewBatchPoint。

如果有需要文字標籤，先建立文字樣式物件，見 CTextStyle。

參數

param: PointEntityParameter
圖素設定參數。

回傳 string | number | ol.Feature

傳回圖素 ID (預設) 或圖素本身。

範例

// 新增圓點
this.VectorLayer.NewPoint({
	Point: new GeoPoint(163887.80, 2600000),
	FillColor: "rgba(0, 0, 1, 0)",
	Radius: 1000,
	RadiusUnit: UNIT.MAP,
	TextStyle: textStyle
});

// 新增符號
this.VectorLayer.NewPoint({
	Point: new GeoPoint(165000, 2650000),
	SymbolUrl: "http://127.0.0.1:8080/台灣全圖_84TM2.jpg",
	SymbolSize: new CSize(48, 48),
	TextStyle: textStyle
});

// 預設回傳 Feature ID，設定 ReturnType: "SELF" 則回傳 Feature 物件
this.VectorLayer.NewPoint({
	//...
	ReturnType: "SELF"
});

NewBatchPoint

NewBatchPoint(
    params: BatchPointParameter[],
    callback: (featureId: number[] | ol.Feature[]) => void,
    doNotAddToSource?: boolean,
    returnType?: string,
): void
批量新增點圖素。

如果有需要文字標籤，先建立文字樣式物件，見 CTextStyle。
參數
- params: BatchPointParameter[]
  參數。
- callback: (featureId: number[] | ol.Feature[]) => void
  回呼函式。
- doNotAddToSource: boolean = false
  true 則不自動將圖素加入圖層，之後手動加入，預設為false。
- returnType: string = ""
  回呼函式傳入型態，"SELF"則傳入 Feature 物件,預設傳入 Feature ID。
回傳 void
範例
```
let callback = (featureId) => console.log(featureId);

// 批量新增圓點
this.VectorLayer.NewBatchPoint([
	{
		Point: new GeoPoint(163887.80, 2600000),
		FillColor: "rgba(0, 0, 1, 0)",
		Radius: 1000,
		RadiusUnit: UNIT.MAP,
		TextStyle: textStyle
	},
	//...
], callback);

// 批量新增符號
this.VectorLayer.NewBatchPoint([
	{
		Point: new GeoPoint(165000, 2650000),
		SymbolUrl: "http://127.0.0.1:8080/台灣全圖_84TM2.jpg",
		SymbolSize: new CSize(48, 48),
		TextStyle: textStyle
	},
	//...
], callback);
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:394

NewPolyline

NewPolyline(
    polyline: PolylineEntityParameter | GeoPolyline,
    color?: string,
    width?: number,
    textStyle?: CTextStyle,
    ...args: unknown[],
): string | number | ol.Feature
新增聚合線圖素。
參數
- polyline: PolylineEntityParameter | GeoPolyline
  線條。
- 可選color: string
  線條顏色。
- 可選width: number
  線條寬度。
- 可選textStyle: CTextStyle
  標籤樣式，沒指定就不顯示標籤。
- ...args: unknown[]
回傳 string | number | ol.Feature
傳回圖素 ID。
已被棄用
棄用，建議使用 NewPolylineByParam。
範例
```
const id = vectorLayer.NewPolyline(new GeoPolyline(buffer), "#FFFFFF", 5 );
const id = vectorLayer.NewPolyline(new GeoPolyline(buffer), "#FFFFFF", 5, text);
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:536

NewPolylineByParam

NewPolylineByParam(param: PolylineEntityParameter): string | number | ol.Feature
新增聚合線圖素。

如果有需要文字標籤，先建立文字樣式物件，見 CTextStyle。
參數
- param: PolylineEntityParameter
  圖素設定參數。
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
範例
```
// 新增線圖素
vectorLayer.NewPolylineByParam({
	Polyline: new GeoPolyline(buffer),
	StrokeColor: "black",
	StrokeWidth: 5,
	TextStyle: textStyle,
	ShowArrow: true,
	LineDash: [4, 8]
});
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:616

NewPolygon

NewPolygon(
    polygon: PolygonEntityParameter | GeoPolygon,
    strokeColor: string,
    strokeWidth: number,
    fillColor: string,
    textStyle?: CTextStyle,
    ...args: unknown[],
): string | number | ol.Feature
新增面圖素。
參數
- polygon: PolygonEntityParameter | GeoPolygon
  圖素設定參數。
- strokeColor: string
  外框顏色。
- strokeWidth: number
  外框寬度。
- fillColor: string
  塗滿顏色。
- 可選textStyle: CTextStyle
  標籤樣式，沒指定就不顯示標籤。
- ...args: unknown[]
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
已被棄用
棄用，建議使用 NewPolygonByParam。
範例
```
const id = vectorLayer.NewPolygon(new GeoPolygon(buffer), "#FFFFFF", 5, "rgb(255, 0, 0)" );
// 使用預設的文字樣式
const id = vectorLayer.NewPolygon(new GeoPolygon(buffer), "#FFFFFF", 5, "rgb(255, 0, 0)", new CTextStyle());
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:713

NewPolygonByParam

NewPolygonByParam(param: PolygonEntityParameter): string | number | ol.Feature
新增面圖素。

如果有需要文字標籤，先建立文字樣式物件，見 CTextStyle。
參數
- param: PolygonEntityParameter
  圖素設定參數。
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
範例
```
// 新增面圖素
this.VectorLayer.NewPolygonByParam({
	Polygon: new GeoPolygon(buffer) ,
	StrokeColor: "#FFFFFF",
	StrokeWidth: 5,
	FillColor: "rgba(255, 0, 0, 0.5)",
	TextStyle: textStyle,
	LineDash: [4, 8]
});
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:793

NewPolygonSet

NewPolygonSet(
    polygonSet: PolygonSetEntityParameter | GeoPolygonSet,
    strokeColor: string,
    strokeWidth: number,
    fillColor: string,
    textStyle?: CTextStyle,
    nullInside?: boolean,
    ...args: unknown[],
): string | number | ol.Feature
新增多面圖素。
參數
- polygonSet: PolygonSetEntityParameter | GeoPolygonSet
  多面圖素。
- strokeColor: string
  外框顏色。
- strokeWidth: number
  外框寬度。
- fillColor: string
  塗滿顏色。
- 可選textStyle: CTextStyle
  標籤樣式，沒指定就不顯示標籤。
- nullInside: boolean = true
  是否要空心，預設為 true。
- ...args: unknown[]
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
已被棄用
棄用，建議使用 NewPolygonSetByParam。
範例
```
const polygonSet = new GeoPolygonSet(buffer);
const strokeColor = "#ffffff";
const strokeWidth = 5;
const fillColor = "rgb(255, 0, 0)";
let id = vectorLayer.NewPolygonSet(polygonSet, strokeColor, strokeWidth, fillColor);
// 不顯示標籤
let id = vectorLayer.NewPolygonSet(polygonSet, strokeColor, strokeWidth, fillColor, "" , true);
// 顯示標籤
let id = vectorLayer.NewPolygonSet(polygonSet, strokeColor, strokeWidth, fillColor, text, true);
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:863

NewPolygonSetByParam

NewPolygonSetByParam(
param: PolygonSetEntityParameter,
): string | number | ol.Feature
新增多面圖素。

如果有需要文字標籤，先建立文字樣式物件，見 CTextStyle。
參數
- param: PolygonSetEntityParameter
  圖素設定參數。
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
範例
```
// 新增線圖素
this.VectorLayer.NewPolygonSetByParam({
	PolygonSet: polygonSet,
	StrokeColor: "#ff00ff",
	StrokeWidth: 5,
	FillColor: "rgb(255, 0, 0)",
	TextStyle: textStyle, // 見 CTextStyle
	NullInside: true,
	LineDash: [4, 8]
});
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:978

NewText

NewText(
    point: GeoPoint | TextEntityParameter,
    textStyle: CTextStyle,
    showPoint?: boolean,
    pointColor?: string,
    pointRadius?: number,
    pointUnit?: UNIT,
    ...args: unknown[],
): string | number | ol.Feature
新增文字圖素。
參數
- point: GeoPoint | TextEntityParameter
  文字坐標 (世界)。
- textStyle: CTextStyle
  標籤樣式。
- showPoint: boolean = false
  是否要顯示圓點，預設false。
- 可選pointColor: string
  圓點顏色，預設為紅色。
- 可選pointRadius: number
  圓點半徑，預設為1。
- 可選pointUnit: UNIT
  半徑單位類型，預設為UNIT.PIXEL。
- ...args: unknown[]
回傳 string | number | ol.Feature
傳回圖素 ID (預設) 或圖素本身。
已被棄用
棄用，建議使用 NewTextByParam。
範例
```
const id = CVectorLayer.NewText(new GeoPoint(5,5), text);
const id = CVectorLayer.NewText(new GeoPoint(5,5), text, false); // 不顯示圓點
const id = CVectorLayer.NewText(new GeoPoint(5,5), text, true, "#FF0000", 20, UNIT.PIXEL); // 顯示圓點
```
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1072

NewTextByParam

NewTextByParam(param: TextEntityParameter): string | number | ol.Feature

新增文字圖素。

參數

param: TextEntityParameter
圖素設定參數。

回傳 string | number | ol.Feature

傳回圖素 ID。

範例

// 先建立文字樣式物件
let textStyle = new CTextStyle();
textStyle.Text = "New Text";
textStyle.ContentStyle = "Shorten";
textStyle.Weight = "bold";
textStyle.FillColor = "yellow"
textStyle.Baseline = "middle";
textStyle.StrokeColor = "rgba(0, 0, 0, 0.5)";
textStyle.StrokeWidth = 3;
textStyle.Rotation = 1.57;
textStyle.Size = 12;

// 新增文字圖素
this.VectorLayer.NewTextByParam({
	Point: new GeoPoint(175000, 2542575.6165581764),
	TextStyle: textStyle,
	ShowPoint: true,
	PointFillColor: "#00ff00",
	PointRadius: 100,
	PointRadiusUnit: UNIT.PIXEL,
	Tooltip: "<h1>Tooltip</h1><p>Lorem Ipsum</p>"
});

NewBatchFeatures

NewBatchFeatures(features: ol.Feature[]): void
批次加入圖素。
參數
- features: ol.Feature[]
  圖素陣列。
回傳 void
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1272

UpdateEntity

UpdateEntity(
    id: number,
    param:
        | PolylineEntityParameter
        | PolygonEntityParameter
        | PolygonSetEntityParameter
        | TextEntityParameter
        | PointEntityParameter,
): boolean
更新與指定圖素相關的參數。

點圖素間的轉換，需要給完整資訊，可以參考 PointColorEntityParameter 和 PointSymbolEntityParameter

符號轉圓形需要指定SymbolUrl為空字串

不要顯示文字的話Text給空字串或TextStyle.Text給空字串，如果有指定TextStyle，以TextStyle為主
參數
- id: number
  指定圖素id
- param:
      | PolylineEntityParameter
      | PolygonEntityParameter
      | PolygonSetEntityParameter
      | TextEntityParameter
      | PointEntityParameter
  需要變更的參數。
  
  Point: PointEntityBaseParameter。
  
  Polyline: PolylineEntityParameter。
  
  Polygon: PolygonEntityParameter。
  
  PolygonSet: PolygonSetEntityParameter。
  
  Text: TextEntityParameter。
回傳 boolean
回傳更新是否成功
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1310

SetEntityShow

SetEntityShow(id: number, show: boolean): boolean
設定是否顯示圖素
參數
- id: number
  指定圖素id
- show: boolean
  是否顯示
回傳 boolean
回傳更新是否成功
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1320

SetTooltip

SetTooltip(id: number, tooltip: string): void
設定 Tooltip
參數
- id: number
- tooltip: string
回傳 void
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1339

Remove

Remove(id: number): boolean
移除圖層上指定圖素。
參數
- id: number
  指定圖素 id。
回傳 boolean
是否成功移除，找不到指定圖素時回傳 false
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1349

RemoveAll

RemoveAll(): void
移除圖層上所有圖素。

回傳 void
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1356

GetEntityParam

GetEntityParam(
    id: number,
):
    | undefined
    | (PointEntityParameter & { Type: ENTITY_TYPE.POINT; })
    | PolylineEntityParameter & { Type: POLYLINE }
    | PolygonEntityParameter & { Type: POLYGON }
    | PolygonSetEntityParameter & { Type: POLYGONSET }
    | TextEntityParameter & { Type: TEXT }
取得指定圖素的參數。
參數
- id: number
  指定圖素id。
回傳
    | undefined
    | (PointEntityParameter & { Type: ENTITY_TYPE.POINT; })
    | PolylineEntityParameter & { Type: POLYLINE }
    | PolygonEntityParameter & { Type: POLYGON }
    | PolygonSetEntityParameter & { Type: POLYGONSET }
    | TextEntityParameter & { Type: TEXT }
傳回圖素設定的參數。
- Point: PointEntityBaseParameter。
- Polyline: PolylineEntityParameter。
- Polygon: PolygonEntityParameter。
- PolygonSet: PolygonSetEntityParameter。
- Text: TextEntityParameter。
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1370

GetEntityType

GetEntityType(id: number): ENTITY_TYPE
取得指定圖素的類型
參數
- id: number
  指定圖素Id
回傳 ENTITY_TYPE
圖素類型，若id沒有找到指定的圖素則回傳為ENTITY_TYPE.NONE(=0)
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1379

GetEntityGeo

GetEntityGeo(
id: number,
): null | GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet
取得指定圖素的幾何
參數
- id: number
  指定圖素Id
回傳 null | GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet
圖素幾何，若id沒有找到指定的圖素則回傳為null
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1393

GetAllEntity

GetAllEntity(): number[]
取得圖層上所有圖素的Id。

回傳 number[]
圖素Id陣列。
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1405

SelectEntityByDistance

SelectEntityByDistance(
geo: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoBoundary,
distance: number,
): ol.Feature[]
在圖層上搜尋範圍內的圖素Id
參數
- geo: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoBoundary
  輸入幾何(世界坐標)
- distance: number
  搜索半徑(單位:公尺)
回傳 ol.Feature[]
圖素Id陣列
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1416

SelectEntityAtPoint

SelectEntityAtPoint(point: GeoPoint | Position): number[]
在圖層上搜尋固定範圍(螢幕上5px)內的圖素Id
參數
- point: GeoPoint | Position
  輸入點(世界坐標)
回傳 number[]
圖素Id陣列
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1431

SelectEntityByInclude

SelectEntityByInclude(
geo: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoBoundary,
): number[]
在圖層上搜尋指定幾何範圍內的圖素Id
參數
- geo: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoBoundary
  輸入幾何(世界坐標)
回傳 number[]
圖素Id陣列
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1457

SetClusterDistance

SetClusterDistance(distance: number): void
設定叢集合併的最大距離
參數
- distance: number
  叢集合併最大距離
回傳 void
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1470

ToAllEntityArrayJson

ToAllEntityArrayJson(): string
把所有圖素轉成Json陣列字串

回傳 string
Json字串
- 定義於 src/openlayers/layer/VectorLayer2D.ts:1480

訪問器屬性

type

get type(): LAYER_TYPE_2D
圖層類別

回傳 LAYER_TYPE_2D
覆寫了 Layer2D.type
- 定義於 src/openlayers/layer/VectorLayer2D.ts:79

Boundary

get Boundary(): GeoBoundary
圖層範圍

回傳 GeoBoundary
覆寫了 Layer2D.Boundary
- 定義於 src/openlayers/layer/VectorLayer2D.ts:84

Show

get Show(): boolean
是否顯示圖層

回傳 boolean
繼承自 Layer2D.Show
- 定義於 src/openlayers/layer/Layer2D.ts:49
set Show(value: boolean): void
是否顯示圖層
參數
- value: boolean
回傳 void
繼承自 Layer2D.Show
- 定義於 src/openlayers/layer/Layer2D.ts:51

Alpha

get Alpha(): number
圖層透明度

回傳 number
繼承自 Layer2D.Alpha
- 定義於 src/openlayers/layer/Layer2D.ts:54
set Alpha(value: number): void
圖層透明度
參數
- value: number
回傳 void
繼承自 Layer2D.Alpha
- 定義於 src/openlayers/layer/Layer2D.ts:56

Name

get Name(): string
圖層名稱

回傳 string
繼承自 Layer2D.Name
- 定義於 src/openlayers/layer/Layer2D.ts:59

MaxResolution

get MaxResolution(): number
圖層的最大解析度

回傳 number
繼承自 Layer2D.MaxResolution
- 定義於 src/openlayers/layer/Layer2D.ts:65

MinResolution

get MinResolution(): number
圖層的最小解析度

回傳 number
繼承自 Layer2D.MinResolution
- 定義於 src/openlayers/layer/Layer2D.ts:67

ZIndex

get ZIndex(): number
圖層Z-Index (圖層的繪製順序)

回傳 number
繼承自 Layer2D.ZIndex
- 定義於 src/openlayers/layer/Layer2D.ts:70
set ZIndex(zIndex: number): void
圖層Z-Index (圖層的繪製順序)
參數
- zIndex: number
回傳 void
繼承自 Layer2D.ZIndex
- 定義於 src/openlayers/layer/Layer2D.ts:72

類別 CVectorLayer

範例

層級 (查看層級一覽)

索引

方法

訪問器屬性

方法

NewPoint_Color

參數

回傳 string | number

已被棄用

範例

NewPoint_Symbol

參數

回傳 string | number

已被棄用

範例

NewPoint

參數

回傳 string | number | ol.Feature

範例

NewBatchPoint

參數

回傳 void

範例

NewPolyline

參數

回傳 string | number | ol.Feature

已被棄用

範例

NewPolylineByParam

參數

回傳 string | number | ol.Feature

範例

NewPolygon

參數

回傳 string | number | ol.Feature

已被棄用

範例

NewPolygonByParam

參數

回傳 string | number | ol.Feature

範例

NewPolygonSet

參數

回傳 string | number | ol.Feature

已被棄用

範例

NewPolygonSetByParam

參數

回傳 string | number | ol.Feature

範例

NewText

參數

回傳 string | number | ol.Feature

已被棄用

範例

NewTextByParam

參數

回傳 string | number | ol.Feature

範例

NewBatchFeatures

參數

回傳 void

UpdateEntity

參數

回傳 boolean

SetEntityShow

參數

回傳 boolean

SetTooltip

參數

回傳 void

Remove

參數

回傳 boolean

RemoveAll

回傳 void

GetEntityParam

參數

回傳
| undefined
| (PointEntityParameter & { Type: ENTITY_TYPE.POINT; })
| PolylineEntityParameter & { Type: POLYLINE }
| PolygonEntityParameter & { Type: POLYGON }
| PolygonSetEntityParameter & { Type: POLYGONSET }
| TextEntityParameter & { Type: TEXT }