Skip to content

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

Interface: SingleView

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

Properties

detailProperties$

readonly detailProperties$: ReadonlySignal<string[]>

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


featureFlags$

readonly featureFlags$: ReadonlySignal<DatabaseFlags>

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


id

readonly id: string

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


isLocked$

isLocked$: ReadonlySignal<boolean>

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


mainProperties$

mainProperties$: ReadonlySignal<MainProperties>

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


manager

readonly manager: ViewManager

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


meta

readonly meta: ViewMeta

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


name$

readonly name$: ReadonlySignal<string>

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


properties$

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

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


propertiesWithoutFilter$

readonly propertiesWithoutFilter$: ReadonlySignal<string[]>

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


propertyIds$

readonly propertyIds$: ReadonlySignal<string[]>

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


propertyMetas$

readonly propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

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


readonly$

readonly readonly$: ReadonlySignal<boolean>

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


rows$

readonly rows$: ReadonlySignal<string[]>

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


type

readonly type: string

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


vars$

readonly vars$: ReadonlySignal<Variable[]>

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

Methods

cellGet()

cellGet(rowId, propertyId): Cell

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

Parameters

rowId

string

propertyId

string

Returns

Cell


cellJsonValueGet()

cellJsonValueGet(rowId, propertyId): unknown

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

Parameters

rowId

string

propertyId

string

Returns

unknown


cellJsonValueSet()

cellJsonValueSet(rowId, propertyId, value): void

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

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void


cellStringValueGet()

cellStringValueGet(rowId, propertyId): undefined | string

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

Parameters

rowId

string

propertyId

string

Returns

undefined | string


cellValueGet()

cellValueGet(rowId, propertyId): unknown

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

Parameters

rowId

string

propertyId

string

Returns

unknown


cellValueSet()

cellValueSet(rowId, propertyId, value): void

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

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void


contextGet()

contextGet<T>(key): T

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

Type Parameters

T

T

Parameters

key

DataViewContextKey<T>

Returns

T


delete()

delete(): void

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

Returns

void


duplicate()

duplicate(): void

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

Returns

void


lockRows()

lockRows(lock): void

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

Parameters

lock

boolean

Returns

void


nameSet()

nameSet(name): void

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

Parameters

name

string

Returns

void


propertyAdd()

propertyAdd(toAfterOfProperty, type?): undefined | string

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

Parameters

toAfterOfProperty

InsertToPosition

type?

string

Returns

undefined | string


propertyCanDelete()

propertyCanDelete(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyCanHide()

propertyCanHide(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

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

Parameters

propertyId

string

Returns

Record<string, unknown>


propertyDataSet()

propertyDataSet(propertyId, data): void

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

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void


propertyDataTypeGet()

propertyDataTypeGet(propertyId): undefined | TypeInstance

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

Parameters

propertyId

string

Returns

undefined | TypeInstance


propertyDelete()

propertyDelete(propertyId): void

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

Parameters

propertyId

string

Returns

void


propertyDuplicate()

propertyDuplicate(propertyId): void

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

Parameters

propertyId

string

Returns

void


propertyGet()

propertyGet(propertyId): Property

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

Parameters

propertyId

string

Returns

Property


propertyHideGet()

propertyHideGet(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyHideSet()

propertyHideSet(propertyId, hide): void

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

Parameters

propertyId

string

hide

boolean

Returns

void


propertyIconGet()

propertyIconGet(type): undefined | UniComponent

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

Parameters

type

string

Returns

undefined | UniComponent


propertyIdGetByIndex()

propertyIdGetByIndex(index): undefined | string

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

Parameters

index

number

Returns

undefined | string


propertyIndexGet()

propertyIndexGet(propertyId): number

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

Parameters

propertyId

string

Returns

number


propertyMetaGet()

propertyMetaGet(type): undefined | PropertyMetaConfig

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

Parameters

type

string

Returns

undefined | PropertyMetaConfig


propertyMove()

propertyMove(propertyId, position): void

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

Parameters

propertyId

string

position

InsertToPosition

Returns

void


propertyNameGet()

propertyNameGet(propertyId): string

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

Parameters

propertyId

string

Returns

string


propertyNameSet()

propertyNameSet(propertyId, name): void

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

Parameters

propertyId

string

name

string

Returns

void


propertyNextGet()

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

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

Parameters

propertyId

string

Returns

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


propertyParseValueFromString()

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

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

Parameters

propertyId

string

value

string

Returns

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


propertyPreGet()

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

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

Parameters

propertyId

string

Returns

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


propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

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

Parameters

propertyId

string

Returns

boolean


propertyTypeGet()

propertyTypeGet(propertyId): undefined | string

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

Parameters

propertyId

string

Returns

undefined | string


propertyTypeSet()

propertyTypeSet(propertyId, type): void

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

Parameters

propertyId

string

type

string

Returns

void


rowAdd()

rowAdd(insertPosition): string

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

Parameters

insertPosition

InsertToPosition

Returns

string


rowDelete()

rowDelete(ids): void

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

Parameters

ids

string[]

Returns

void


rowGet()

rowGet(rowId): Row

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

Parameters

rowId

string

Returns

Row


rowMove()

rowMove(rowId, position): void

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

Parameters

rowId

string

position

InsertToPosition

Returns

void


rowNextGet()

rowNextGet(rowId): undefined | string

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

Parameters

rowId

string

Returns

undefined | string


rowPrevGet()

rowPrevGet(rowId): undefined | string

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

Parameters

rowId

string

Returns

undefined | string


traitGet()

traitGet<T>(key): undefined | T

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

Type Parameters

T

T

Parameters

key

TraitKey<T>

Returns

undefined | T