BlockSuite API Documentation / @blocksuite/data-view / SingleViewBase

Class: abstract SingleViewBase<ViewData>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:149

Type Parameters

ViewData

ViewData extends DataViewDataType = DataViewDataType

Implements

• SingleView

Constructors

new SingleViewBase()

new SingleViewBase<ViewData>(manager, id): SingleViewBase<ViewData>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:238

Parameters

manager

ViewManager

id

string

Returns

SingleViewBase<ViewData>

Properties

data$

data$: ReadonlySignal<undefined | ViewData>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:157

---

detailProperties$

abstract detailProperties$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:161

Implementation of

SingleView.detailProperties$

---

id

id: string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:240

Implementation of

SingleView.id

---

isLocked$

isLocked$: ReadonlySignal<boolean>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:165

Implementation of

SingleView.isLocked$

---

lockRows$

protected lockRows$: Signal<boolean>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:163

---

mainProperties$

abstract mainProperties$: ReadonlySignal<MainProperties>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:169

Implementation of

SingleView.mainProperties$

---

manager

manager: ViewManager

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:239

Implementation of

SingleView.manager

---

name$

name$: ReadonlySignal<string>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:171

Implementation of

SingleView.name$

---

preRows

preRows: string[] = []

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:175

---

properties$

properties$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>>[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:179

Implementation of

SingleView.properties$

---

propertiesWithoutFilter$

abstract propertiesWithoutFilter$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:185

Implementation of

SingleView.propertiesWithoutFilter$

---

propertyIds$

abstract propertyIds$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:177

Implementation of

SingleView.propertyIds$

---

readonly$

abstract readonly$: ReadonlySignal<boolean>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:187

Implementation of

SingleView.readonly$

---

rows$

rows$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:189

Implementation of

SingleView.rows$

---

vars$

vars$: ReadonlySignal<object[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:196

Implementation of

SingleView.vars$

Accessors

dataSource

Get Signature

get protected dataSource(): DataSource

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:216

Returns

DataSource

---

featureFlags$

Get Signature

get featureFlags$(): ReadonlySignal<DatabaseFlags>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:220

Returns

ReadonlySignal<DatabaseFlags>

Implementation of

SingleView.featureFlags$

---

isLocked

Get Signature

get isLocked(): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:224

Returns

boolean

---

meta

Get Signature

get meta(): ViewMeta

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:228

Returns

ViewMeta

Implementation of

SingleView.meta

---

propertyMetas$

Get Signature

get propertyMetas$(): ReadonlySignal<PropertyMetaConfig[]>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:232

Returns

ReadonlySignal<PropertyMetaConfig[]>

Implementation of

SingleView.propertyMetas$

---

type

Get Signature

get abstract type(): string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:236

Returns

string

Implementation of

SingleView.type

Methods

cellGet()

cellGet(rowId, propertyId): Cell

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:277

Parameters

rowId

string

propertyId

string

Returns

Cell

Implementation of

SingleView.cellGet

---

cellJsonValueGet()

cellJsonValueGet(rowId, propertyId): unknown

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:281

Parameters

rowId

string

propertyId

string

Returns

unknown

Implementation of

SingleView.cellJsonValueGet

---

cellJsonValueSet()

cellJsonValueSet(rowId, propertyId, value): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:295

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Implementation of

SingleView.cellJsonValueSet

---

cellStringValueGet()

cellStringValueGet(rowId, propertyId): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:312

Parameters

rowId

string

propertyId

string

Returns

undefined | string

Implementation of

SingleView.cellStringValueGet

---

cellValueGet()

cellValueGet(rowId, propertyId): unknown

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:325

Parameters

rowId

string

propertyId

string

Returns

unknown

Implementation of

SingleView.cellValueGet

---

cellValueSet()

cellValueSet(rowId, propertyId, value): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:333

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Implementation of

SingleView.cellValueSet

---

contextGet()

contextGet<T>(key): T

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:337

Type Parameters

T

T

Parameters

key

DataViewContextKey<T>

Returns

T

Implementation of

SingleView.contextGet

---

dataUpdate()

dataUpdate(updater): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:341

Parameters

updater

(viewData) => Partial<ViewData>

Returns

void

---

delete()

delete(): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:345

Returns

void

Implementation of

SingleView.delete

---

duplicate()

duplicate(): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:349

Returns

void

Implementation of

SingleView.duplicate

---

isShow()

abstract isShow(rowId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:353

Parameters

rowId

string

Returns

boolean

---

lockRows()

lockRows(lock): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:355

Parameters

lock

boolean

Returns

void

Implementation of

SingleView.lockRows

---

nameSet()

nameSet(name): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:359

Parameters

name

string

Returns

void

Implementation of

SingleView.nameSet

---

propertyAdd()

propertyAdd(position, type?): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:367

Parameters

position

InsertToPosition

type?

string

Returns

undefined | string

Implementation of

SingleView.propertyAdd

---

propertyCanDelete()

propertyCanDelete(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:243

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyCanDelete

---

propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:247

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyCanDuplicate

---

propertyCanHide()

propertyCanHide(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:255

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyCanHide

---

propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:376

Parameters

propertyId

string

Returns

Record<string, unknown>

Implementation of

SingleView.propertyDataGet

---

propertyDataSet()

propertyDataSet(propertyId, data): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:380

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

Implementation of

SingleView.propertyDataSet

---

propertyDataTypeGet()

propertyDataTypeGet(propertyId): undefined | TypeInstance

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:384

Parameters

propertyId

string

Returns

undefined | TypeInstance

Implementation of

SingleView.propertyDataTypeGet

---

propertyDelete()

propertyDelete(propertyId): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:399

Parameters

propertyId

string

Returns

void

Implementation of

SingleView.propertyDelete

---

propertyDuplicate()

propertyDuplicate(propertyId): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:403

Parameters

propertyId

string

Returns

void

Implementation of

SingleView.propertyDuplicate

---

propertyGet()

abstract propertyGet(propertyId): Property

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:414

Parameters

propertyId

string

Returns

Property

Implementation of

SingleView.propertyGet

---

propertyHideGet()

abstract propertyHideGet(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:416

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyHideGet

---

propertyHideSet()

abstract propertyHideSet(propertyId, hide): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:418

Parameters

propertyId

string

hide

boolean

Returns

void

Implementation of

SingleView.propertyHideSet

---

propertyIconGet()

propertyIconGet(type): undefined | UniComponent

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:420

Parameters

type

string

Returns

undefined | UniComponent

Implementation of

SingleView.propertyIconGet

---

propertyIdGetByIndex()

propertyIdGetByIndex(index): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:424

Parameters

index

number

Returns

undefined | string

Implementation of

SingleView.propertyIdGetByIndex

---

propertyIndexGet()

propertyIndexGet(propertyId): number

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:428

Parameters

propertyId

string

Returns

number

Implementation of

SingleView.propertyIndexGet

---

propertyMetaGet()

propertyMetaGet(type): undefined | PropertyMetaConfig

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:432

Parameters

type

string

Returns

undefined | PropertyMetaConfig

Implementation of

SingleView.propertyMetaGet

---

propertyMove()

abstract propertyMove(propertyId, position): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:436

Parameters

propertyId

string

position

InsertToPosition

Returns

void

Implementation of

SingleView.propertyMove

---

propertyNameGet()

propertyNameGet(propertyId): string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:438

Parameters

propertyId

string

Returns

string

Implementation of

SingleView.propertyNameGet

---

propertyNameSet()

propertyNameSet(propertyId, name): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:442

Parameters

propertyId

string

name

string

Returns

void

Implementation of

SingleView.propertyNameSet

---

propertyNextGet()

propertyNextGet(propertyId): undefined | Property<unknown, unknown, Record<string, unknown>>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:446

Parameters

propertyId

string

Returns

undefined | Property<unknown, unknown, Record<string, unknown>>

Implementation of

SingleView.propertyNextGet

---

propertyParseValueFromString()

propertyParseValueFromString(propertyId, cellData): undefined | { data: Record<string, unknown>; value: unknown; }

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:453

Parameters

propertyId

string

cellData

string

Returns

undefined | { data: Record<string, unknown>; value: unknown; }

Implementation of

SingleView.propertyParseValueFromString

---

propertyPreGet()

propertyPreGet(propertyId): undefined | Property<unknown, unknown, Record<string, unknown>>

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:470

Parameters

propertyId

string

Returns

undefined | Property<unknown, unknown, Record<string, unknown>>

Implementation of

SingleView.propertyPreGet

---

propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:477

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyReadonlyGet

---

propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:251

Parameters

propertyId

string

Returns

boolean

Implementation of

SingleView.propertyTypeCanSet

---

propertyTypeGet()

propertyTypeGet(propertyId): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:481

Parameters

propertyId

string

Returns

undefined | string

Implementation of

SingleView.propertyTypeGet

---

propertyTypeSet()

propertyTypeSet(propertyId, type): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:485

Parameters

propertyId

string

type

string

Returns

void

Implementation of

SingleView.propertyTypeSet

---

rowAdd()

rowAdd(insertPosition): string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:489

Parameters

insertPosition

number | InsertToPosition

Returns

string

Implementation of

SingleView.rowAdd

---

rowDelete()

rowDelete(ids): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:493

Parameters

ids

string[]

Returns

void

Implementation of

SingleView.rowDelete

---

rowGet()

rowGet(rowId): Row

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:497

Parameters

rowId

string

Returns

Row

Implementation of

SingleView.rowGet

---

rowMove()

rowMove(rowId, position): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:501

Parameters

rowId

string

position

InsertToPosition

Returns

void

Implementation of

SingleView.rowMove

---

rowNextGet()

abstract rowNextGet(rowId): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:505

Parameters

rowId

string

Returns

undefined | string

Implementation of

SingleView.rowNextGet

---

rowPrevGet()

abstract rowPrevGet(rowId): undefined | string

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:507

Parameters

rowId

string

Returns

undefined | string

Implementation of

SingleView.rowPrevGet

---

rowsMapping()

protected rowsMapping(rows): string[]

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:509

Parameters

rows

string[]

Returns

string[]

---

setSearch()

setSearch(str): void

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:513

Parameters

str

string

Returns

void

---

traitGet()

traitGet<T>(key): undefined | T

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:517

Type Parameters

T

T

Parameters

key

TraitKey<T>

Returns

undefined | T

Implementation of

SingleView.traitGet

---

traitSet()

protected traitSet<T>(key, value): T

Defined in: packages/affine/data-view/src/core/view-manager/single-view.ts:521

Type Parameters

T

T

Parameters

key

TraitKey<T>

value

T

Returns

T