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

Interface: DataSource

Defined in: packages/affine/data-view/src/core/data-source/base.ts:13

Properties

allPropertyMetas$

allPropertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:31

---

featureFlags$

featureFlags$: ReadonlySignal<DatabaseFlags>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:16

---

properties$

properties$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:15

---

propertyMetas$

propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:30

---

readonly$

readonly$: ReadonlySignal<boolean>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:14

---

rows$

rows$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:25

---

viewConverts

viewConverts: ViewConvertConfig[]

Defined in: packages/affine/data-view/src/core/data-source/base.ts:70

---

viewDataList$

viewDataList$: ReadonlySignal<DefaultViewDataType[]>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:73

---

viewManager

viewManager: ViewManager

Defined in: packages/affine/data-view/src/core/data-source/base.ts:71

---

viewMetas

viewMetas: ViewMeta[]

Defined in: packages/affine/data-view/src/core/data-source/base.ts:72

Methods

cellValueChange()

cellValueChange(rowId, propertyId, value): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:23

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

---

cellValueGet()

cellValueGet(rowId, propertyId): unknown

Defined in: packages/affine/data-view/src/core/data-source/base.ts:18

Parameters

rowId

string

propertyId

string

Returns

unknown

---

cellValueGet$()

cellValueGet$(rowId, propertyId): ReadonlySignal<unknown>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:19

Parameters

rowId

string

propertyId

string

Returns

ReadonlySignal<unknown>

---

contextGet()

contextGet<T>(key): T

Defined in: packages/affine/data-view/src/core/data-source/base.ts:68

Type Parameters

T

T

Parameters

key

DataViewContextKey<T>

Returns

T

---

propertyAdd()

propertyAdd(insertToPosition, type?): undefined | string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:57

Parameters

insertToPosition

InsertToPosition

type?

string

Returns

undefined | string

---

propertyCanDelete()

propertyCanDelete(propertyId): boolean

Defined in: packages/affine/data-view/src/core/data-source/base.ts:66

Parameters

propertyId

string

Returns

boolean

---

propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

Defined in: packages/affine/data-view/src/core/data-source/base.ts:63

Parameters

propertyId

string

Returns

boolean

---

propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:42

Parameters

propertyId

string

Returns

Record<string, unknown>

---

propertyDataGet$()

propertyDataGet$(propertyId): ReadonlySignal<undefined | Record<string, unknown>>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:43

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | Record<string, unknown>>

---

propertyDataSet()

propertyDataSet(propertyId, data): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:46

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

---

propertyDataTypeGet()

propertyDataTypeGet(propertyId): undefined | TypeInstance

Defined in: packages/affine/data-view/src/core/data-source/base.ts:48

Parameters

propertyId

string

Returns

undefined | TypeInstance

---

propertyDataTypeGet$()

propertyDataTypeGet$(propertyId): ReadonlySignal<undefined | TypeInstance>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:49

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | TypeInstance>

---

propertyDelete()

propertyDelete(id): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:65

Parameters

id

string

Returns

void

---

propertyDuplicate()

propertyDuplicate(propertyId): undefined | string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:62

Parameters

propertyId

string

Returns

undefined | string

---

propertyMetaGet()

propertyMetaGet(type): undefined | PropertyMetaConfig

Defined in: packages/affine/data-view/src/core/data-source/base.ts:56

Parameters

type

string

Returns

undefined | PropertyMetaConfig

---

propertyNameGet()

propertyNameGet(propertyId): string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:34

Parameters

propertyId

string

Returns

string

---

propertyNameGet$()

propertyNameGet$(propertyId): ReadonlySignal<undefined | string>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:33

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | string>

---

propertyNameSet()

propertyNameSet(propertyId, name): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:35

Parameters

propertyId

string

name

string

Returns

void

---

propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

Defined in: packages/affine/data-view/src/core/data-source/base.ts:53

Parameters

propertyId

string

Returns

boolean

---

propertyReadonlyGet$()

propertyReadonlyGet$(propertyId): ReadonlySignal<boolean>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:54

Parameters

propertyId

string

Returns

ReadonlySignal<boolean>

---

propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

Defined in: packages/affine/data-view/src/core/data-source/base.ts:40

Parameters

propertyId

string

Returns

boolean

---

propertyTypeGet()

propertyTypeGet(propertyId): undefined | string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:37

Parameters

propertyId

string

Returns

undefined | string

---

propertyTypeGet$()

propertyTypeGet$(propertyId): ReadonlySignal<undefined | string>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:38

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | string>

---

propertyTypeSet()

propertyTypeSet(propertyId, type): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:39

Parameters

propertyId

string

type

string

Returns

void

---

rowAdd()

rowAdd(InsertToPosition): string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:26

Parameters

InsertToPosition

number | InsertToPosition

Returns

string

---

rowDelete()

rowDelete(ids): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:27

Parameters

ids

string[]

Returns

void

---

rowMove()

rowMove(rowId, position): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:28

Parameters

rowId

string

position

InsertToPosition

Returns

void

---

viewDataAdd()

viewDataAdd(viewData): string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:78

Parameters

viewData

DefaultViewDataType

Returns

string

---

viewDataDelete()

viewDataDelete(viewId): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:80

Parameters

viewId

string

Returns

void

---

viewDataDuplicate()

viewDataDuplicate(id): string

Defined in: packages/affine/data-view/src/core/data-source/base.ts:79

Parameters

id

string

Returns

string

---

viewDataGet()

viewDataGet(viewId): undefined | DefaultViewDataType

Defined in: packages/affine/data-view/src/core/data-source/base.ts:75

Parameters

viewId

string

Returns

undefined | DefaultViewDataType

---

viewDataGet$()

viewDataGet$(viewId): ReadonlySignal<undefined | DefaultViewDataType>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:76

Parameters

viewId

string

Returns

ReadonlySignal<undefined | DefaultViewDataType>

---

viewDataMoveTo()

viewDataMoveTo(id, position): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:81

Parameters

id

string

position

InsertToPosition

Returns

void

---

viewDataUpdate()

viewDataUpdate<ViewData>(id, updater): void

Defined in: packages/affine/data-view/src/core/data-source/base.ts:82

Type Parameters

ViewData

ViewData extends DefaultViewDataType

Parameters

id

string

updater

(data) => Partial<ViewData>

Returns

void

---

viewMetaGet()

viewMetaGet(type): ViewMeta

Defined in: packages/affine/data-view/src/core/data-source/base.ts:87

Parameters

type

string

Returns

ViewMeta

---

viewMetaGet$()

viewMetaGet$(type): ReadonlySignal<undefined | ViewMeta>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:88

Parameters

type

string

Returns

ReadonlySignal<undefined | ViewMeta>

---

viewMetaGetById()

viewMetaGetById(viewId): undefined | ViewMeta

Defined in: packages/affine/data-view/src/core/data-source/base.ts:90

Parameters

viewId

string

Returns

undefined | ViewMeta

---

viewMetaGetById$()

viewMetaGetById$(viewId): ReadonlySignal<undefined | ViewMeta>

Defined in: packages/affine/data-view/src/core/data-source/base.ts:91

Parameters

viewId

string

Returns

ReadonlySignal<undefined | ViewMeta>