BlockSuite API Documentation / @blocksuite/blocks / IShape

Interface: IShape

Extends

• ISurfaceElement

Properties

batch

batch: null | string

Inherited from

ISurfaceElement.batch

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:10

---

color?

optional color: string

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:17

---

fillColor

fillColor: string

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:10

---

filled

filled: boolean

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:9

---

fontFamily?

optional fontFamily: FontFamily

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:19

---

fontSize?

optional fontSize: ShapeTextFontSize

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:18

---

fontStyle?

optional fontStyle: FontStyle

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:21

---

fontWeight?

optional fontWeight: FontWeight

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:20

---

id

id: string

Inherited from

ISurfaceElement.id

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:4

---

index

index: string

Inherited from

ISurfaceElement.index

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:7

---

radius

radius: number

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:8

---

rotate

rotate: number

Inherited from

ISurfaceElement.rotate

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:9

---

roughness?

optional roughness: number

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:15

---

seed

seed: number

Inherited from

ISurfaceElement.seed

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:8

---

shapeStyle

shapeStyle: ShapeStyle

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:14

---

shapeType

shapeType: ShapeType

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:7

---

strokeColor

strokeColor: string

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:12

---

strokeStyle

strokeStyle: StrokeStyle

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:13

---

strokeWidth

strokeWidth: number

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:11

---

text?

optional text: YText

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:16

---

textAlign?

optional textAlign: TextAlign

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:22

---

textHorizontalAlign?

optional textHorizontalAlign: TextAlign

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:23

---

textVerticalAlign?

optional textVerticalAlign: TextVerticalAlign

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:24

---

type

type: SHAPE

Overrides

ISurfaceElement.type

Defined in

packages/affine/block-surface/dist/elements/shape/types.d.ts:6

---

xywh

xywh: `[${number},${number},${number},${number}]`

Inherited from

ISurfaceElement.xywh

Defined in

packages/affine/block-surface/dist/elements/surface-element.d.ts:6