Class ShapePen

一切图形的基类

Export

Shape 图形基类

Hierarchy (View Summary)

Shape<PenData>
- ShapePen

Constructors

constructor

new ShapePen(data: Partial<PenData>): ShapePen
Parameters
- data: Partial<PenData>
Returns ShapePen
Overrides Shape.constructor
- Defined in writeboard/shape/pen/Shape.ts:16

Properties

`Protected` `Optional`_b

_b?: Board

`Protected`_d

_d: PenData

`Protected`_r

_r: Resizable = Resizable.None

Accessors

board

get board(): undefined | Board
图形属于哪个黑板

Returns undefined | Board
Memberof
Shape
Inherited from Shape.board
- Defined in writeboard/shape/base/Shape.ts:55
set board(v: undefined | Board): void
Parameters
- v: undefined | Board
Returns void
Inherited from Shape.board
- Defined in writeboard/shape/base/Shape.ts:56

bottom

get bottom(): number
Returns number
Inherited from Shape.bottom
- Defined in writeboard/shape/base/Shape.ts:224

bottomLeft

get bottomLeft(): IVector
Returns IVector
Inherited from Shape.bottomLeft
- Defined in writeboard/shape/base/Shape.ts:227

bottomRight

get bottomRight(): IVector
Returns IVector
Inherited from Shape.bottomRight
- Defined in writeboard/shape/base/Shape.ts:229

data

get data(): D
图形的数据

Returns D
Memberof
Shape
Inherited from Shape.data
- Defined in writeboard/shape/base/Shape.ts:35

editing

get editing(): boolean
是否正在编辑中

TODO

Returns boolean
Memberof
Shape
Inherited from Shape.editing
- Defined in writeboard/shape/base/Shape.ts:88
set editing(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from Shape.editing
- Defined in writeboard/shape/base/Shape.ts:89

ghost

get ghost(): boolean
图形能否交互

当ghost为true时，只能看见这个图形，而不能选中并与其产生交互。利用这个属性，可以实现比较特殊的功能，比如：背景图

Returns boolean
Memberof
Shape
Inherited from Shape.ghost
- Defined in writeboard/shape/base/Shape.ts:152
set ghost(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from Shape.ghost
- Defined in writeboard/shape/base/Shape.ts:153

h

get h(): number
Returns number
Inherited from Shape.h
- Defined in writeboard/shape/base/Shape.ts:220

halfH

get halfH(): number
Returns number
Inherited from Shape.halfH
- Defined in writeboard/shape/base/Shape.ts:216

halfW

get halfW(): number
Returns number
Inherited from Shape.halfW
- Defined in writeboard/shape/base/Shape.ts:215

left

get left(): number
Returns number
Inherited from Shape.left
- Defined in writeboard/shape/base/Shape.ts:221

leftBottom

get leftBottom(): IVector
Returns IVector
Inherited from Shape.leftBottom
- Defined in writeboard/shape/base/Shape.ts:231

leftTop

get leftTop(): IVector
Returns IVector
Inherited from Shape.leftTop
- Defined in writeboard/shape/base/Shape.ts:230

lineWidth

get lineWidth(): number
图形描边宽度若图形不存在描边，则为0

Returns number
Memberof
Shape
Inherited from Shape.lineWidth
- Defined in writeboard/shape/base/Shape.ts:168
set lineWidth(v: number): void
Parameters
- v: number
Returns void
Inherited from Shape.lineWidth
- Defined in writeboard/shape/base/Shape.ts:169

locked

get locked(): boolean
图形是否被锁定

被锁定的图形将不能被编辑，选中图形时，选中图形将显示为被锁定

Returns boolean
Memberof
Shape
Inherited from Shape.locked
- Defined in writeboard/shape/base/Shape.ts:134
set locked(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from Shape.locked
- Defined in writeboard/shape/base/Shape.ts:135

midBottom

get midBottom(): IVector
Returns IVector
Inherited from Shape.midBottom
- Defined in writeboard/shape/base/Shape.ts:245

midLeft

get midLeft(): IVector
Returns IVector
Inherited from Shape.midLeft
- Defined in writeboard/shape/base/Shape.ts:246

midRight

get midRight(): IVector
Returns IVector
Inherited from Shape.midRight
- Defined in writeboard/shape/base/Shape.ts:247

midTop

get midTop(): IVector
Returns IVector
Inherited from Shape.midTop
- Defined in writeboard/shape/base/Shape.ts:244

midX

get midX(): number
Returns number
Inherited from Shape.midX
- Defined in writeboard/shape/base/Shape.ts:217

midY

get midY(): number
Returns number
Inherited from Shape.midY
- Defined in writeboard/shape/base/Shape.ts:218

resizable

get resizable(): Resizable
图形是否可以被用户修改尺寸

当不为Resizable.None时，选中的图形将出现控制点，此时可以点击拖拽控制点来修改图形的尺寸

Returns Resizable
Memberof
Shape
Inherited from Shape.resizable
- Defined in writeboard/shape/base/Shape.ts:124

right

get right(): number
Returns number
Inherited from Shape.right
- Defined in writeboard/shape/base/Shape.ts:222

rightBottom

get rightBottom(): IVector
Returns IVector
Inherited from Shape.rightBottom
- Defined in writeboard/shape/base/Shape.ts:233

rightTop

get rightTop(): IVector
Returns IVector
Inherited from Shape.rightTop
- Defined in writeboard/shape/base/Shape.ts:232

rotatedBottomLeft

get rotatedBottomLeft(): IVector
Returns IVector
Inherited from Shape.rotatedBottomLeft
- Defined in writeboard/shape/base/Shape.ts:236

rotatedBottomRight

get rotatedBottomRight(): IVector
Returns IVector
Inherited from Shape.rotatedBottomRight
- Defined in writeboard/shape/base/Shape.ts:238

rotatedLeftBottom

get rotatedLeftBottom(): IVector
Returns IVector
Inherited from Shape.rotatedLeftBottom
- Defined in writeboard/shape/base/Shape.ts:240

rotatedLeftTop

get rotatedLeftTop(): IVector
Returns IVector
Inherited from Shape.rotatedLeftTop
- Defined in writeboard/shape/base/Shape.ts:239

rotatedMid

get rotatedMid(): IVector
Returns IVector
Inherited from Shape.rotatedMid
- Defined in writeboard/shape/base/Shape.ts:253

rotatedMidBottom

get rotatedMidBottom(): IVector
Returns IVector
Inherited from Shape.rotatedMidBottom
- Defined in writeboard/shape/base/Shape.ts:250

rotatedMidLeft

get rotatedMidLeft(): IVector
Returns IVector
Inherited from Shape.rotatedMidLeft
- Defined in writeboard/shape/base/Shape.ts:251

rotatedMidRight

get rotatedMidRight(): IVector
Returns IVector
Inherited from Shape.rotatedMidRight
- Defined in writeboard/shape/base/Shape.ts:252

rotatedMidTop

get rotatedMidTop(): IVector
Returns IVector
Inherited from Shape.rotatedMidTop
- Defined in writeboard/shape/base/Shape.ts:249

rotatedRightBottom

get rotatedRightBottom(): IVector
Returns IVector
Inherited from Shape.rotatedRightBottom
- Defined in writeboard/shape/base/Shape.ts:242

rotatedRightTop

get rotatedRightTop(): IVector
Returns IVector
Inherited from Shape.rotatedRightTop
- Defined in writeboard/shape/base/Shape.ts:241

rotatedTopLeft

get rotatedTopLeft(): IVector
Returns IVector
Inherited from Shape.rotatedTopLeft
- Defined in writeboard/shape/base/Shape.ts:235

rotatedTopRight

get rotatedTopRight(): IVector
Returns IVector
Inherited from Shape.rotatedTopRight
- Defined in writeboard/shape/base/Shape.ts:237

rotation

get rotation(): number
Returns number
Inherited from Shape.rotation
- Defined in writeboard/shape/base/Shape.ts:255

selected

get selected(): boolean
图形是否被选中

选中图形后，图形将呈现为被选中状态，其他一些对图形的操作均需要选中图形

Returns boolean
Memberof
Shape
Inherited from Shape.selected
- Defined in writeboard/shape/base/Shape.ts:105
set selected(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from Shape.selected
- Defined in writeboard/shape/base/Shape.ts:106

top

get top(): number
Returns number
Inherited from Shape.top
- Defined in writeboard/shape/base/Shape.ts:223

topLeft

get topLeft(): IVector
Returns IVector
Inherited from Shape.topLeft
- Defined in writeboard/shape/base/Shape.ts:226

topRight

get topRight(): IVector
Returns IVector
Inherited from Shape.topRight
- Defined in writeboard/shape/base/Shape.ts:228

type

get type(): ShapeType
图形类型

当图形为内置图形时，值为ShapeEnum，否则为字符串

Returns ShapeType
See
Memberof
Shape
Inherited from Shape.type
- Defined in writeboard/shape/base/Shape.ts:47

visible

get visible(): boolean
图形是否可见，

当不可见时，图形将在渲染时被忽略

Returns boolean
Memberof
Shape
Inherited from Shape.visible
- Defined in writeboard/shape/base/Shape.ts:71
set visible(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from Shape.visible
- Defined in writeboard/shape/base/Shape.ts:72

w

get w(): number
Returns number
Inherited from Shape.w
- Defined in writeboard/shape/base/Shape.ts:219

x

get x(): number
Returns number
Inherited from Shape.x
- Defined in writeboard/shape/base/Shape.ts:213

y

get y(): number
Returns number
Inherited from Shape.y
- Defined in writeboard/shape/base/Shape.ts:214

Methods

addEventListener

addEventListener<K extends keyof ShapeEventMap>(
    type: K,
    listener: ShapeEventListener<K>,
    options?: boolean | AddEventListenerOptions,
): this
Type Parameters
- K extends keyof ShapeEventMap
Parameters
- type: K
- listener: ShapeEventListener<K>
- Optionaloptions: boolean | AddEventListenerOptions
Returns this
Inherited from Shape.addEventListener
- Defined in writeboard/shape/base/Shape.ts:547

appendDot

appendDot(dot: IDot, type?: "first" | "last"): void
Parameters
- dot: IDot
- Optionaltype: "first" | "last"
Returns void
- Defined in writeboard/shape/pen/Shape.ts:114

beginDirty

beginDirty(prev?: Partial<IShapeData>): void
Parameters
- Optionalprev: Partial<IShapeData>
Returns void
Inherited from Shape.beginDirty
- Defined in writeboard/shape/base/Shape.ts:184

`Protected`beginDraw

beginDraw(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Shape.beginDraw
- Defined in writeboard/shape/base/Shape.ts:524

boundingRect

boundingRect(): IRect
获取包围盒矩形

Returns IRect
包围盒矩形

Memberof
Shape
Inherited from Shape.boundingRect
- Defined in writeboard/shape/base/Shape.ts:375

dispatchEvent

dispatchEvent<K extends keyof ShapeEventMap>(
type: K,
detail: ShapeEventMap[K]["detail"],
): this
Type Parameters
- K extends keyof ShapeEventMap
Parameters
- type: K
- detail: ShapeEventMap[K]["detail"]
Returns this
Inherited from Shape.dispatchEvent
- Defined in writeboard/shape/base/Shape.ts:561

drawingRect

drawingRect(): IRect
绘制矩形

Returns IRect
Inherited from Shape.drawingRect
- Defined in writeboard/shape/base/Shape.ts:347

endDirty

endDirty(prev?: Partial<IShapeData>): void
Parameters
- Optionalprev: Partial<IShapeData>
Returns void
Inherited from Shape.endDirty
- Defined in writeboard/shape/base/Shape.ts:189

`Protected`endDraw

endDraw(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Shape.endDraw
- Defined in writeboard/shape/base/Shape.ts:540

geo

geo(x: number, y: number, w: number, h: number): void
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from Shape.geo
- Defined in writeboard/shape/base/Shape.ts:282

geoBy

geoBy(x: number, y: number, w: number, h: number): void
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from Shape.geoBy
- Defined in writeboard/shape/base/Shape.ts:319

getGeo

getGeo(): Rect
Returns Rect
Inherited from Shape.getGeo
- Defined in writeboard/shape/base/Shape.ts:270

getResizerNumbers

getResizerNumbers(
    x: number,
    y: number,
    w: number,
    h: number,
): {
    by: number;
    lx: number;
    mx: number;
    my: number;
    rx: number;
    s: number;
    ty: number;
}
Parameters
- x: number
- y: number
- w: number
- h: number
Returns {
    by: number;
    lx: number;
    mx: number;
    my: number;
    rx: number;
    s: number;
    ty: number;
}
Inherited from Shape.getResizerNumbers
- Defined in writeboard/shape/base/Shape.ts:400

map2me

map2me(x: number, y: number): Vector
世界坐标系坐标　转换　本图坐标系坐标
Parameters
- x: number
  世界坐标系X坐标
- y: number
  世界坐标系Y坐标
Returns Vector
本图坐标系坐标
Inherited from Shape.map2me
- Defined in writeboard/shape/base/Shape.ts:421
map2me(v: IVector): Vector
世界坐标系坐标　转换　本图坐标系坐标
Parameters
- v: IVector
  世界坐标系坐标
Returns Vector
本图坐标系坐标
Inherited from Shape.map2me
- Defined in writeboard/shape/base/Shape.ts:428

map2world

map2world(x: number, y: number): Vector
本图坐标系坐标转换世界坐标系坐标
Parameters
- x: number
  本图坐标系X坐标
- y: number
  本图坐标系Y坐标
Returns Vector
世界坐标系坐标
Inherited from Shape.map2world
- Defined in writeboard/shape/base/Shape.ts:453
map2world(v: IVector): Vector
本图坐标系坐标转换世界坐标系坐标
Parameters
- v: IVector
  本图坐标系坐标
Returns Vector
世界坐标系坐标
Inherited from Shape.map2world
- Defined in writeboard/shape/base/Shape.ts:460

merge

merge(data: Partial<PenData>): void
Parameters
- data: Partial<PenData>
Returns void
Overrides Shape.merge
- Defined in writeboard/shape/pen/Shape.ts:31

move

move(x: number, y: number): void
移动图形
Parameters
- x: number
  x坐标
- y: number
  y坐标
Returns void
void
Inherited from Shape.move
- Defined in writeboard/shape/base/Shape.ts:205

moveBy

moveBy(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from Shape.moveBy
- Defined in writeboard/shape/base/Shape.ts:301

removeEventListener

removeEventListener<K extends keyof ShapeEventMap>(
    type: K,
    listener: ShapeEventListener<K>,
    options?: boolean | AddEventListenerOptions,
): this
Type Parameters
- K extends keyof ShapeEventMap
Parameters
- type: K
- listener: ShapeEventListener<K>
- Optionaloptions: boolean | AddEventListenerOptions
Returns this
Inherited from Shape.removeEventListener
- Defined in writeboard/shape/base/Shape.ts:555

render

render(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Overrides Shape.render
- Defined in writeboard/shape/pen/Shape.ts:127

resize

resize(w: number, h: number): void
Parameters
- w: number
- h: number
Returns void
Inherited from Shape.resize
- Defined in writeboard/shape/base/Shape.ts:209

resizeBy

resizeBy(w: number, h: number): void
Parameters
- w: number
- h: number
Returns void
Inherited from Shape.resizeBy
- Defined in writeboard/shape/base/Shape.ts:310

resizeDirection

resizeDirection(
pointerX: number,
pointerY: number,
): [ResizeDirection, undefined | Rect]
Parameters
- pointerX: number
- pointerY: number
Returns [ResizeDirection, undefined | Rect]
Inherited from Shape.resizeDirection
- Defined in writeboard/shape/base/Shape.ts:477

rotateBy

rotateBy(d: number): void
Parameters
- d: number
Returns void
Inherited from Shape.rotateBy
- Defined in writeboard/shape/base/Shape.ts:257

rotateTo

rotateTo(r: number): void
Parameters
- r: number
Returns void
Inherited from Shape.rotateTo
- Defined in writeboard/shape/base/Shape.ts:262

selectorRect

selectorRect(): IRect
Returns IRect
Inherited from Shape.selectorRect
- Defined in writeboard/shape/base/Shape.ts:357

setGeo

setGeo(rect: Rect): void
Parameters
- rect: Rect
Returns void
Inherited from Shape.setGeo
- Defined in writeboard/shape/base/Shape.ts:278

Class ShapePen

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ShapePen

Properties

Protected Optional_b

Protected_d

Protected_r

Accessors

board

Returns undefined | Board

Memberof

Parameters

Returns void

bottom

Returns number

bottomLeft

Returns IVector

bottomRight

Returns IVector

data

Returns D

Memberof

editing

Returns boolean

Memberof

Parameters

Returns void

ghost

Returns boolean

Memberof

Parameters

Returns void

h

Returns number

halfH

Returns number

halfW

Returns number

left

Returns number

leftBottom

Returns IVector

leftTop

Returns IVector

lineWidth

Returns number

Memberof

Parameters

Returns void

locked

Returns boolean

Memberof

Parameters

Returns void

midBottom

Returns IVector

midLeft

Returns IVector

midRight

Returns IVector

midTop

Returns IVector

midX

Returns number

midY

Returns number

resizable

Returns Resizable

Memberof

right

Returns number

`Protected` `Optional`_b

`Protected`_d

`Protected`_r

`Protected`beginDraw