BlockSuite API Documentation / @blocksuite/affine-block-data-view

@blocksuite/affine-block-data-view

Classes

DataViewBlockComponent

Extends

• CaptionedBlockComponent<DataViewBlockModel>

Constructors

Other

_bindHotkey

_bindHotkey: (hotkeys) => Disposable

Parameters

hotkeys

Record<string, UIEventHandler>

Returns

Disposable

_handleEvent

_handleEvent: (name, handler) => Disposable

Parameters

name

"click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "keyPress" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "nativeDragOver" | "nativeDragLeave" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"

handler

UIEventHandler

Returns

Disposable

headerWidget

headerWidget: DataViewWidget

selection$

selection$: ReadonlySignal<DataViewSelection | undefined>

toolsWidget

toolsWidget: DataViewWidget

styles

static styles: CSSResult

Overrides

CaptionedBlockComponent.styles

dataSource

Get Signature

get dataSource(): DataSource

Returns

DataSource

topContenteditableElement

Get Signature

get topContenteditableElement(): BlockComponent<BlockModel<object>, BlockService, string> | null

Returns

BlockComponent<BlockModel<object>, BlockService, string> | null

Overrides

CaptionedBlockComponent.topContenteditableElement

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

CaptionedBlockComponent.connectedCallback

renderBlock()

renderBlock(): TemplateResult

Returns

TemplateResult

Overrides

CaptionedBlockComponent.renderBlock

setSelection()

setSelection(selection): void

Parameters

selection

DataViewSelection | undefined

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

updates

---

DataViewBlockModel

Extends

• BlockModel<Props>

Constructors

Constructor

new DataViewBlockModel(): DataViewBlockModel

Returns

DataViewBlockModel

Overrides

BlockModel.constructor

Properties

Accessors

Methods

applyViewsUpdate()

applyViewsUpdate(): void

Returns

void

deleteView()

deleteView(id): void

Parameters

id

string

Returns

void

duplicateView()

duplicateView(id): string

Parameters

id

string

Returns

string

moveViewTo()

moveViewTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

updateView()

updateView(id, update): void

Parameters

id

string

update

(data) => Partial<DataViewDataType>

Returns

void

Variables

DataViewBlockSchema

const DataViewBlockSchema: object

Type Declaration

model

model: object & object

Type Declaration

flavour

flavour: "affine:data-view"

props

props: PropsGetter<Props>

Type Declaration

children

children: string[]

parent

parent: string[]

role

role: "hub" = 'hub'

version

version: number = 1

transformer?

optional transformer?: (transformerConfig) => BaseBlockTransformer

Parameters

transformerConfig

Map<string, unknown>

Returns

BaseBlockTransformer

version

version: number

---

DataViewBlockSchemaExtension

const DataViewBlockSchemaExtension: ExtensionType

---

DataViewBlockSpec

const DataViewBlockSpec: ExtensionType[]