Class Waymark

绘制 场景标记

Hierarchy

Layer<IWaymarkEvent>
- Waymark

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Waymark(state?: Partial<ILayerState>, props?: Partial<IWaymarkProps>): Waymark

Overrides Layer.constructor
- Defined in Waymark.ts:56
Parameters
- Default value state: Partial<ILayerState> = {}
- Default value props: Partial<IWaymarkProps> = {}
Returns Waymark

Properties

children

children: Layer<any>[]

parent

parent: Layer<any> | null

props

props: IWaymarkProps

state

state: ILayerState

Methods

add

add(layer: Layer<any>): this

Inherited from Layer.add
- Defined in Layer.ts:236
添加子图层

Parameters
- layer: Layer<any>
Returns this

addTo

addTo(layer: Layer<any>): this

Inherited from Layer.addTo
- Defined in Layer.ts:247
添加到父图层

Parameters
- layer: Layer<any>
Returns this

clone

clone(): Layer<any>

Inherited from Layer.clone
- Defined in Layer.ts:277
克隆

Returns Layer<any>

emit

emit<T, K>(type: K, args: Parameters<T[K]>): this

Inherited from Layer.emit
- Defined in Layer.ts:510
发起事件

Type parameters
- T: {}
- K: IKey<T>
Parameters
- type: K
- args: Parameters<T[K]>
Returns this

fill

fill(value: ILayerState["fill"]): this

Inherited from Layer.fill
- Defined in Layer.ts:462
设置填充颜色

Parameters
- value: ILayerState["fill"]
Returns this

getLayerStatus

getLayerStatus(): { opacity: number; rotate: number; scaleX: number; scaleY: number; x: number; y: number }

Inherited from Layer.getLayerStatus
- Defined in Layer.ts:345
获得当前图层在画布中的状态

x, y返回的是相对坐标

Returns { opacity: number; rotate: number; scaleX: number; scaleY: number; x: number; y: number }
- opacity: number
- rotate: number
- scaleX: number
- scaleY: number
- x: number
- y: number

hide

hide(): this

Inherited from Layer.hide
- Defined in Layer.ts:478
设置为不可见

Returns this

off

off<T, K>(type: K, event: T[K]): this

Inherited from Layer.off
- Defined in Layer.ts:502
取消事件监听

Type parameters
- T: {}
- K: IKey<T>
Parameters
- type: K
- event: T[K]
Returns this

on

on<T, K>(type: K, event: T[K]): this

Inherited from Layer.on
- Defined in Layer.ts:486
绑定事件监听

Type parameters
- T: {}
- K: IKey<T>
Parameters
- type: K
- event: T[K]
Returns this

once

once<T, K>(type: K, event: T[K]): this

Inherited from Layer.once
- Defined in Layer.ts:494
绑定一次性事件监听

Type parameters
- T: {}
- K: IKey<T>
Parameters
- type: K
- event: T[K]
Returns this

opacity

opacity(value: ILayerState["opacity"]): this

Inherited from Layer.opacity
- Defined in Layer.ts:421
设置透明度

Parameters
- value: ILayerState["opacity"]
Returns this

remove

remove(layer: Layer<any>): this

Inherited from Layer.remove
- Defined in Layer.ts:258
移除子图层

Parameters
- layer: Layer<any>
Returns this

removeAll

removeAll(): this

Inherited from Layer.removeAll
- Defined in Layer.ts:269
移除全部子图层

Returns this

render

render(ctx: CanvasRenderingContext2D, utils: ISketchUtils): void

Inherited from Layer.render
- Defined in Layer.ts:289
渲染

Parameters
- ctx: CanvasRenderingContext2D
- utils: ISketchUtils
Returns void

rotate

rotate(value: ILayerState["rotate"]): this

Inherited from Layer.rotate
- Defined in Layer.ts:429
设置旋转角度

Parameters
- value: ILayerState["rotate"]
Returns this

scale

scale(x: ILayerState["scaleX"], y?: ILayerState["scaleY"]): this

Inherited from Layer.scale
- Defined in Layer.ts:437
设置缩放

Parameters
- x: ILayerState["scaleX"]
- Optional y: ILayerState["scaleY"]
Returns this

show

show(): this

Inherited from Layer.show
- Defined in Layer.ts:470
设置为可见

Returns this

size

size(value: number): this

- Defined in Waymark.ts:87
设置尺寸

Parameters
- value: number
Returns this

stroke

stroke(value: ILayerState["stroke"]): this

Inherited from Layer.stroke
- Defined in Layer.ts:446
设置描边颜色

Parameters
- value: ILayerState["stroke"]
Returns this

strokeWidth

strokeWidth(value: ILayerState["strokeWidth"]): this

Inherited from Layer.strokeWidth
- Defined in Layer.ts:454
设置描边宽度

Parameters
- value: ILayerState["strokeWidth"]
Returns this

turnTo

turnTo(layer: Layer, offset?: number): this

Inherited from Layer.turnTo
- Defined in Layer.ts:393
将原始北面转向目标图层

Parameters
- layer: Layer
  
  目标图层
- Default value offset: number = 0
  
  偏移角度
Returns this

type

type(value: IWaymarkProps["type"]): this

- Defined in Waymark.ts:79
设置目标标记类型（名称）

Parameters
- value: IWaymarkProps["type"]
Returns this

xy

xy(x: ILayerState["x"], y: ILayerState["y"]): this

Inherited from Layer.xy
- Defined in Layer.ts:412
设置坐标

Parameters
- x: ILayerState["x"]
- y: ILayerState["y"]
Returns this

Static setAlias

setAlias(name: IWaymarkAlias, alias: string): void

- Defined in Waymark.ts:102
为场地标记设别名

通过 Waymark.setAlias('A', 'A点') 设置别名

之后则可以使用 new Waymark('A点') 获得与A同样的图标

Parameters
- name: IWaymarkAlias
  
  官方名称 / 已设置成功的别名
- alias: string
  
  别名
Returns void