Class Shape<D>

一切图形的基类

Export

Shape 图形基类

Type Parameters

D extends ShapeData = ShapeData
图形数据类

Hierarchy (View Summary)

Shape

Constructors

constructor

new Shape<D extends ShapeData = ShapeData>(
data: Partial<D>,
cls: new (other?: Partial<D>) => D,
): Shape<D>
Type Parameters
- D extends ShapeData = ShapeData
Parameters
- data: Partial<D>
- cls: new (other?: Partial<D>) => D
Returns Shape<D>
- Defined in writeboard/shape/base/Shape.ts:24

Properties

`Protected` `Optional`_b

_b?: Board

`Protected`_d

_d: D

`Protected`_r

_r: Resizable = Resizable.None

Accessors

board

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

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

bottom

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

bottomLeft

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

bottomRight

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

data

get data(): D
图形的数据

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

editing

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

TODO

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

ghost

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

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

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

h

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

halfH

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

halfW

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

left

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

leftBottom

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

leftTop

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

lineWidth

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

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

locked

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

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

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

midBottom

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

midLeft

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

midRight

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

midTop

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

midX

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

midY

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

resizable

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

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

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

right

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

rightBottom

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

rightTop

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

rotatedBottomLeft

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

rotatedBottomRight

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

rotatedLeftBottom

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

rotatedLeftTop

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

rotatedMid

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

rotatedMidBottom

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

rotatedMidLeft

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

rotatedMidRight

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

rotatedMidTop

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

rotatedRightBottom

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

rotatedRightTop

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

rotatedTopLeft

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

rotatedTopRight

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

rotation

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

selected

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

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

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

top

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

topLeft

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

topRight

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

type

get type(): ShapeType
图形类型

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

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

visible

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

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

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

w

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

x

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

y

get y(): number
Returns number
- 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
- Defined in writeboard/shape/base/Shape.ts:547

beginDirty

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

`Protected`beginDraw

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

boundingRect

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

Returns IRect
包围盒矩形

Memberof
Shape
- 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
- Defined in writeboard/shape/base/Shape.ts:561

drawingRect

drawingRect(): IRect
绘制矩形

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

endDirty

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

`Protected`endDraw

endDraw(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- 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
- 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
- Defined in writeboard/shape/base/Shape.ts:319

getGeo

getGeo(): Rect
Returns Rect
- 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;
}
- Defined in writeboard/shape/base/Shape.ts:400

map2me

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

map2world

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

merge

merge(data: Partial<IShapeData>): void
Parameters
- data: Partial<IShapeData>
Returns void
- Defined in writeboard/shape/base/Shape.ts:177

move

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

moveBy

moveBy(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- 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
- Defined in writeboard/shape/base/Shape.ts:555

render

render(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in writeboard/shape/base/Shape.ts:328

resize

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

resizeBy

resizeBy(w: number, h: number): void
Parameters
- w: number
- h: number
Returns void
- 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]
- Defined in writeboard/shape/base/Shape.ts:477

rotateBy

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

rotateTo

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

selectorRect

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

setGeo

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