BlockSuite API Documentation / @blocksuite/blocks / IShape

Interface: IShape

Contents

• Extends
• Properties
  • batch
  • color?
  • fillColor
  • filled
  • fontFamily?
  • fontSize?
  • fontStyle?
  • fontWeight?
  • id
  • index
  • radius
  • rotate
  • roughness?
  • seed
  • shapeStyle
  • shapeType
  • strokeColor
  • strokeStyle
  • strokeWidth
  • text?
  • textAlign?
  • textHorizontalAlign?
  • textVerticalAlign?
  • type
  • xywh

Extends

• ISurfaceElement

Properties

batch

batch: null | string

Inherited from

ISurfaceElement.batch

Source

packages/blocks/src/surface-block/elements/surface-element.ts:35

---

color?

color?: string

Source

packages/blocks/src/surface-block/elements/shape/types.ts:39

---

fillColor

fillColor: string

Source

packages/blocks/src/surface-block/elements/shape/types.ts:30

---

filled

filled: boolean

Source

packages/blocks/src/surface-block/elements/shape/types.ts:29

---

fontFamily?

fontFamily?: CanvasTextFontFamily

Source

packages/blocks/src/surface-block/elements/shape/types.ts:41

---

fontSize?

fontSize?: SHAPE_TEXT_FONT_SIZE

Source

packages/blocks/src/surface-block/elements/shape/types.ts:40

---

fontStyle?

fontStyle?: CanvasTextFontStyle

Source

packages/blocks/src/surface-block/elements/shape/types.ts:43

---

fontWeight?

fontWeight?: CanvasTextFontWeight

Source

packages/blocks/src/surface-block/elements/shape/types.ts:42

---

id

id: string

Inherited from

ISurfaceElement.id

Source

packages/blocks/src/surface-block/elements/surface-element.ts:27

---

index

index: string

Inherited from

ISurfaceElement.index

Source

packages/blocks/src/surface-block/elements/surface-element.ts:30

---

radius

radius: number

Source

packages/blocks/src/surface-block/elements/shape/types.ts:28

---

rotate

rotate: number

Inherited from

ISurfaceElement.rotate

Source

packages/blocks/src/surface-block/elements/surface-element.ts:34

---

roughness?

roughness?: number

Source

packages/blocks/src/surface-block/elements/shape/types.ts:36

---

seed

seed: number

Inherited from

ISurfaceElement.seed

Source

packages/blocks/src/surface-block/elements/surface-element.ts:31

---

shapeStyle

shapeStyle: ShapeStyle

Source

packages/blocks/src/surface-block/elements/shape/types.ts:34

---

shapeType

shapeType: ShapeType

Source

packages/blocks/src/surface-block/elements/shape/types.ts:27

---

strokeColor

strokeColor: string

Source

packages/blocks/src/surface-block/elements/shape/types.ts:32

---

strokeStyle

strokeStyle: StrokeStyle

Source

packages/blocks/src/surface-block/elements/shape/types.ts:33

---

strokeWidth

strokeWidth: number

Source

packages/blocks/src/surface-block/elements/shape/types.ts:31

---

text?

text?: Text

Source

packages/blocks/src/surface-block/elements/shape/types.ts:38

---

textAlign?

textAlign?: "center" | "left" | "right"

Source

packages/blocks/src/surface-block/elements/shape/types.ts:44

---

textHorizontalAlign?

textHorizontalAlign?: "center" | "left" | "right"

Source

packages/blocks/src/surface-block/elements/shape/types.ts:45

---

textVerticalAlign?

textVerticalAlign?: "top" | "center" | "bottom"

Source

packages/blocks/src/surface-block/elements/shape/types.ts:46

---

type

type: SHAPE

Overrides

ISurfaceElement.type

Source

packages/blocks/src/surface-block/elements/shape/types.ts:26

---

xywh

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

Inherited from

ISurfaceElement.xywh

Source

packages/blocks/src/surface-block/elements/surface-element.ts:29

---

Generated using typedoc-plugin-markdown and TypeDoc