Class Board

Constructors

constructor

new Board(factory: IFactory, options: BoardOptions): Board
Parameters
- factory: IFactory
- options: BoardOptions
Returns Board
- Defined in writeboard/board/Board.ts:182

Properties

`Protected`_editingLayerId

_editingLayerId: string = ''

`Protected`_element

_element: HTMLElement

`Protected`_factory

_factory: IFactory

`Protected`_layers

_layers: Map<string, Layer> = ...

`Protected`_mousebuttons

_mousebuttons: { [key: number]: undefined | number } = {}

`Protected`_own_element

_own_element: boolean = false

`Protected`_selects

_selects: Shape<ShapeData>[] = []

`Protected`_shapesMgr

_shapesMgr: IShapesMgr

`Protected`_tool

_tool: undefined | ITool

`Protected`_tools

_tools: Map<string, ITool> = ...

`Protected`_toolType

_toolType: undefined | string = ...

`Protected`_viewport

_viewport: Rect = ...

`Protected`_whoami

_whoami: string = 'local'

`Protected`_world

_world: Rect = ...

`Protected`_world_drag_start_pos

_world_drag_start_pos: IVector = ...

Accessors

element

get element(): HTMLElement
Returns HTMLElement
- Defined in writeboard/board/Board.ts:181

factory

get factory(): IFactory
Returns IFactory
- Defined in writeboard/board/Board.ts:285
set factory(v: IFactory): void
Parameters
- v: IFactory
Returns void
- Defined in writeboard/board/Board.ts:286

height

get height(): number
Returns number
- Defined in writeboard/board/Board.ts:64
set height(v: number): void
Parameters
- v: number
Returns void
- Defined in writeboard/board/Board.ts:68

layers

get layers(): Layer[]
Returns Layer[]
- Defined in writeboard/board/Board.ts:180

lb_down

get lb_down(): boolean
Returns boolean
- Defined in writeboard/board/Board.ts:38

mb_down

get mb_down(): boolean
Returns boolean
- Defined in writeboard/board/Board.ts:41

selects

get selects(): Shape<ShapeData>[]
Returns Shape<ShapeData>[]
- Defined in writeboard/board/Board.ts:347

tool

get tool(): undefined | ITool
Returns undefined | ITool
- Defined in writeboard/board/Board.ts:485

tools

get tools(): Map<string, ITool>
Returns Map<string, ITool>
- Defined in writeboard/board/Board.ts:484

toolType

get toolType(): undefined | string
Returns undefined | string
- Defined in writeboard/board/Board.ts:312
set toolType(v: undefined | string): void
Parameters
- v: undefined | string
Returns void
- Defined in writeboard/board/Board.ts:313

viewport

get viewport(): Readonly<Rect>
Returns Readonly<Rect>
- Defined in writeboard/board/Board.ts:44

whoami

get whoami(): string
Returns string
- Defined in writeboard/board/Board.ts:50

width

get width(): number
Returns number
- Defined in writeboard/board/Board.ts:54
set width(v: number): void
Parameters
- v: number
Returns void
- Defined in writeboard/board/Board.ts:58

world

get world(): Readonly<Rect>
Returns Readonly<Rect>
- Defined in writeboard/board/Board.ts:47

Methods

`Protected`_pointerdown

_pointerdown(e: PointerEvent): void
Parameters
- e: PointerEvent
Returns void
- Defined in writeboard/board/Board.ts:520

`Protected`_pointermove

_pointermove(e: PointerEvent): void
Parameters
- e: PointerEvent
Returns void
- Defined in writeboard/board/Board.ts:541

`Protected`_pointerup

_pointerup(e: PointerEvent): void
Parameters
- e: PointerEvent
Returns void
- Defined in writeboard/board/Board.ts:556

`Protected`_wheel

_wheel(e: WheelEvent): void
Protected
鼠标滚动事件
Parameters
- e: WheelEvent
Returns void
Memberof
Board
- Defined in writeboard/board/Board.ts:494

add

add(shapes: Shape<ShapeData> | Shape<ShapeData>[]): number
Parameters
- shapes: Shape<ShapeData> | Shape<ShapeData>[]
Returns number
- Defined in writeboard/board/Board.ts:350
add(shapes: Shape<ShapeData> | Shape<ShapeData>[], emit: boolean): number
Parameters
- shapes: Shape<ShapeData> | Shape<ShapeData>[]
- emit: boolean
Returns number
- Defined in writeboard/board/Board.ts:351
add(
shapes: Shape<ShapeData> | Shape<ShapeData>[],
opts: { emit?: boolean; operator: string },
): number
Parameters
- shapes: Shape<ShapeData> | Shape<ShapeData>[]
- opts: { emit?: boolean; operator: string }
Returns number
- Defined in writeboard/board/Board.ts:352

addEventListener

addEventListener<K extends keyof EventMap>(
    type: K,
    listener: (this: HTMLDivElement, ev: EventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Type Parameters
- K extends keyof EventMap
Parameters
- type: K
- listener: (this: HTMLDivElement, ev: EventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
- Defined in writeboard/board/Board.ts:265
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
- Defined in writeboard/board/Board.ts:266

addLayer

addLayer(layer?: ILayerInits | Layer): boolean
Parameters
- Optionallayer: ILayerInits | Layer
Returns boolean
- Defined in writeboard/board/Board.ts:111

addLayers

addLayers(layers: ILayerInits[]): void
Parameters
- layers: ILayerInits[]
Returns void
- Defined in writeboard/board/Board.ts:175

ctx

ctx(): CanvasRenderingContext2D
Returns CanvasRenderingContext2D
- Defined in writeboard/board/Board.ts:288
ctx(layerId: string): undefined | null | CanvasRenderingContext2D
Parameters
- layerId: string
Returns undefined | null | CanvasRenderingContext2D
- Defined in writeboard/board/Board.ts:289

deselect

deselect(emit?: boolean | { operator: string }): Shape<ShapeData>[]
取消选择
Parameters
- Optionalemit: boolean | { operator: string }
  是否发射事件
Returns Shape<ShapeData>[]
？？？

Memberof
Board
- Defined in writeboard/board/Board.ts:425

destory

destory(): void
Returns void
- Defined in writeboard/board/Board.ts:637

dispatchEvent

dispatchEvent(e: CustomEvent<any>): boolean
Parameters
- e: CustomEvent<any>
Returns boolean
- Defined in writeboard/board/Board.ts:278

editLayer

editLayer(layerId: string): boolean
Parameters
- layerId: string
Returns boolean
- Defined in writeboard/board/Board.ts:157

emitEvent

emitEvent<K extends keyof EventDetailMap>(
k: K,
detail: EventDetailMap[K],
): boolean
Type Parameters
- K extends keyof EventDetailMap
Parameters
- k: K
- detail: EventDetailMap[K]
Returns boolean
- Defined in writeboard/board/Board.ts:281

exists

exists(...items: Shape<ShapeData>[]): number
Parameters
- ...items: Shape<ShapeData>[]
Returns number
- Defined in writeboard/board/Board.ts:255

find

find(id: string): null | Shape<ShapeData>
Parameters
- id: string
Returns null | Shape<ShapeData>
- Defined in writeboard/board/Board.ts:223

fromJson

fromJson(json: string): void
Parameters
- json: string
Returns void
- Defined in writeboard/board/Board.ts:249

fromSnapshot

fromSnapshot(snapshot: ISnapshot): void
Parameters
- snapshot: ISnapshot
Returns void
- Defined in writeboard/board/Board.ts:239

getDot

getDot(ev: MouseEvent | PointerEvent): IDot
Parameters
- ev: MouseEvent | PointerEvent
Returns IDot
- Defined in writeboard/board/Board.ts:471

hit

hit(rect: IRect): null | Shape<ShapeData>
Parameters
- rect: IRect
Returns null | Shape<ShapeData>
- Defined in writeboard/board/Board.ts:258

hits

hits(rect: IRect): Shape<ShapeData>[]
Parameters
- rect: IRect
Returns Shape<ShapeData>[]
- Defined in writeboard/board/Board.ts:261

layer

layer(): Layer
Returns Layer
- Defined in writeboard/board/Board.ts:169
layer(id: string): undefined | Layer
Parameters
- id: string
Returns undefined | Layer
- Defined in writeboard/board/Board.ts:170

markDirty

markDirty(rect: IRect): void
标记脏矩形区域，将触发重绘

若在重绘前，连续调用，将会将多个矩形合并一个大的矩形，并仅会触发一次重绘
Parameters
- rect: IRect
Returns void
Memberof
Board
- Defined in writeboard/board/Board.ts:574

markViewDirty

markViewDirty(): this
Returns this
- Defined in writeboard/board/Board.ts:136

octx

octx(): CanvasRenderingContext2D
Returns CanvasRenderingContext2D
- Defined in writeboard/board/Board.ts:294
octx(layerId: string): undefined | null | CanvasRenderingContext2D
Parameters
- layerId: string
Returns undefined | null | CanvasRenderingContext2D
- Defined in writeboard/board/Board.ts:295

offscreen

offscreen(): HTMLCanvasElement
Returns HTMLCanvasElement
- Defined in writeboard/board/Board.ts:306
offscreen(layerId: string): undefined | HTMLCanvasElement
Parameters
- layerId: string
Returns undefined | HTMLCanvasElement
- Defined in writeboard/board/Board.ts:307

onscreen

onscreen(): HTMLCanvasElement
Returns HTMLCanvasElement
- Defined in writeboard/board/Board.ts:300
onscreen(layerId: string): undefined | HTMLCanvasElement
Parameters
- layerId: string
Returns undefined | HTMLCanvasElement
- Defined in writeboard/board/Board.ts:301

remove

remove(
shapes: Shape<ShapeData> | Shape<ShapeData>[],
opts?: boolean | { operator: string },
): number
Parameters
- shapes: Shape<ShapeData> | Shape<ShapeData>[]
- Optionalopts: boolean | { operator: string }
Returns number
- Defined in writeboard/board/Board.ts:371

removeAll

removeAll(emit?: boolean | { operator: string }): number
Parameters
- Optionalemit: boolean | { operator: string }
Returns number
- Defined in writeboard/board/Board.ts:398

removeEventListener

removeEventListener<K extends keyof EventMap>(
    type: K,
    listener: (this: HTMLDivElement, ev: EventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Type Parameters
- K extends keyof EventMap
Parameters
- type: K
- listener: (this: HTMLDivElement, ev: EventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
- Defined in writeboard/board/Board.ts:272
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
- Defined in writeboard/board/Board.ts:273

removeLayer

removeLayer(layerId: string): boolean
Parameters
- layerId: string
Returns boolean
- Defined in writeboard/board/Board.ts:146

removeSelected

removeSelected(emit?: boolean | { operator: string }): void
Parameters
- Optionalemit: boolean | { operator: string }
Returns void
- Defined in writeboard/board/Board.ts:402

render

render(): void
绘制

Returns void
Memberof
Board
- Defined in writeboard/board/Board.ts:585

scroll_by

scroll_by(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in writeboard/board/Board.ts:104

scroll_to

scroll_to(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in writeboard/board/Board.ts:74

selectAll

selectAll(emit?: boolean | { operator: string }): Shape<ShapeData>[]
全选图形
Parameters
- Optionalemit: boolean | { operator: string }
  是否发射事件
Returns Shape<ShapeData>[]
新选中的图形

Memberof
Board
- Defined in writeboard/board/Board.ts:414

selectAt

selectAt(
rect: IRect,
opts?: boolean | { operator: string },
): [Shape<ShapeData>[], Shape<ShapeData>[]]
选中指定区域内的图形，指定区域以外的会被取消选择
Parameters
- rect: IRect
- Optionalopts: boolean | { operator: string }
Returns [Shape<ShapeData>[], Shape<ShapeData>[]]
[新选中的图形的数组, 取消选择的图形的数组]

Memberof
Board
- Defined in writeboard/board/Board.ts:437

set_viewport

set_viewport(to: IRect): void
Parameters
- to: IRect
Returns void
- Defined in writeboard/board/Board.ts:90

set_world_rect

set_world_rect(to: IRect): void
Parameters
- to: IRect
Returns void
- Defined in writeboard/board/Board.ts:82

setSelects

setSelects(
shapes: Shape<ShapeData>[],
opts?: boolean | { operator: string },
): [Shape<ShapeData>[], Shape<ShapeData>[]]
设置被选中的图形，原来被选中的图形数组将被取消选中
Parameters
- shapes: Shape<ShapeData>[]
  被选中的图形
- Optionalopts: boolean | { operator: string }
Returns [Shape<ShapeData>[], Shape<ShapeData>[]]
[被选中的图形数组，取消选中的图形数组]

Memberof
Board
- Defined in writeboard/board/Board.ts:450

setToolType

setToolType(to: undefined | string): void
Parameters
- to: undefined | string
Returns void
- Defined in writeboard/board/Board.ts:314

shapes

shapes(): Shape<ShapeData>[]
Returns Shape<ShapeData>[]
- Defined in writeboard/board/Board.ts:252

toJson

toJson(
replacer?: (this: any, key: string, value: any) => any,
space?: string | number,
): string
Parameters
- Optionalreplacer: (this: any, key: string, value: any) => any
- Optionalspace: string | number
Returns string
- Defined in writeboard/board/Board.ts:246

toSnapshot

toSnapshot(): ISnapshot
Returns ISnapshot
- Defined in writeboard/board/Board.ts:227

`Protected`world_rect_changing

world_rect_changing(func: () => any): this
Protected
执行指定函数，并检查世界矩形变化，当变化触发emitEvent
Parameters
- func: () => any
  执行函数
Returns this
Memberof
Board
- Defined in writeboard/board/Board.ts:510

Class Board

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Board

Properties

Protected_editingLayerId

Protected_element

Protected_factory

Protected_layers

Protected_mousebuttons

Protected_own_element

Protected_selects

Protected_shapesMgr

Protected_tool

Protected_tools

Protected_toolType

Protected_viewport

Protected_whoami

Protected_world

Protected_world_drag_start_pos

Accessors

element

Returns HTMLElement

factory

Returns IFactory

Parameters

Returns void

height

Returns number

Parameters

Returns void

layers

Returns Layer[]

lb_down

Returns boolean

mb_down

Returns boolean

selects

Returns Shape<ShapeData>[]

tool

Returns undefined | ITool

tools

Returns Map<string, ITool>

toolType

Returns undefined | string

Parameters

Returns void

viewport

Returns Readonly<Rect>

whoami

Returns string

width

Returns number

Parameters

Returns void

world

Returns Readonly<Rect>

Methods

Protected_pointerdown

Parameters

Returns void

Protected_pointermove

Parameters

Returns void

Protected_pointerup

Parameters

Returns void

Protected_wheel

Parameters

Returns void

Memberof

add

Parameters

Returns number

`Protected`_editingLayerId

`Protected`_element

`Protected`_factory

`Protected`_layers

`Protected`_mousebuttons

`Protected`_own_element

`Protected`_selects

`Protected`_shapesMgr

`Protected`_tool

`Protected`_tools

`Protected`_toolType

`Protected`_viewport

`Protected`_whoami

`Protected`_world

`Protected`_world_drag_start_pos

`Protected`_pointerdown

`Protected`_pointermove

`Protected`_pointerup

`Protected`_wheel