BlockSuite API Documentation / @blocksuite/affine-block-database

@blocksuite/affine-block-database

Classes

AffineLitIcon

Extends

• ShadowlessElement

Constructors

Other

name

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

protected render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

unknown

Overrides

ShadowlessElement.render

styles

styles

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Overrides

ShadowlessElement.styles

updates

---

abstract BaseCellRenderer<RawValue, JsonValue, Data>

Extends

• BaseCellRenderer_base

Extended by

• RichTextCell

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Implements

• DataViewCellLifeCycle
• CellRenderProps<Data, RawValue, JsonValue>

Constructors

Other

readonly$

readonly$: ReadonlySignal<boolean>

type

type: string | undefined

value$

value$: ReadonlySignal<RawValue | undefined>

cell

Implementation of

CellRenderProps.cell

expose

Get Signature

get expose(): this

Returns

this

isEditing$

Implementation of

CellRenderProps.isEditing$

property

Get Signature

get property(): Property<RawValue, JsonValue, Data>

Returns

Property<RawValue, JsonValue, Data>

readonly

Get Signature

get readonly(): boolean

Returns

boolean

row

Get Signature

get row(): Row

Returns

Row

selectCurrentCell()

Implementation of

CellRenderProps.selectCurrentCell

value

Get Signature

get value(): RawValue | undefined

Returns

RawValue | undefined

view

Get Signature

get view(): SingleView

Returns

SingleView

afterEnterEditingMode()

afterEnterEditingMode(): void

Returns

void

Implementation of

DataViewCellLifeCycle.afterEnterEditingMode

beforeEnterEditMode()

beforeEnterEditMode(): boolean

Returns

boolean

Implementation of

DataViewCellLifeCycle.beforeEnterEditMode

beforeExitEditingMode()

beforeExitEditingMode(): void

Returns

void

Implementation of

DataViewCellLifeCycle.beforeExitEditingMode

blurCell()

blurCell(): boolean

Returns

boolean

Implementation of

DataViewCellLifeCycle.blurCell

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

BaseCellRenderer_base.connectedCallback

focusCell()

focusCell(): boolean

Returns

boolean

Implementation of

DataViewCellLifeCycle.focusCell

forceUpdate()

forceUpdate(): void

Returns

void

Implementation of

DataViewCellLifeCycle.forceUpdate

onCopy()

onCopy(_e): void

Parameters

_e

ClipboardEvent

Returns

void

onCut()

onCut(_e): void

Parameters

_e

ClipboardEvent

Returns

void

onPaste()

onPaste(_e): void

Parameters

_e

ClipboardEvent

Returns

void

valueSetImmediate()

valueSetImmediate(value): void

Parameters

value

RawValue | undefined

Returns

void

valueSetNextTick()

valueSetNextTick(value): void

Parameters

value

RawValue | undefined

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

updates

shouldUpdate()

protected shouldUpdate(_changedProperties): boolean

Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.

Parameters

_changedProperties

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

boolean

Overrides

BaseCellRenderer_base.shouldUpdate

---

BlockRenderer

Extends

• ShadowlessElement<this> & DisposableClass<this>

Implements

• DetailSlotProps

Constructors

Other

styles

static styles: CSSResult

Overrides

WithDisposable(ShadowlessElement).styles

attributeRenderer

Get Signature

get attributeRenderer(): AttributeRenderer<AffineTextAttributes>

Returns

AttributeRenderer<AffineTextAttributes>

attributesSchema

Get Signature

get attributesSchema(): ZodType<any, ZodTypeDef, any>

Returns

ZodType<any, ZodTypeDef, any>

host

inlineManager

Get Signature

get inlineManager(): InlineManager<AffineTextAttributes>

Returns

InlineManager<AffineTextAttributes>

model

Get Signature

get model(): BlockModel<object> | undefined

Returns

BlockModel<object> | undefined

openDoc()

Implementation of

DetailSlotProps.openDoc

rowId

Implementation of

DetailSlotProps.rowId

view

Implementation of

DetailSlotProps.view

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

WithDisposable(ShadowlessElement).connectedCallback

renderIcon()

renderIcon(): TemplateResult<1> | undefined

Returns

TemplateResult<1> | undefined

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

protected render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

unknown

Overrides

WithDisposable(ShadowlessElement).render

styles

updates

---

Button

Extends

• Button_base

Constructors

Other

styles

static styles: CSSResult

Overrides

Button_base.styles

hoverType

icon

onClick

postfix

text

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

Button_base.connectedCallback

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult<1>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<1>

Overrides

Button_base.render

styles

updates

---

CellBase<RawValue, JsonValue, Data>

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Implements

• Cell<RawValue, JsonValue, Data>

Constructors

Constructor

new CellBase<RawValue, JsonValue, Data>(view, propertyId, rowId): CellBase<RawValue, JsonValue, Data>

Parameters

view

SingleView

propertyId

string

rowId

string

Returns

CellBase<RawValue, JsonValue, Data>

Properties

isEmpty$

isEmpty$: ReadonlySignal<boolean>

Implementation of

Cell.isEmpty$

jsonValue$

jsonValue$: ReadonlySignal<JsonValue | undefined>

Implementation of

Cell.jsonValue$

meta$

meta$: ReadonlySignal<PropertyMetaConfig<string, { }, unknown, unknown> | undefined>

property$

property$: ReadonlySignal<Property<RawValue, JsonValue, Data>>

propertyId

propertyId: string

Implementation of

Cell.propertyId

rowId

rowId: string

Implementation of

Cell.rowId

stringValue$

stringValue$: ReadonlySignal<string | undefined>

Implementation of

Cell.stringValue$

value$

value$: ReadonlySignal<RawValue>

Implementation of

Cell.value$

view

view: SingleView

Implementation of

Cell.view

Accessors

dataSource

Get Signature

get dataSource(): DataSource

Returns

DataSource

property

Get Signature

get property(): Property<RawValue, JsonValue, Data>

Returns

Property<RawValue, JsonValue, Data>

Implementation of

Cell.property

row

Get Signature

get row(): Row

Returns

Row

Implementation of

Cell.row

Methods

jsonValueSet()

jsonValueSet(value): void

Parameters

value

JsonValue | undefined

Returns

void

Implementation of

Cell.jsonValueSet

valueSet()

valueSet(value): void

Parameters

value

RawValue | undefined

Returns

void

Implementation of

Cell.valueSet

---

DatabaseBlockComponent

Extends

• CaptionedBlockComponent<DatabaseBlockModel>

Constructors

Other

headerWidget

headerWidget: DataViewWidget

indicator

indicator: DropIndicator

isCommentHighlighted

Get Signature

get isCommentHighlighted(): boolean

Returns

boolean

optionsConfig

Get Signature

get optionsConfig(): object

Returns

object

configure()

configure: (...args) => MenuOptions

Parameters

args

...[DatabaseBlockModel, MenuOptions, ...unknown[]]

Returns

MenuOptions

topContenteditableElement

Get Signature

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

Returns

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

Overrides

CaptionedBlockComponent.topContenteditableElement

useZeroWidth

Overrides

CaptionedBlockComponent.useZeroWidth

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

CaptionedBlockComponent.connectedCallback

createTemplate()

createTemplate(data, openDoc): TemplateResult<ResultType>

Parameters

data

rowId

string

view

SingleView

openDoc

(docId) => void

Returns

TemplateResult<ResultType>

handleMobileEditing()

handleMobileEditing(): void

Returns

void

listenFullWidthChange()

listenFullWidthChange(): void

Returns

void

onDrag()

onDrag(evt, id): () => void

Parameters

evt

MouseEvent

id

string

Returns

(): void

Returns

void

renderBlock()

renderBlock(): TemplateResult<1>

Returns

TemplateResult<1>

Overrides

CaptionedBlockComponent.renderBlock

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

updates

---

DatabaseBlockDataSource

Extends

• DataSourceBase

Constructors

Constructor

new DatabaseBlockDataSource(model, init?): DatabaseBlockDataSource

Parameters

model

DatabaseBlockModel

init?

(dataSource) => void

Returns

DatabaseBlockDataSource

Overrides

DataSourceBase.constructor

Properties

allPropertyMetas$

allPropertyMetas$: ReadonlySignal<PropertyMetaConfig<any, any, any, any>[]>

Overrides

DataSourceBase.allPropertyMetas$

featureFlags$

featureFlags$: ReadonlySignal<DatabaseFlags>

Overrides

DataSourceBase.featureFlags$

properties$

properties$: ReadonlySignal<string[]>

Overrides

DataSourceBase.properties$

propertyMetas$

propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Overrides

DataSourceBase.propertyMetas$

readonly$

readonly$: ReadonlySignal<boolean>

Overrides

DataSourceBase.readonly$

rows$

rows$: ReadonlySignal<string[]>

Overrides

DataSourceBase.rows$

spacialProperties

spacialProperties: Record<string, SpacialProperty>

viewConverts

viewConverts: ViewConvertConfig[] = databaseBlockViewConverts

Overrides

DataSourceBase.viewConverts

viewDataList$

viewDataList$: ReadonlySignal<DefaultViewDataType[]>

Overrides

DataSourceBase.viewDataList$

viewManager

viewManager: ViewManager

Overrides

DataSourceBase.viewManager

viewMetas

viewMetas: ViewMeta[] = databaseBlockViews

Overrides

DataSourceBase.viewMetas

externalProperties

static externalProperties: Signal<PropertyMetaConfig[]>

propertiesList

static propertiesList: ReadonlySignal<(PropertyMetaConfig<"created-time", { }, number | null, number | null> | PropertyMetaConfig | PropertyMetaConfig<"link", { }, string, string> | PropertyMetaConfig<"checkbox", { }, boolean, boolean> | PropertyMetaConfig<"date", { }, number | null, number | null> | PropertyMetaConfig<"multi-select", { options: object[]; }, string[], string[]> | PropertyMetaConfig<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null> | PropertyMetaConfig<"progress", { }, number, number> | PropertyMetaConfig<"select", { options: object[]; }, string | null, string | null> | PropertyMetaConfig<"image", { }, string | null, string | null> | PropertyMetaConfig<"rich-text", { }, RichTextCellType | undefined, string> | PropertyMetaConfig<"title", { }, Text<{ bold?: true | null; code?: true | null; italic?: true | null; link?: string | null; strike?: true | null; underline?: true | null; }> | undefined, string>)[]>

propertiesMap

static propertiesMap: ReadonlySignal<{[k: string]: PropertyMetaConfig; }>

Accessors

doc

Get Signature

get doc(): Store

Returns

Store

parentProvider

Get Signature

get parentProvider(): ServiceProvider

Returns

ServiceProvider

Overrides

DataSourceBase.parentProvider

Methods

cellValueChange()

cellValueChange(rowId, propertyId, value): void

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Overrides

DataSourceBase.cellValueChange

cellValueGet()

cellValueGet(rowId, propertyId): unknown

Parameters

rowId

string

propertyId

string

Returns

unknown

Overrides

DataSourceBase.cellValueGet

getNormalPropertyAndIndex()

protected getNormalPropertyAndIndex(propertyId): { column: ColumnDataType<Record<string, unknown>>; index: number; } | undefined

Parameters

propertyId

string

Returns

{ column: ColumnDataType<Record<string, unknown>>; index: number; } | undefined

Overrides

DataSourceBase.getNormalPropertyAndIndex

isSpacialProperty()

isSpacialProperty(propertyType): boolean

Parameters

propertyType

string

Returns

boolean

propertyAdd()

propertyAdd(insertToPosition, ops?): string | undefined

Parameters

insertToPosition

InsertToPosition

ops?

name?

string

type?

string

Returns

string | undefined

Overrides

DataSourceBase.propertyAdd

propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

Parameters

propertyId

string

Returns

Record<string, unknown>

Overrides

DataSourceBase.propertyDataGet

propertyDataSet()

propertyDataSet(propertyId, data): void

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

Overrides

DataSourceBase.propertyDataSet

propertyDataTypeGet()

propertyDataTypeGet(propertyId): TypeInstance | undefined

Parameters

propertyId

string

Returns

TypeInstance | undefined

Overrides

DataSourceBase.propertyDataTypeGet

propertyDelete()

propertyDelete(id): void

Parameters

id

string

Returns

void

Overrides

DataSourceBase.propertyDelete

propertyDuplicate()

propertyDuplicate(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

Overrides

DataSourceBase.propertyDuplicate

propertyMetaGet()

propertyMetaGet(type): PropertyMetaConfig | undefined

Parameters

type

string

Returns

PropertyMetaConfig | undefined

Overrides

DataSourceBase.propertyMetaGet

propertyNameGet()

propertyNameGet(propertyId): string

Parameters

propertyId

string

Returns

string

Overrides

DataSourceBase.propertyNameGet

propertyNameSet()

propertyNameSet(propertyId, name): void

Parameters

propertyId

string

name

string

Returns

void

Overrides

DataSourceBase.propertyNameSet

propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

Overrides

DataSourceBase.propertyReadonlyGet

propertyTypeGet()

propertyTypeGet(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

Overrides

DataSourceBase.propertyTypeGet

propertyTypeSet()

propertyTypeSet(propertyId, toType): void

Parameters

propertyId

string

toType

string

Returns

void

Overrides

DataSourceBase.propertyTypeSet

rowAdd()

rowAdd(insertPosition): string

Parameters

insertPosition

number | InsertToPosition

Returns

string

Overrides

DataSourceBase.rowAdd

rowDelete()

rowDelete(ids): void

Parameters

ids

string[]

Returns

void

Overrides

DataSourceBase.rowDelete

rowMove()

rowMove(rowId, position): void

Parameters

rowId

string

position

InsertToPosition

Returns

void

Overrides

DataSourceBase.rowMove

spacialValueGet()

spacialValueGet(rowId, propertyId, propertyType): unknown

Parameters

rowId

string

propertyId

string

propertyType

string

Returns

unknown

viewDataAdd()

viewDataAdd(viewData): string

Parameters

viewData

DefaultViewDataType

Returns

string

Overrides

DataSourceBase.viewDataAdd

viewDataDelete()

viewDataDelete(viewId): void

Parameters

viewId

string

Returns

void

Overrides

DataSourceBase.viewDataDelete

viewDataDuplicate()

viewDataDuplicate(id): string

Parameters

id

string

Returns

string

Overrides

DataSourceBase.viewDataDuplicate

viewDataGet()

viewDataGet(viewId): DefaultViewDataType | undefined

Parameters

viewId

string

Returns

DefaultViewDataType | undefined

Overrides

DataSourceBase.viewDataGet

viewDataMoveTo()

viewDataMoveTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

Overrides

DataSourceBase.viewDataMoveTo

viewDataUpdate()

viewDataUpdate<ViewData>(id, updater): void

Type Parameters

ViewData

ViewData extends DefaultViewDataType

Parameters

id

string

updater

(data) => Partial<ViewData>

Returns

void

Overrides

DataSourceBase.viewDataUpdate

viewMetaGet()

viewMetaGet(type): ViewMeta

Parameters

type

string

Returns

ViewMeta

Overrides

DataSourceBase.viewMetaGet

viewMetaGetById()

viewMetaGetById(viewId): ViewMeta | undefined

Parameters

viewId

string

Returns

ViewMeta | undefined

Overrides

DataSourceBase.viewMetaGetById

---

DatabaseSelection

Extends

• BaseSelection

Constructors

Constructor

new DatabaseSelection(__namedParameters): DatabaseSelection

Parameters

__namedParameters

blockId

string

viewSelection

DataViewSelection

Returns

DatabaseSelection

Overrides

BaseSelection.constructor

Properties

viewSelection

readonly viewSelection: DataViewSelection

group

static group: string = 'note'

Overrides

BaseSelection.group

type

static type: string = 'database'

Overrides

BaseSelection.type

Accessors

viewId

Get Signature

get viewId(): string

Returns

string

Methods

equals()

equals(other): boolean

Parameters

other

BaseSelection

Returns

boolean

Overrides

BaseSelection.equals

toJSON()

toJSON(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

BaseSelection.toJSON

fromJSON()

static fromJSON(json): DatabaseSelection

Parameters

json

Record<string, unknown>

Returns

DatabaseSelection

Overrides

BaseSelection.fromJSON

---

abstract DataSourceBase

Extended by

• DatabaseBlockDataSource

Implements

• DataSource

Constructors

Constructor

new DataSourceBase(): DataSourceBase

Returns

DataSourceBase

Properties

allPropertyMetas$

abstract allPropertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Implementation of

DataSource.allPropertyMetas$

container

protected container: Container

featureFlags$

abstract featureFlags$: ReadonlySignal<DatabaseFlags>

Implementation of

DataSource.featureFlags$

fixedProperties$

fixedProperties$: ReadonlySignal<string[]>

fixedPropertySet

fixedPropertySet: ReadonlySignal<Set<string>>

properties$

abstract properties$: ReadonlySignal<string[]>

Implementation of

DataSource.properties$

propertyMetas$

abstract propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Implementation of

DataSource.propertyMetas$

readonly$

abstract readonly$: ReadonlySignal<boolean>

Implementation of

DataSource.readonly$

rows$

abstract rows$: ReadonlySignal<string[]>

Implementation of

DataSource.rows$

viewConverts

abstract viewConverts: ViewConvertConfig[]

Implementation of

DataSource.viewConverts

viewDataList$

abstract viewDataList$: ReadonlySignal<DefaultViewDataType[]>

Implementation of

DataSource.viewDataList$

viewManager

abstract viewManager: ViewManager

Implementation of

DataSource.viewManager

viewMetas

abstract viewMetas: ViewMeta[]

Implementation of

DataSource.viewMetas

Accessors

parentProvider

Get Signature

get abstract parentProvider(): ServiceProvider

Returns

ServiceProvider

provider

Get Signature

get provider(): ServiceProvider

Returns

ServiceProvider

Implementation of

DataSource.provider

Methods

cellValueChange()

Call Signature

abstract cellValueChange(rowId, propertyId, value): void

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Implementation of

DataSource.cellValueChange

Call Signature

abstract cellValueChange(rowId, propertyId, value): void

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Implementation of

DataSource.cellValueChange

cellValueGet()

abstract cellValueGet(rowId, propertyId): unknown

Parameters

rowId

string

propertyId

string

Returns

unknown

Implementation of

DataSource.cellValueGet

cellValueGet$()

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

Parameters

rowId

string

propertyId

string

Returns

ReadonlySignal<unknown>

Implementation of

DataSource.cellValueGet$

getNormalPropertyAndIndex()

abstract protected getNormalPropertyAndIndex(propertyId): { column: ColumnDataType<Record<string, unknown>>; index: number; } | undefined

Parameters

propertyId

string

Returns

{ column: ColumnDataType<Record<string, unknown>>; index: number; } | undefined

isFixedProperty()

isFixedProperty(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

propertyAdd()

abstract propertyAdd(insertToPosition, ops?): string | undefined

Parameters

insertToPosition

InsertToPosition

ops?

name?

string

type?

string

Returns

string | undefined

Implementation of

DataSource.propertyAdd

propertyCanDelete()

propertyCanDelete(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

Implementation of

DataSource.propertyCanDelete

propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

Implementation of

DataSource.propertyCanDuplicate

propertyDataGet()

abstract propertyDataGet(propertyId): Record<string, unknown>

Parameters

propertyId

string

Returns

Record<string, unknown>

Implementation of

DataSource.propertyDataGet

propertyDataGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<Record<string, unknown> | undefined>

Implementation of

DataSource.propertyDataGet$

propertyDataSet()

abstract propertyDataSet(propertyId, data): void

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

Implementation of

DataSource.propertyDataSet

propertyDataTypeGet()

abstract propertyDataTypeGet(propertyId): TypeInstance | undefined

Parameters

propertyId

string

Returns

TypeInstance | undefined

Implementation of

DataSource.propertyDataTypeGet

propertyDataTypeGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<TypeInstance | undefined>

Implementation of

DataSource.propertyDataTypeGet$

propertyDelete()

abstract propertyDelete(id): void

Parameters

id

string

Returns

void

Implementation of

DataSource.propertyDelete

propertyDuplicate()

abstract propertyDuplicate(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

Implementation of

DataSource.propertyDuplicate

propertyMetaGet()

abstract propertyMetaGet(type): PropertyMetaConfig | undefined

Parameters

type

string

Returns

PropertyMetaConfig | undefined

Implementation of

DataSource.propertyMetaGet

propertyNameGet()

abstract propertyNameGet(propertyId): string

Parameters

propertyId

string

Returns

string

Implementation of

DataSource.propertyNameGet

propertyNameGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<string | undefined>

Implementation of

DataSource.propertyNameGet$

propertyNameSet()

abstract propertyNameSet(propertyId, name): void

Parameters

propertyId

string

name

string

Returns

void

Implementation of

DataSource.propertyNameSet

propertyReadonlyGet()

propertyReadonlyGet(_propertyId): boolean

Parameters

_propertyId

string

Returns

boolean

Implementation of

DataSource.propertyReadonlyGet

propertyReadonlyGet$()

propertyReadonlyGet$(propertyId): ReadonlySignal<boolean>

Parameters

propertyId

string

Returns

ReadonlySignal<boolean>

Implementation of

DataSource.propertyReadonlyGet$

propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

Implementation of

DataSource.propertyTypeCanSet

propertyTypeGet()

abstract propertyTypeGet(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

Implementation of

DataSource.propertyTypeGet

propertyTypeGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<string | undefined>

Implementation of

DataSource.propertyTypeGet$

propertyTypeSet()

abstract propertyTypeSet(propertyId, type): void

Parameters

propertyId

string

type

string

Returns

void

Implementation of

DataSource.propertyTypeSet

rowAdd()

abstract rowAdd(InsertToPosition): string

Parameters

InsertToPosition

number | InsertToPosition

Returns

string

Implementation of

DataSource.rowAdd

rowDelete()

abstract rowDelete(ids): void

Parameters

ids

string[]

Returns

void

Implementation of

DataSource.rowDelete

rowMove()

abstract rowMove(rowId, position): void

Parameters

rowId

string

position

InsertToPosition

Returns

void

Implementation of

DataSource.rowMove

serviceGet()

serviceGet<T>(key): T | null

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

Returns

T | null

Implementation of

DataSource.serviceGet

serviceGetOrCreate()

serviceGetOrCreate<T>(key, create): T

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

create

() => T

Returns

T

Implementation of

DataSource.serviceGetOrCreate

serviceSet()

serviceSet<T>(key, value): void

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

value

T

Returns

void

viewDataAdd()

abstract viewDataAdd(viewData): string

Parameters

viewData

DefaultViewDataType

Returns

string

Implementation of

DataSource.viewDataAdd

viewDataDelete()

abstract viewDataDelete(viewId): void

Parameters

viewId

string

Returns

void

Implementation of

DataSource.viewDataDelete

viewDataDuplicate()

abstract viewDataDuplicate(id): string

Parameters

id

string

Returns

string

Implementation of

DataSource.viewDataDuplicate

viewDataGet()

abstract viewDataGet(viewId): DefaultViewDataType | undefined

Parameters

viewId

string

Returns

DefaultViewDataType | undefined

Implementation of

DataSource.viewDataGet

viewDataGet$()

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

Parameters

viewId

string

Returns

ReadonlySignal<DefaultViewDataType | undefined>

Implementation of

DataSource.viewDataGet$

viewDataMoveTo()

abstract viewDataMoveTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

Implementation of

DataSource.viewDataMoveTo

viewDataUpdate()

abstract viewDataUpdate<ViewData>(id, updater): void

Type Parameters

ViewData

ViewData extends DefaultViewDataType

Parameters

id

string

updater

(data) => Partial<ViewData>

Returns

void

Implementation of

DataSource.viewDataUpdate

viewMetaGet()

abstract viewMetaGet(type): ViewMeta

Parameters

type

string

Returns

ViewMeta

Implementation of

DataSource.viewMetaGet

viewMetaGet$()

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

Parameters

type

string

Returns

ReadonlySignal<ViewMeta | undefined>

Implementation of

DataSource.viewMetaGet$

viewMetaGetById()

abstract viewMetaGetById(viewId): ViewMeta | undefined

Parameters

viewId

string

Returns

ViewMeta | undefined

Implementation of

DataSource.viewMetaGetById

viewMetaGetById$()

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

Parameters

viewId

string

Returns

ReadonlySignal<ViewMeta | undefined>

Implementation of

DataSource.viewMetaGetById$

---

abstract DataViewBase<Selection>

Extends

• DataViewBase_base

Type Parameters

Selection

Selection extends DataViewSelection = DataViewSelection

Constructors

Other

expose

abstract expose: DataViewInstance

props

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

updates

---

DataViewRootUILogic

Constructors

Constructor

new DataViewRootUILogic(config): DataViewRootUILogic

Parameters

config

DataViewRendererConfig

Returns

DataViewRootUILogic

Properties

config

readonly config: DataViewRendererConfig

currentView$

readonly currentView$: ReadonlySignal<DataViewUILogicBase<SingleView, DataViewSelection> | undefined>

currentViewId$

readonly currentViewId$: ReadonlySignal<string | undefined>

focusFirstCell()

focusFirstCell: () => void

Returns

void

openDetailPanel()

openDetailPanel: (ops) => void

Parameters

ops

onClose?

() => void

rowId

string

view

SingleView

Returns

void

Accessors

dataViewRenderer

Get Signature

get dataViewRenderer(): DataViewRootUI | undefined

Returns

DataViewRootUI | undefined

selection$

Get Signature

get selection$(): ReadonlySignal<DataViewSelection | undefined>

Returns

ReadonlySignal<DataViewSelection | undefined>

Methods

render()

render(): TemplateResult<ResultType>

Returns

TemplateResult<ResultType>

setSelection()

setSelection(selection?): void

Parameters

selection?

DataViewSelection

Returns

void

setupViewChangeListener()

setupViewChangeListener(): () => void

Returns

(): void

Returns

void

---

abstract DataViewUIBase<Logic>

Extends

• DataViewUIBase_base

Type Parameters

Logic

Logic extends DataViewUILogicBase = DataViewUILogicBase

Constructors

Other

logic

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

updates

---

abstract DataViewUILogicBase<T, Selection>

Type Parameters

T

T extends SingleView = SingleView

Selection

Selection extends DataViewSelection = DataViewSelection

Constructors

Constructor

new DataViewUILogicBase<T, Selection>(root, view): DataViewUILogicBase<T, Selection>

Parameters

root

DataViewRootUILogic

view

T

Returns

DataViewUILogicBase<T, Selection>

Properties

addRow()

abstract addRow: (position) => string | undefined

Parameters

position

InsertToPosition

Returns

string | undefined

clearSelection()

abstract clearSelection: () => void

Returns

void

eventTrace

eventTrace: EventTraceFn<DatabaseAllViewEvents>

focusFirstCell()

abstract focusFirstCell: () => void

Returns

void

hideIndicator()

abstract hideIndicator: () => void

Returns

void

moveTo()

abstract moveTo: (id, evt) => void

Parameters

id

string

evt

MouseEvent

Returns

void

renderer

abstract renderer: UniComponent<{ logic: DataViewUILogicBase<T, Selection>; }>

root

readonly root: DataViewRootUILogic

selection$

selection$: ReadonlySignal<Selection | undefined>

showIndicator()

abstract showIndicator: (evt) => boolean

Parameters

evt

MouseEvent

Returns

boolean

view

readonly view: T

Accessors

headerWidget

Get Signature

get headerWidget(): DataViewWidget | undefined

Returns

DataViewWidget | undefined

Methods

bindHotkey()

bindHotkey(hotkeys): DisposableMember

Parameters

hotkeys

Record<string, UIEventHandler>

Returns

DisposableMember

handleEvent()

handleEvent(name, handler): DisposableMember

Parameters

name

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

handler

UIEventHandler

Returns

DisposableMember

setSelection()

setSelection(selection?): void

Parameters

selection?

Selection

Returns

void

---

Group<RawValue, JsonValue, Data>

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Constructors

Constructor

new Group<RawValue, JsonValue, Data>(key, value, groupInfo, manager): Group<RawValue, JsonValue, Data>

Parameters

key

string

value

JsonValue

groupInfo

GroupInfo<RawValue, JsonValue, Data>

manager

GroupTrait

Returns

Group<RawValue, JsonValue, Data>

Properties

hide$

hide$: ReadonlySignal<boolean>

key

readonly key: string

manager

readonly manager: GroupTrait

name$

name$: ReadonlySignal<string>

rows

rows: Row[]

value

readonly value: JsonValue

Accessors

property

Get Signature

get property(): Property<RawValue, JsonValue, Data>

Returns

Property<RawValue, JsonValue, Data>

tType

Get Signature

get tType(): TypeInstance

Returns

TypeInstance

view

Get Signature

get view(): UniComponent<GroupRenderProps<unknown, { }>, { }>

Returns

UniComponent<GroupRenderProps<unknown, { }>, { }>

Methods

hideSet()

hideSet(hide): void

Parameters

hide

boolean

Returns

void

---

GroupByService

Constructors

Constructor

new GroupByService(dataSource): GroupByService

Parameters

dataSource

DataSource

Returns

GroupByService

Accessors

matcher

Get Signature

get matcher(): Matcher_<GroupByConfig, TypeInstance>

Returns

Matcher_<GroupByConfig, TypeInstance>

Methods

allExternalGroupByConfig()

allExternalGroupByConfig(): GroupByConfig[]

Returns

GroupByConfig[]

---

GroupTrait

Constructors

Constructor

new GroupTrait(groupBy$, view, ops): GroupTrait

Synchronize sortAsc$ with the GroupBy sort descriptor

Parameters

groupBy$

ReadonlySignal<GroupBy | undefined>

view

SingleView

ops

changeGroupHide?

(key, hide) => void

changeGroupSort

(keys) => void

changeRowSort

(groupKeys, groupKey, keys) => void

groupBySet

(g) => void

sortGroup

(keys, asc?) => string[]

sortRow

(groupKey, rows) => Row[]

Returns

GroupTrait

Properties

allHidden$

allHidden$: ReadonlySignal<boolean>

Whether all groups are currently hidden

groupDataMap$

groupDataMap$: ReadonlySignal<Record<string, Group<unknown, unknown, Record<string, unknown>>> | undefined>

groupInfo$

groupInfo$: ReadonlySignal<GroupInfo<unknown, unknown, Record<string, unknown>> | undefined>

groupProperties$

groupProperties$: ReadonlySignal<GroupProperty[]>

groupPropertiesMap$

groupPropertiesMap$: ReadonlySignal<Record<string, GroupProperty>>

groupsDataList$

groupsDataList$: ReadonlySignal<Group<unknown, unknown, Record<string, unknown>>[] | undefined>

groupsDataListAll$

groupsDataListAll$: ReadonlySignal<Group<unknown, unknown, Record<string, unknown>>[] | undefined>

Computed list of groups including hidden ones, used by settings UI.

hideEmpty$

hideEmpty$: Signal<boolean>

property$

property$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>> | undefined>

sortAsc$

sortAsc$: Signal<boolean>

staticInfo$

staticInfo$: ReadonlySignal<{ groupInfo: GroupInfo<unknown, unknown, Record<string, unknown>>; staticMap: {[k: string]: Group<unknown, unknown, Record<string, unknown>>; }; } | undefined>

updateData()

updateData: (data) => void

Parameters

data

Returns

void

view

view: SingleView

Accessors

addGroup

Get Signature

get addGroup(): (config) => object | undefined

Returns

(config) => object | undefined

Methods

addToGroup()

addToGroup(rowId, key): void

Parameters

rowId

string

key

string

Returns

void

changeGroup()

changeGroup(columnId): void

Parameters

columnId

string | undefined

Returns

void

changeGroupMode()

changeGroupMode(modeName): void

Parameters

modeName

string

Returns

void

changeGroupSort()

changeGroupSort(keys): void

Parameters

keys

string[]

Returns

void

isGroupHidden()

isGroupHidden(key): boolean

Parameters

key

string

Returns

boolean

moveCardTo()

moveCardTo(rowId, fromGroupKey, toGroupKey, position): void

Parameters

rowId

string

fromGroupKey

string | undefined

toGroupKey

string

position

InsertToPosition

Returns

void

moveGroupTo()

moveGroupTo(groupKey, position): void

Parameters

groupKey

string

position

InsertToPosition

Returns

void

removeFromGroup()

removeFromGroup(rowId, key): void

Parameters

rowId

string

key

string

Returns

void

setDateSortOrder()

setDateSortOrder(asc): void

Set sort order for date groupings and update GroupBy sort descriptor.

Parameters

asc

boolean

Returns

void

setGroupHide()

setGroupHide(key, hide): void

Parameters

key

string

hide

boolean

Returns

void

setHideEmpty()

setHideEmpty(value): void

Toggle hiding of empty groups.

Parameters

value

boolean

Returns

void

updateValue()

updateValue(rows, value): void

Parameters

rows

string[]

value

unknown

Returns

void

---

MultiTagSelect

Extends

• MultiTagSelect_base

Constructors

Other

sortContext

sortContext: SortContext

initialDraftText

mode

onChange()

onComplete()

onOptionsChange()

options

value

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

MultiTagSelect_base.connectedCallback

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult<ResultType>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<ResultType>

Overrides

MultiTagSelect_base.render

styles

updates

firstUpdated()

protected firstUpdated(): void

Invoked when the element is first updated. Implement to perform one time work on the element after update.

firstUpdated() {
  this.renderRoot.getElementById('my-text-area').focus();
}

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Returns

void

Overrides

MultiTagSelect_base.firstUpdated

---

MultiTagView

Extends

• MultiTagView_base

Constructors

Other

styles

static styles: CSSResult

Overrides

MultiTagView_base.styles

options

selectContainer

value

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult<ResultType>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<ResultType>

Overrides

MultiTagView_base.render

styles

updates

---

NoteRenderer

Extends

• ShadowlessElement<this> & DisposableClass<this>

Implements

• DetailSlotProps

Constructors

Other

allowCreateDoc$

allowCreateDoc$: ReadonlySignal<boolean>

rowText$

rowText$: ReadonlySignal<Text<{ bold?: true | null; code?: true | null; italic?: true | null; link?: string | null; strike?: true | null; underline?: true | null; }> | undefined>

styles

static styles: CSSResult

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).styles

databaseBlock

Get Signature

get databaseBlock(): DatabaseBlockModel

Returns

DatabaseBlockModel

host

model

openDoc()

Implementation of

DetailSlotProps.openDoc

rowId

Implementation of

DetailSlotProps.rowId

view

Implementation of

DetailSlotProps.view

addNote()

addNote(): void

Returns

void

renderNote()

renderNote(): TemplateResult<1> | undefined

Returns

TemplateResult<1> | undefined

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

protected render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

unknown

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).render

styles

updates

---

Overflow

Extends

• Overflow_base

Constructors

Other

frameId

protected frameId: number | undefined

widthList

protected widthList: number[]

styles

static styles: CSSResult

Overrides

Overflow_base.styles

items

more

renderCount

renderItem

renderMore()

adjustStyle()

adjustStyle(): void

Returns

void

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

Overflow_base.connectedCallback

doAdjustStyle()

protected doAdjustStyle(): void

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult<1>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<1>

Overrides

Overflow_base.render

styles

updates

updated()

protected updated(_changedProperties): void

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters

_changedProperties

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Overrides

Overflow_base.updated

---

abstract PropertyBase<RawValue, JsonValue, Data>

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Implements

• Property<RawValue, JsonValue, Data>

Constructors

Constructor

new PropertyBase<RawValue, JsonValue, Data>(view, propertyId): PropertyBase<RawValue, JsonValue, Data>

Parameters

view

SingleView

propertyId

string

Returns

PropertyBase<RawValue, JsonValue, Data>

Properties

cells$

cells$: ReadonlySignal<Cell<unknown, unknown, Record<string, unknown>>[]>

Implementation of

Property.cells$

data$

data$: ReadonlySignal<Data>

Implementation of

Property.data$

dataType$

dataType$: ReadonlySignal<TypeInstance | undefined>

Implementation of

Property.dataType$

hide$

abstract hide$: ReadonlySignal<boolean>

Implementation of

Property.hide$

index$

index$: ReadonlySignal<number | undefined>

Implementation of

Property.index$

isFirst$

isFirst$: ReadonlySignal<boolean>

Implementation of

Property.isFirst$

isLast$

isLast$: ReadonlySignal<boolean>

Implementation of

Property.isLast$

meta$

meta$: ReadonlySignal<PropertyMetaConfig | undefined>

Implementation of

Property.meta$

name$

name$: ReadonlySignal<string>

Implementation of

Property.name$

next$

next$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>> | undefined>

Implementation of

Property.next$

prev$

prev$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>> | undefined>

Implementation of

Property.prev$

propertyId

propertyId: string

readonly$

readonly$: ReadonlySignal<boolean>

Implementation of

Property.readonly$

renderer$

renderer$: ReadonlySignal<CellRenderer<{ }, unknown, unknown> | undefined>

Implementation of

Property.renderer$

type$

type$: ReadonlySignal<string>

Implementation of

Property.type$

view

view: SingleView

Implementation of

Property.view

Accessors

canDelete

Get Signature

get canDelete(): boolean

Returns

boolean

Implementation of

Property.canDelete

canDuplicate

Get Signature

get canDuplicate(): boolean

Returns

boolean

Implementation of

Property.canDuplicate

dataSource

Get Signature

get protected dataSource(): DataSource

Returns

DataSource

delete

Get Signature

get delete(): () => void | undefined

Returns

() => void | undefined

Implementation of

Property.delete

duplicate

Get Signature

get duplicate(): () => void | undefined

Returns

() => void | undefined

Implementation of

Property.duplicate

hideCanSet

Get Signature

get hideCanSet(): boolean

Returns

boolean

Implementation of

Property.hideCanSet

icon

Get Signature

get icon(): UniComponent | undefined

Returns

UniComponent | undefined

Implementation of

Property.icon

id

Get Signature

get id(): string

Returns

string

Implementation of

Property.id

typeCanSet

Get Signature

get typeCanSet(): boolean

Returns

boolean

Implementation of

Property.typeCanSet

typeSet

Get Signature

get typeSet(): (type) => void | undefined

Returns

(type) => void | undefined

Implementation of

Property.typeSet

Methods

cellGetOrCreate()

cellGetOrCreate(rowId): Cell<RawValue, JsonValue, Data>

Parameters

rowId

string

Returns

Cell<RawValue, JsonValue, Data>

Implementation of

Property.cellGetOrCreate

dataUpdate()

dataUpdate(updater): void

Parameters

updater

PropertyDataUpdater<Data>

Returns

void

Implementation of

Property.dataUpdate

hideSet()

abstract hideSet(hide): void

Parameters

hide

boolean

Returns

void

Implementation of

Property.hideSet

move()

abstract move(position): void

Parameters

position

InsertToPosition

Returns

void

Implementation of

Property.move

nameSet()

nameSet(name): void

Parameters

name

string

Returns

void

Implementation of

Property.nameSet

parseValueFromString()

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

Parameters

value

string

Returns

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

Implementation of

Property.parseValueFromString

stringValueGet()

stringValueGet(rowId): string | undefined

Parameters

rowId

string

Returns

string | undefined

Implementation of

Property.stringValueGet

valueGet()

valueGet(rowId): RawValue | undefined

Parameters

rowId

string

Returns

RawValue | undefined

Implementation of

Property.valueGet

valueSet()

valueSet(rowId, value): void

Parameters

rowId

string

value

RawValue | undefined

Returns

void

Implementation of

Property.valueSet

valueSetFromString()

valueSetFromString(rowId, value): void

Parameters

rowId

string

value

string

Returns

void

Implementation of

Property.valueSetFromString

---

RecordDetail

Extends

• RecordDetail_base

Constructors

Other

_clickAddProperty()

_clickAddProperty: () => void

Returns

void

properties$

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

row$

row$: ReadonlySignal<Row>

selection

selection: DetailSelection

styles

static styles: CSSResult

Overrides

RecordDetail_base.styles

addPropertyButton

detailSlots

openDoc()

rowId

view

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

RecordDetail_base.connectedCallback

hasNext()

hasNext(): boolean

Returns

boolean

hasPrev()

hasPrev(): boolean

Returns

boolean

nextRow()

nextRow(): void

Returns

void

prevRow()

prevRow(): void

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult<ResultType>

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult<ResultType>

Overrides

RecordDetail_base.render

styles

updates

---

RichTextCell

Extends

• BaseCellRenderer<Text, string>

Constructors

Other

inlineEditor$

inlineEditor$: ReadonlySignal<AffineInlineEditor | null | undefined>

host

Get Signature

get host(): EditorHost | null

Returns

EditorHost | null

inlineManager

Get Signature

get inlineManager(): InlineManager<AffineTextAttributes> | undefined

Returns

InlineManager<AffineTextAttributes> | undefined

topContenteditableElement

Get Signature

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

Returns

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

afterEnterEditingMode()

afterEnterEditingMode(): void

Returns

void

Overrides

BaseCellRenderer.afterEnterEditingMode

beforeEnterEditMode()

beforeEnterEditMode(): boolean

Returns

boolean

Overrides

BaseCellRenderer.beforeEnterEditMode

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

BaseCellRenderer.connectedCallback

insertDelta()

insertDelta(delta): void

Parameters

delta

DeltaInsert<AffineTextAttributes>

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult

Overrides

BaseCellRenderer.render

styles

updates

---

RowBase

Implements

• Row

Constructors

Constructor

new RowBase(singleView, rowId): RowBase

Parameters

singleView

SingleView

rowId

string

Returns

RowBase

Properties

cells$

cells$: ReadonlySignal<CellBase<unknown, unknown, Record<string, unknown>>[]>

Implementation of

Row.cells$

index$

index$: ReadonlySignal<number | undefined>

Implementation of

Row.index$

next$

next$: ReadonlySignal<Row | undefined>

Implementation of

Row.next$

prev$

prev$: ReadonlySignal<Row | undefined>

Implementation of

Row.prev$

rowId

readonly rowId: string

Implementation of

Row.rowId

singleView

readonly singleView: SingleView

Accessors

dataSource

Get Signature

get dataSource(): DataSource

Returns

DataSource

Methods

delete()

delete(): void

Returns

void

Implementation of

Row.delete

move()

move(position): void

Parameters

position

InsertToPosition

Returns

void

Implementation of

Row.move

---

abstract SingleViewBase<ViewData>

Type Parameters

ViewData

ViewData extends DataViewDataType = DataViewDataType

Implements

• SingleView

Constructors

Constructor

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

Parameters

manager

ViewManager

id

string

Returns

SingleViewBase<ViewData>

Properties

data$

data$: ReadonlySignal<ViewData | undefined>

Implementation of

SingleView.data$

detailProperties$

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

Implementation of

SingleView.detailProperties$

id

id: string

Implementation of

SingleView.id

isLocked$

isLocked$: ReadonlySignal<boolean>

Implementation of

SingleView.isLocked$

lockRows$

protected lockRows$: Signal<boolean>

mainProperties$

abstract mainProperties$: ReadonlySignal<MainProperties>

Implementation of

SingleView.mainProperties$

manager

manager: ViewManager

Implementation of

SingleView.manager

name$

name$: ReadonlySignal<string>

Implementation of

SingleView.name$

properties$

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

Implementation of

SingleView.properties$

propertiesRaw$

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

Implementation of

SingleView.propertiesRaw$

propertyIds$

propertyIds$: ReadonlySignal<string[]>

Implementation of

SingleView.propertyIds$

propertyMap$

propertyMap$: ReadonlySignal<Record<string, Property<unknown, unknown, Record<string, unknown>>>>

Implementation of

SingleView.propertyMap$

readonly$

abstract readonly$: ReadonlySignal<boolean>

Implementation of

SingleView.readonly$

rowIds$

rowIds$: ReadonlySignal<string[]>

Implementation of

SingleView.rowIds$

rows$

rows$: ReadonlySignal<Row[]>

Implementation of

SingleView.rows$

rowsRaw$

rowsRaw$: ReadonlySignal<Row[]>

Implementation of

SingleView.rowsRaw$

vars$

vars$: ReadonlySignal<object[]>

Implementation of

SingleView.vars$

Accessors

dataSource

Get Signature

get protected dataSource(): DataSource

Returns

DataSource

featureFlags$

Get Signature

get featureFlags$(): ReadonlySignal<DatabaseFlags>

Returns

ReadonlySignal<DatabaseFlags>

Implementation of

SingleView.featureFlags$

isLocked

Get Signature

get isLocked(): boolean

Returns

boolean

meta

Get Signature

get meta(): ViewMeta

Returns

ViewMeta

Implementation of

SingleView.meta

propertyMetas$

Get Signature

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

Returns

ReadonlySignal<PropertyMetaConfig[]>

Implementation of

SingleView.propertyMetas$

type

Get Signature

get abstract type(): string

Returns

string

Implementation of

SingleView.type

Methods

cellGetOrCreate()

cellGetOrCreate(rowId, propertyId): Cell

Parameters

rowId

string

propertyId

string

Returns

Cell

Implementation of

SingleView.cellGetOrCreate

dataUpdate()

dataUpdate(updater): void

Parameters

updater

(viewData) => Partial<ViewData>

Returns

void

delete()

delete(): void

Returns

void

Implementation of

SingleView.delete

duplicate()

duplicate(): void

Returns

void

Implementation of

SingleView.duplicate

isShow()

abstract isShow(rowId): boolean

Parameters

rowId

string

Returns

boolean

lockRows()

lockRows(lock): void

Parameters

lock

boolean

Returns

void

Implementation of

SingleView.lockRows

nameSet()

nameSet(name): void

Parameters

name

string

Returns

void

Implementation of

SingleView.nameSet

propertyAdd()

propertyAdd(position, ops?): string | undefined

Parameters

position

InsertToPosition

ops?

name?

string

type?

string

Returns

string | undefined

Implementation of

SingleView.propertyAdd

propertyGetOrCreate()

abstract propertyGetOrCreate(propertyId): Property

Parameters

propertyId

string

Returns

Property

Implementation of

SingleView.propertyGetOrCreate

rowAdd()

rowAdd(insertPosition): string

Parameters

insertPosition

number | InsertToPosition

Returns

string

Implementation of

SingleView.rowAdd

rowGetOrCreate()

rowGetOrCreate(rowId): Row

Parameters

rowId

string

Returns

Row

Implementation of

SingleView.rowGetOrCreate

rowsDelete()

rowsDelete(rows): void

Parameters

rows

string[]

Returns

void

Implementation of

SingleView.rowsDelete

rowsMapping()

protected rowsMapping(rows): Row[]

Parameters

rows

Row[]

Returns

Row[]

serviceGet()

serviceGet<T>(key): T | null

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

Returns

T | null

Implementation of

SingleView.serviceGet

serviceGetOrCreate()

serviceGetOrCreate<T>(key, create): T

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

create

() => T

Returns

T

Implementation of

SingleView.serviceGetOrCreate

setSearch()

setSearch(str): void

Parameters

str

string

Returns

void

traitGet()

traitGet<T>(key): T | undefined

Type Parameters

T

T

Parameters

key

TraitKey<T>

Returns

T | undefined

Implementation of

SingleView.traitGet

traitSet()

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

Type Parameters

T

T

Parameters

key

TraitKey<T>

value

T

Returns

T

---

TypeSystem

Constructors

Constructor

new TypeSystem(converts): TypeSystem

Parameters

converts

TypeConvertConfig[]

Returns

TypeSystem

Properties

convertMapFromTo

convertMapFromTo: Map<string, Map<string, { convert: (value) => unknown; from: TypeInstance; level: number; to: TypeInstance; }>>

convertMapToFrom

convertMapToFrom: Map<string, Map<string, { convert: (value) => unknown; from: TypeInstance; level: number; to: TypeInstance; }>>

unify()

unify: <T>(left, right) => left is T

Type Parameters

T

T extends TypeInstance

Parameters

left

TypeInstance | undefined

right

T | undefined

Returns

left is T

Methods

instanceFn()

instanceFn(template, realArgs, realRt, ctx): void | FnTypeInstance<readonly TypeInstance[], TypeInstance>

Parameters

template

FnTypeInstance

realArgs

TypeInstance[]

realRt

TypeInstance

ctx

TypeVarContext

Returns

void | FnTypeInstance<readonly TypeInstance[], TypeInstance>

---

UniAnyRender<T, Expose>

Extends

• UniAnyRender_base

Type Parameters

T

T

Expose

Expose extends NonNullable<unknown>

Constructors

Other

expose

props

renderTemplate()

attributes

controllers

dev-mode

lifecycle

properties

rendering

render()

render(): TemplateResult

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

TemplateResult

Overrides

UniAnyRender_base.render

styles

updates

---

UniLit<Props, Expose>

Extends

• ShadowlessElement

Type Parameters

Props

Props

Expose

Expose extends NonNullable<unknown> = NonNullable<unknown>

Constructors

Other

uniReturn?

optional uniReturn: UniComponentReturn<Props>

expose

Get Signature

get expose(): Expose | undefined

Returns

Expose | undefined

props

ref

uni

connectedCallback()

connectedCallback(): void

Invoked when the component is added to the document's DOM.

In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

connectedCallback() {
  super.connectedCallback();
  addEventListener('keydown', this._handleKeydown);
}

Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

Returns

void

Overrides

ShadowlessElement.connectedCallback

disconnectedCallback()

disconnectedCallback(): void

Invoked when the component is removed from the document's DOM.

This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Returns

void

Overrides

ShadowlessElement.disconnectedCallback

attributes

controllers

dev-mode

properties

rendering

render()

protected render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

unknown

Overrides

ShadowlessElement.render

styles

styles

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Overrides

ShadowlessElement.styles

updates

updated()

protected updated(_changedProperties): void

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters

_changedProperties

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Overrides

ShadowlessElement.updated

---

ViewManagerBase

Implements

• ViewManager

Constructors

Constructor

new ViewManagerBase(dataSource): ViewManagerBase

Parameters

dataSource

DataSource

Returns

ViewManagerBase

Properties

_currentViewId$

_currentViewId$: Signal<string | undefined>

currentView$

currentView$: ReadonlySignal<SingleView | undefined>

Implementation of

ViewManager.currentView$

currentViewId$

currentViewId$: ReadonlySignal<string | undefined>

Implementation of

ViewManager.currentViewId$

dataSource

dataSource: DataSource

Implementation of

ViewManager.dataSource

readonly$

readonly$: ReadonlySignal<boolean>

Implementation of

ViewManager.readonly$

views$

views$: ReadonlySignal<string[]>

Implementation of

ViewManager.views$

Accessors

viewMetas

Get Signature

get viewMetas(): ViewMeta[]

Returns

ViewMeta[]

Implementation of

ViewManager.viewMetas

Methods

moveTo()

moveTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

Implementation of

ViewManager.moveTo

setCurrentView()

setCurrentView(id): void

Parameters

id

string | undefined

Returns

void

Implementation of

ViewManager.setCurrentView

viewAdd()

viewAdd(type): string

Parameters

type

string

Returns

string

Implementation of

ViewManager.viewAdd

viewChangeType()

viewChangeType(id, type): void

Parameters

id

string

type

string

Returns

void

Implementation of

ViewManager.viewChangeType

viewDataGet()

viewDataGet(id): DefaultViewDataType | undefined

Parameters

id

string

Returns

DefaultViewDataType | undefined

Implementation of

ViewManager.viewDataGet

viewDelete()

viewDelete(id): void

Parameters

id

string

Returns

void

Implementation of

ViewManager.viewDelete

viewDuplicate()

viewDuplicate(id): void

Parameters

id

string

Returns

void

Implementation of

ViewManager.viewDuplicate

viewGet()

viewGet(id): SingleView | undefined

Parameters

id

string

Returns

SingleView | undefined

Implementation of

ViewManager.viewGet

Interfaces

Cell<RawValue, JsonValue, Data>

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Properties

isEmpty$

readonly isEmpty$: ReadonlySignal<boolean>

jsonValue$

readonly jsonValue$: ReadonlySignal<JsonValue | undefined>

property

readonly property: Property<RawValue, JsonValue, Data>

propertyId

readonly propertyId: string

row

readonly row: Row

rowId

readonly rowId: string

stringValue$

readonly stringValue$: ReadonlySignal<string | undefined>

value$

readonly value$: ReadonlySignal<RawValue | undefined>

view

readonly view: SingleView

Methods

jsonValueSet()

jsonValueSet(value): void

Parameters

value

JsonValue | undefined

Returns

void

valueSet()

valueSet(value): void

Parameters

value

RawValue | undefined

Returns

void

---

CellRenderProps<Data, RawValue, JsonValue>

Type Parameters

Data

Data extends NonNullable<unknown> = NonNullable<unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

cell

cell: Cell<RawValue, JsonValue, Data>

isEditing$

isEditing$: ReadonlySignal<boolean>

selectCurrentCell()

selectCurrentCell: (editing) => void

Parameters

editing

boolean

Returns

void

---

DatabaseBlockConfigService

Properties

propertiesPresets

propertiesPresets: PropertyMetaConfig[]

---

DatabaseFlags

Properties

enable_table_virtual_scroll

enable_table_virtual_scroll: boolean

---

DataSource

Properties

allPropertyMetas$

allPropertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

featureFlags$

featureFlags$: ReadonlySignal<DatabaseFlags>

properties$

properties$: ReadonlySignal<string[]>

propertyMetas$

propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

provider

provider: ServiceProvider

readonly$

readonly$: ReadonlySignal<boolean>

rows$

rows$: ReadonlySignal<string[]>

viewConverts

viewConverts: ViewConvertConfig[]

viewDataList$

viewDataList$: ReadonlySignal<DefaultViewDataType[]>

viewManager

viewManager: ViewManager

viewMetas

viewMetas: ViewMeta[]

Methods

cellValueChange()

cellValueChange(rowId, propertyId, value): void

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

cellValueGet()

cellValueGet(rowId, propertyId): unknown

Parameters

rowId

string

propertyId

string

Returns

unknown

cellValueGet$()

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

Parameters

rowId

string

propertyId

string

Returns

ReadonlySignal<unknown>

propertyAdd()

propertyAdd(insertToPosition, ops?): string | undefined

Parameters

insertToPosition

InsertToPosition

ops?

name?

string

type?

string

Returns

string | undefined

propertyCanDelete()

propertyCanDelete(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

Parameters

propertyId

string

Returns

Record<string, unknown>

propertyDataGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<Record<string, unknown> | undefined>

propertyDataSet()

propertyDataSet(propertyId, data): void

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

propertyDataTypeGet()

propertyDataTypeGet(propertyId): TypeInstance | undefined

Parameters

propertyId

string

Returns

TypeInstance | undefined

propertyDataTypeGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<TypeInstance | undefined>

propertyDelete()

propertyDelete(id): void

Parameters

id

string

Returns

void

propertyDuplicate()

propertyDuplicate(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

propertyMetaGet()

propertyMetaGet(type): PropertyMetaConfig | undefined

Parameters

type

string

Returns

PropertyMetaConfig | undefined

propertyNameGet()

propertyNameGet(propertyId): string

Parameters

propertyId

string

Returns

string

propertyNameGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<string | undefined>

propertyNameSet()

propertyNameSet(propertyId, name): void

Parameters

propertyId

string

name

string

Returns

void

propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

propertyReadonlyGet$()

propertyReadonlyGet$(propertyId): ReadonlySignal<boolean>

Parameters

propertyId

string

Returns

ReadonlySignal<boolean>

propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

Parameters

propertyId

string

Returns

boolean

propertyTypeGet()

propertyTypeGet(propertyId): string | undefined

Parameters

propertyId

string

Returns

string | undefined

propertyTypeGet$()

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

Parameters

propertyId

string

Returns

ReadonlySignal<string | undefined>

propertyTypeSet()

propertyTypeSet(propertyId, type): void

Parameters

propertyId

string

type

string

Returns

void

rowAdd()

rowAdd(InsertToPosition): string

Parameters

InsertToPosition

number | InsertToPosition

Returns

string

rowDelete()

rowDelete(ids): void

Parameters

ids

string[]

Returns

void

rowMove()

rowMove(rowId, position): void

Parameters

rowId

string

position

InsertToPosition

Returns

void

serviceGet()

serviceGet<T>(key): T | null

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

Returns

T | null

serviceGetOrCreate()

serviceGetOrCreate<T>(key, create): T

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

create

() => T

Returns

T

viewDataAdd()

viewDataAdd(viewData): string

Parameters

viewData

DefaultViewDataType

Returns

string

viewDataDelete()

viewDataDelete(viewId): void

Parameters

viewId

string

Returns

void

viewDataDuplicate()

viewDataDuplicate(id): string

Parameters

id

string

Returns

string

viewDataGet()

viewDataGet(viewId): DefaultViewDataType | undefined

Parameters

viewId

string

Returns

DefaultViewDataType | undefined

viewDataGet$()

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

Parameters

viewId

string

Returns

ReadonlySignal<DefaultViewDataType | undefined>

viewDataMoveTo()

viewDataMoveTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

viewDataUpdate()

viewDataUpdate<ViewData>(id, updater): void

Type Parameters

ViewData

ViewData extends DefaultViewDataType

Parameters

id

string

updater

(data) => Partial<ViewData>

Returns

void

viewMetaGet()

viewMetaGet(type): ViewMeta

Parameters

type

string

Returns

ViewMeta

viewMetaGet$()

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

Parameters

type

string

Returns

ReadonlySignal<ViewMeta | undefined>

viewMetaGetById()

viewMetaGetById(viewId): ViewMeta | undefined

Parameters

viewId

string

Returns

ViewMeta | undefined

viewMetaGetById$()

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

Parameters

viewId

string

Returns

ReadonlySignal<ViewMeta | undefined>

---

DataViewCellLifeCycle

Methods

afterEnterEditingMode()

afterEnterEditingMode(): void

Returns

void

beforeEnterEditMode()

beforeEnterEditMode(): boolean

Returns

boolean

beforeExitEditingMode()

beforeExitEditingMode(): void

Returns

void

blurCell()

blurCell(): boolean

Returns

boolean

focusCell()

focusCell(): boolean

Returns

boolean

forceUpdate()

forceUpdate(): void

Returns

void

---

DataViewInstance<T>

Type Parameters

T

T extends SingleView = SingleView

Properties

eventTrace

eventTrace: EventTraceFn<DatabaseAllViewEvents>

view

view: T

Methods

addRow()?

optional addRow(position): void

Parameters

position

number | InsertToPosition

Returns

void

clearSelection()

clearSelection(): void

Returns

void

focusFirstCell()

focusFirstCell(): void

Returns

void

getSelection()?

optional getSelection(): DataViewSelection | undefined

Returns

DataViewSelection | undefined

hideIndicator()?

optional hideIndicator(): void

Returns

void

moveTo()?

optional moveTo(id, evt): void

Parameters

id

string

evt

MouseEvent

Returns

void

showIndicator()?

optional showIndicator(evt): boolean

Parameters

evt

MouseEvent

Returns

boolean

---

DataViewModelConfig<Data>

Type Parameters

Data

Data extends DataViewDataType = DataViewDataType

Properties

dataViewManager()

dataViewManager: (viewManager, viewId) => SingleView

Parameters

viewManager

ViewManager

viewId

string

Returns

SingleView

defaultData()

defaultData: (viewManager) => Omit<Data, "id" | "name" | "mode">

Parameters

viewManager

ViewManager

Returns

Omit<Data, "id" | "name" | "mode">

defaultName

defaultName: string

---

DataViewProps<Selection>

Type Parameters

Selection

Selection extends DataViewSelection = DataViewSelection

Properties

bindHotkey()

bindHotkey: (hotkeys) => Disposable

Parameters

hotkeys

Record<string, UIEventHandler>

Returns

Disposable

eventTrace

eventTrace: EventTraceFn<DatabaseAllViewEvents>

handleEvent()

handleEvent: (name, handler) => Disposable

Parameters

name

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

handler

UIEventHandler

Returns

Disposable

headerWidget?

optional headerWidget: DataViewWidget

selection$

selection$: ReadonlySignal<Selection | undefined>

setSelection()

setSelection: (selection?) => void

Parameters

selection?

Selection

Returns

void

---

DataViewRendererConfig

Properties

icon

icon: UniComponent

mobileLogic()?

optional mobileLogic: (view) => DataViewUILogicBaseConstructor

Parameters

view

SingleView

Returns

DataViewUILogicBaseConstructor

mobileView?

optional mobileView: DataViewComponent

pcLogic()

pcLogic: (view) => DataViewUILogicBaseConstructor

Parameters

view

SingleView

Returns

DataViewUILogicBaseConstructor

---

DetailSlots

Properties

header?

optional header: UniComponent<DetailSlotProps>

note?

optional note: UniComponent<DetailSlotProps>

---

GroupRenderProps<JsonValue, Data>

Type Parameters

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Properties

group

group: Group<unknown, JsonValue, Data>

readonly

readonly: boolean

---

Property<RawValue, JsonValue, Data>

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Properties

cells$

readonly cells$: ReadonlySignal<Cell<unknown, unknown, Record<string, unknown>>[]>

data$

readonly data$: ReadonlySignal<Data>

dataType$

readonly dataType$: ReadonlySignal<TypeInstance | undefined>

delete()?

readonly optional delete: () => void

Returns

void

duplicate()?

readonly optional duplicate: () => void

Returns

void

hide$

readonly hide$: ReadonlySignal<boolean>

icon?

readonly optional icon: UniComponent

id

readonly id: string

index$

readonly index$: ReadonlySignal<number | undefined>

isFirst$

readonly isFirst$: ReadonlySignal<boolean>

isLast$

readonly isLast$: ReadonlySignal<boolean>

meta$

readonly meta$: ReadonlySignal<PropertyMetaConfig | undefined>

name$

readonly name$: ReadonlySignal<string>

next$

readonly next$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>> | undefined>

prev$

readonly prev$: ReadonlySignal<Property<unknown, unknown, Record<string, unknown>> | undefined>

readonly$

readonly readonly$: ReadonlySignal<boolean>

renderer$

readonly renderer$: ReadonlySignal<CellRenderer | undefined>

type$

readonly type$: ReadonlySignal<string>

typeSet()?

readonly optional typeSet: (type) => void

Parameters

type

string

Returns

void

view

readonly view: SingleView

Accessors

canDelete

Get Signature

get canDelete(): boolean

Returns

boolean

canDuplicate

Get Signature

get canDuplicate(): boolean

Returns

boolean

hideCanSet

Get Signature

get hideCanSet(): boolean

Returns

boolean

typeCanSet

Get Signature

get typeCanSet(): boolean

Returns

boolean

Methods

cellGetOrCreate()

cellGetOrCreate(rowId): Cell<RawValue, JsonValue, Data>

Parameters

rowId

string

Returns

Cell<RawValue, JsonValue, Data>

dataUpdate()

dataUpdate(updater): void

Parameters

updater

PropertyDataUpdater<Data>

Returns

void

hideSet()

hideSet(hide): void

Parameters

hide

boolean

Returns

void

move()

move(position): void

Parameters

position

InsertToPosition

Returns

void

nameSet()

nameSet(name): void

Parameters

name

string

Returns

void

parseValueFromString()

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

Parameters

value

string

Returns

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

stringValueGet()

stringValueGet(rowId): string | undefined

Parameters

rowId

string

Returns

string | undefined

valueGet()

valueGet(rowId): RawValue | undefined

Parameters

rowId

string

Returns

RawValue | undefined

valueSet()

valueSet(rowId, value): void

Parameters

rowId

string

value

RawValue | undefined

Returns

void

valueSetFromString()

valueSetFromString(rowId, value): void

Parameters

rowId

string

value

string

Returns

void

---

Renderer<Data, RawValue, JsonValue>

Type Parameters

Data

Data extends NonNullable<unknown> = NonNullable<unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

cellRenderer

cellRenderer: CellRenderer<Data, RawValue, JsonValue>

icon?

optional icon: UniComponent

type

type: string

---

Row

Properties

cells$

readonly cells$: ReadonlySignal<Cell<unknown, unknown, Record<string, unknown>>[]>

index$

index$: ReadonlySignal<number | undefined>

next$

next$: ReadonlySignal<Row | undefined>

prev$

prev$: ReadonlySignal<Row | undefined>

rowId

readonly rowId: string

Methods

delete()

delete(): void

Returns

void

move()

move(position): void

Parameters

position

InsertToPosition

Returns

void

---

SingleView

Properties

data$

data$: any

detailProperties$

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

featureFlags$

readonly featureFlags$: ReadonlySignal<DatabaseFlags>

id

readonly id: string

isLocked$

isLocked$: ReadonlySignal<boolean>

mainProperties$

mainProperties$: ReadonlySignal<MainProperties>

manager

readonly manager: ViewManager

meta

readonly meta: ViewMeta

name$

readonly name$: ReadonlySignal<string>

properties$

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

propertiesRaw$

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

propertyIds$

readonly propertyIds$: ReadonlySignal<string[]>

propertyMap$

readonly propertyMap$: ReadonlySignal<Record<string, Property<unknown, unknown, Record<string, unknown>>>>

propertyMetas$

readonly propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

readonly$

readonly readonly$: ReadonlySignal<boolean>

rowIds$

readonly rowIds$: ReadonlySignal<string[]>

rows$

readonly rows$: ReadonlySignal<Row[]>

rowsRaw$

readonly rowsRaw$: ReadonlySignal<Row[]>

type

readonly type: string

vars$

readonly vars$: ReadonlySignal<Variable[]>

Methods

cellGetOrCreate()

cellGetOrCreate(rowId, propertyId): Cell

Parameters

rowId

string

propertyId

string

Returns

Cell

delete()

delete(): void

Returns

void

duplicate()

duplicate(): void

Returns

void

lockRows()

lockRows(lock): void

Parameters

lock

boolean

Returns

void

nameSet()

nameSet(name): void

Parameters

name

string

Returns

void

propertyAdd()

propertyAdd(toAfterOfProperty, ops?): string | undefined

Parameters

toAfterOfProperty

InsertToPosition

ops?

name?

string

type?

string

Returns

string | undefined

propertyGetOrCreate()

propertyGetOrCreate(propertyId): Property

Parameters

propertyId

string

Returns

Property

rowAdd()

rowAdd(insertPosition): string

Parameters

insertPosition

InsertToPosition

Returns

string

rowGetOrCreate()

rowGetOrCreate(rowId): Row

Parameters

rowId

string

Returns

Row

rowsDelete()

rowsDelete(rows): void

Parameters

rows

string[]

Returns

void

serviceGet()

serviceGet<T>(key): T | null

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

Returns

T | null

serviceGetOrCreate()

serviceGetOrCreate<T>(key, create): T

Type Parameters

T

T

Parameters

key

GeneralServiceIdentifier<T>

create

() => T

Returns

T

traitGet()

traitGet<T>(key): T | undefined

Type Parameters

T

T

Parameters

key

TraitKey<T>

Returns

T | undefined

---

TypeDefinition

Methods

is()

is(typeInstance): boolean

Parameters

typeInstance

AnyTypeInstance

Returns

boolean

---

TypeInstance

Extends

• AnyTypeInstance

Properties

_validate

readonly _validate: ZodType

_valueType

readonly _valueType: any

Methods

subst()

subst(ctx): void | TypeInstance

Parameters

ctx

TypeVarContext

Returns

void | TypeInstance

unify()

unify(ctx, type, unify): boolean

Parameters

ctx

TypeVarContext

type

TypeInstance

unify

Unify

Returns

boolean

valueValidate()

valueValidate(value): value is any

Parameters

value

unknown

Returns

value is any

---

ViewManager

Properties

currentView$

currentView$: ReadonlySignal<SingleView | undefined>

currentViewId$

currentViewId$: ReadonlySignal<string | undefined>

dataSource

dataSource: DataSource

readonly$

readonly$: ReadonlySignal<boolean>

viewMetas

viewMetas: ViewMeta[]

views$

views$: ReadonlySignal<string[]>

Methods

moveTo()

moveTo(id, position): void

Parameters

id

string

position

InsertToPosition

Returns

void

setCurrentView()

setCurrentView(id): void

Parameters

id

string

Returns

void

viewAdd()

viewAdd(type): string

Parameters

type

string

Returns

string

viewChangeType()

viewChangeType(id, type): void

Parameters

id

string

type

string

Returns

void

viewDataGet()

viewDataGet(id): DefaultViewDataType | undefined

Parameters

id

string

Returns

DefaultViewDataType | undefined

viewDelete()

viewDelete(id): void

Parameters

id

string

Returns

void

viewDuplicate()

viewDuplicate(id): void

Parameters

id

string

Returns

void

viewGet()

viewGet(id): SingleView | undefined

Parameters

id

string

Returns

SingleView | undefined

Type Aliases

AnyTypeInstance

AnyTypeInstance = object

Extended by

• TypeInstance

Properties

name

readonly name: string

---

BasicViewDataType<Type, T>

BasicViewDataType<Type, T> = object & T

Type Declaration

id

id: string

mode

mode: Type

name

name: string

Type Parameters

Type

Type extends string = string

T

T = NonNullable<unknown>

---

CellRenderer<Data, RawValue, JsonValue>

CellRenderer<Data, RawValue, JsonValue> = object

Type Parameters

Data

Data extends NonNullable<unknown> = NonNullable<unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

view

view: DataViewCellComponent<Data, RawValue, JsonValue>

---

ConvertFunction()<From, To>

ConvertFunction<From, To> = (property, cells) => object

Type Parameters

From

From extends PropertyModel = PropertyModel

To

To extends PropertyModel = PropertyModel

Parameters

property

GetPropertyDataFromConfig<From["config"]>

cells

(GetRawValueFromConfig<From["config"]> | undefined)[]

Returns

object

cells

cells: (GetRawValueFromConfig<To["config"]> | undefined)[]

property

property: GetPropertyDataFromConfig<To["config"]>

---

DataViewCellComponent<Data, RawValue, JsonValue>

DataViewCellComponent<Data, RawValue, JsonValue> = UniComponent<CellRenderProps<Data, RawValue, JsonValue>, DataViewCellLifeCycle>

Type Parameters

Data

Data extends NonNullable<unknown> = NonNullable<unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

---

DataViewDataType

DataViewDataType = DefaultViewDataType

---

DataViewMode

DataViewMode = string

---

DataViewModel<Type, Data>

DataViewModel<Type, Data> = object

Type Parameters

Type

Type extends string = DataViewMode

Data

Data extends DataViewDataType = DataViewDataType

Properties

model

model: DataViewModelConfig<Data>

type

type: Type

---

DataViewSelection

DataViewSelection = TableViewSelectionWithType | KanbanViewSelectionWithType

---

DataViewSelectionState

DataViewSelectionState = DataViewSelection | undefined

---

DataViewUILogicBaseConstructor

DataViewUILogicBaseConstructor = Constructor<typeof DataViewUILogicBase>

---

DataViewWidget

DataViewWidget = UniComponent<DataViewWidgetProps>

---

DataViewWidgetProps<ViewLogic>

DataViewWidgetProps<ViewLogic> = object

Type Parameters

ViewLogic

ViewLogic extends DataViewUILogicBase = DataViewUILogicBase

Properties

dataViewLogic

dataViewLogic: ViewLogic

---

DefaultViewDataType

DefaultViewDataType = BasicViewDataType & object

Type Declaration

mode

mode: string

---

DetailSlotProps

DetailSlotProps = object

Properties

openDoc()

openDoc: (docId) => void

Parameters

docId

string

Returns

void

rowId

rowId: string

view

view: SingleView

---

DVJSON

DVJSON = null | number | string | boolean | DVJSON[] | {[k: string]: DVJSON; }

---

Filter

Filter = SingleFilter | FilterGroup

---

FilterGroup

FilterGroup = object

Properties

conditions

conditions: Filter[]

op

op: "and" | "or"

type

type: "group"

---

GetDataFromDataViewModel<Model>

GetDataFromDataViewModel<Model> = Model extends DataViewModel<infer _, infer R> ? R : never

Type Parameters

Model

Model

---

GetJsonValueFromConfig<T>

GetJsonValueFromConfig<T> = T extends PropertyConfig<any, any, infer R> ? R : never

Type Parameters

T

T

---

GetPropertyDataFromConfig<T>

GetPropertyDataFromConfig<T> = T extends PropertyConfig<infer R, any, any> ? R : never

Type Parameters

T

T

---

GetRawValueFromConfig<T>

GetRawValueFromConfig<T> = T extends PropertyConfig<any, infer R, any> ? R : never

Type Parameters

T

T

---

GroupBy

GroupBy = object

Properties

columnId

columnId: string

hideEmpty?

optional hideEmpty: boolean

name

name: string

sort?

optional sort: object

desc

desc: boolean

type

type: "groupBy"

---

GroupByConfig<Data, MatchType, GroupValue>

GroupByConfig<Data, MatchType, GroupValue> = object

Type Parameters

Data

Data extends NonNullable<unknown> = NonNullable<unknown>

MatchType

MatchType extends TypeInstance = TypeInstance

GroupValue

GroupValue = unknown

Properties

addToGroup

addToGroup: AddToGroup<GroupValue, MatchType> | false

defaultKeys()

defaultKeys: (type) => object[]

Parameters

type

MatchType

Returns

object[]

groupName()

groupName: (type, value) => string

Parameters

type

MatchType

value

GroupValue | null

Returns

string

matchType

matchType: MatchType

name

name: string

removeFromGroup()?

optional removeFromGroup: (value, oldValue) => ValueTypeOf<MatchType> | null

Parameters

value

GroupValue | null

oldValue

ValueTypeOf<MatchType> | null

Returns

ValueTypeOf<MatchType> | null

valuesGroup()

valuesGroup: (value, type) => object[]

Parameters

value

ValueTypeOf<MatchType> | null

type

MatchType

Returns

object[]

view

view: UniComponent<GroupRenderProps<GroupValue | null, Data>>

---

GroupInfo<RawValue, JsonValue, Data>

GroupInfo<RawValue, JsonValue, Data> = object

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Properties

config

config: GroupByConfig

property

property: Property<RawValue, JsonValue, Data>

tType

tType: TypeInstance

---

GroupProperty

GroupProperty = object

Properties

hide?

optional hide: boolean

key

key: string

manuallyCardSort

manuallyCardSort: string[]

---

MainProperties

MainProperties = object

Properties

iconColumn?

optional iconColumn: string

imageColumn?

optional imageColumn: string

titleColumn?

optional titleColumn: string

---

PropertyConfig<Data, RawValue, JsonValue>

PropertyConfig<Data, RawValue, JsonValue> = object

Type Parameters

Data

Data

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

addGroup()?

optional addGroup: (config) => Data

Parameters

config

WithCommonPropertyConfig<{ oldData: Data; text: string; }>

Returns

Data

fixed?

optional fixed: object

defaultData

defaultData: Data

defaultOrder?

optional defaultOrder: "start" | "end"

defaultShow?

optional defaultShow: boolean

hide?

optional hide: boolean

jsonValue

jsonValue: object

isEmpty()

isEmpty: (config) => boolean

Parameters

config

WithCommonPropertyConfig<{ value: JsonValue; }>

Returns

boolean

schema

schema: ZodType<JsonValue>

type()

type: (config) => TypeInstance

Parameters

config

WithCommonPropertyConfig<{ data: Data; }>

Returns

TypeInstance

kanbanGroup?

optional kanbanGroup: object

enabled

enabled: boolean

mutable?

optional mutable: boolean

minWidth?

optional minWidth: number

name

name: string

propertyData

propertyData: object

default()

default: () => Data

Returns

Data

schema

schema: ZodType<Data>

rawValue

rawValue: object

default()

default: () => RawValue

Returns

RawValue

fromJson()?

optional fromJson: (config) => RawValue | undefined

Parameters

config

WithCommonPropertyConfig<{ data: Data; value: JsonValue; }>

Returns

RawValue | undefined

fromString()

fromString: (config) => object

Parameters

config

WithCommonPropertyConfig<{ data: Data; value: string; }>

Returns

object

data?

optional data: Record<string, unknown>

value

value: unknown

onUpdate()?

optional onUpdate: (config) => Disposable

Parameters

config

WithCommonPropertyConfig<{ callback: () => void; data: Data; value: RawValue; }>

Returns

Disposable

schema

schema: ZodType<RawValue>

setValue()?

optional setValue: (config) => void

Parameters

config

WithCommonPropertyConfig<{ data: Data; newValue: RawValue; setValue: (value) => void; value: RawValue; }>

Returns

void

toJson()

toJson: (config) => JsonValue

Parameters

config

WithCommonPropertyConfig<{ data: Data; value: RawValue; }>

Returns

JsonValue

toString()

toString: (config) => string

Parameters

config

data

Data

value

RawValue

Returns

string

---

PropertyDataUpdater()<Data>

PropertyDataUpdater<Data> = (data) => Partial<Data>

Type Parameters

Data

Data extends Record<string, unknown> = Record<string, unknown>

Parameters

data

Data

Returns

Partial<Data>

---

PropertyMetaConfig<Type, PropertyData, RawValue, JsonValue>

PropertyMetaConfig<Type, PropertyData, RawValue, JsonValue> = object

Type Parameters

Type

Type extends string = string

PropertyData

PropertyData extends NonNullable<unknown> = NonNullable<unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

config

config: PropertyConfig<PropertyData, RawValue, JsonValue>

create

create: Create<PropertyData>

renderer

renderer: Renderer<PropertyData, RawValue, JsonValue>

type

type: Type

---

PropertyModel<Type, PropertyData, RawValue, JsonValue>

PropertyModel<Type, PropertyData, RawValue, JsonValue> = object

Type Parameters

Type

Type extends string = string

PropertyData

PropertyData extends Record<string, unknown> = Record<string, unknown>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Properties

config

config: PropertyConfig<PropertyData, RawValue, JsonValue>

create

create: Create<PropertyData>

createPropertyMeta

createPropertyMeta: CreatePropertyMeta<Type, PropertyData, RawValue, JsonValue>

type

type: Type

---

SelectOptionColor

SelectOptionColor = object

Properties

color

color: string

name

name: string

oldColor

oldColor: string

---

SelectTag

SelectTag = Zod.TypeOf<typeof SelectTagSchema>

---

SingleFilter

SingleFilter = object

Properties

args

args: Value[]

function?

optional function: string

left

left: VariableRef

type

type: "filter"

---

TagManagerOptions

TagManagerOptions = object

Properties

initialDraftText?

optional initialDraftText: string

mode?

optional mode: "single" | "multi"

onChange()

onChange: (value) => void

Parameters

value

string[]

Returns

void

onComplete()?

optional onComplete: () => void

Returns

void

onOptionsChange()

onOptionsChange: (options) => void

Parameters

options

SelectTag[]

Returns

void

options

options: ReadonlySignal<SelectTag[]>

value

value: ReadonlySignal<string[]>

---

TagSelectOptions

TagSelectOptions = object & TagManagerOptions

Type Declaration

container?

optional container: HTMLElement

minWidth?

optional minWidth: number

name

name: string

---

TypeConvertConfig<From, To>

TypeConvertConfig<From, To> = object

Type Parameters

From

From extends TypeInstance = TypeInstance

To

To extends TypeInstance = TypeInstance

Properties

convert()

convert: (value) => ValueTypeOf<To>

Parameters

value

ValueTypeOf<From>

Returns

ValueTypeOf<To>

from

from: From

to

to: To

---

Unify()

Unify = (ctx, type, expect) => boolean

Parameters

ctx

TypeVarContext

type

TypeInstance | undefined

expect

TypeInstance | undefined

Returns

boolean

---

UserInfo

UserInfo = Zod.TypeOf<typeof UserInfoSchema>

---

ValueTypeOf<T>

ValueTypeOf<T> = T extends TypeInstance ? T["_valueType"] : never

Type Parameters

T

T

---

ViewConvertConfig

ViewConvertConfig = object

Properties

convert

convert: ViewConvertFunction

from

from: string

to

to: string

---

ViewConvertFunction()<From, To>

ViewConvertFunction<From, To> = (data) => Partial<GetDataFromDataViewModel<To>>

Type Parameters

From

From extends DataViewModel = DataViewModel

To

To extends DataViewModel = DataViewModel

Parameters

data

GetDataFromDataViewModel<From>

Returns

Partial<GetDataFromDataViewModel<To>>

---

ViewMeta<Type, Data>

ViewMeta<Type, Data> = DataViewModel<Type, Data> & object

Type Declaration

renderer

renderer: DataViewRendererConfig

Type Parameters

Type

Type extends string = DataViewMode

Data

Data extends DataViewDataType = DataViewDataType

---

WithCommonPropertyConfig<T>

WithCommonPropertyConfig<T> = T & object

Type Declaration

dataSource

dataSource: DataSource

Type Parameters

T

T = { }

Variables

converts

const converts: TypeConvertConfig[]

---

createFromBaseCellRenderer()

const createFromBaseCellRenderer: <RawValue, JsonValue, Data>(renderer) => DataViewCellComponent

Type Parameters

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Data

Data extends Record<string, unknown> = Record<string, unknown>

Parameters

renderer

() => BaseCellRenderer<RawValue, JsonValue, Data>

Returns

DataViewCellComponent

---

createGroupByConfig()

const createGroupByConfig: <Data, MatchType, GroupValue>(config) => GroupByConfig

Type Parameters

Data

Data extends Record<string, unknown>

MatchType

MatchType extends TypeInstance

GroupValue

GroupValue = unknown

Parameters

config

GroupByConfig<Data, MatchType, GroupValue>

Returns

GroupByConfig

---

createGroupByMatcher()

const createGroupByMatcher: (list) => Matcher_<GroupByConfig, TypeInstance>

Parameters

list

GroupByConfig[]

Returns

Matcher_<GroupByConfig, TypeInstance>

---

createIcon()

const createIcon: (name) => UniComponent

Parameters

name

keyof typeof icons

Returns

UniComponent

---

createPropertyConvert()

const createPropertyConvert: <From, To>(from, to, convert) => object

Type Parameters

From

From extends PropertyModel<any, any, any, any>

To

To extends PropertyModel<any, any, any, any>

Parameters

from

From

to

To

convert

ConvertFunction<From, To>

Returns

object

convert

convert: ConvertFunction<From, To>

from

from: any

to

to: any

---

createRecordDetail()

const createRecordDetail: (ops) => TemplateResult

Parameters

ops

detail

DetailSlots

openDoc

(docId) => void

rowId

string

view

SingleView

Returns

TemplateResult

---

createUniComponentFromWebComponent()

const createUniComponentFromWebComponent: <T, Expose>(component) => UniComponent<T, Expose>

Type Parameters

T

T

Expose

Expose extends NonNullable<unknown> = NonNullable<unknown>

Parameters

component

typeof LitElement

Returns

UniComponent<T, Expose>

---

createViewConvert()

const createViewConvert: <From, To>(from, to, convert) => ViewConvertConfig

Type Parameters

From

From extends DataViewModel

To

To extends DataViewModel

Parameters

from

From

to

To

convert

ViewConvertFunction<From, To>

Returns

ViewConvertConfig

---

DATABASE_CONVERT_WHITE_LIST

const DATABASE_CONVERT_WHITE_LIST: string[]

---

DatabaseBlockConfigService

DatabaseBlockConfigService: ServiceIdentifier<DatabaseBlockConfigService> & <U>(variant) => ServiceIdentifier<U>

---

DatabaseBlockHtmlAdapterExtension

const DatabaseBlockHtmlAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockHtmlAdapterMatcher>

---

databaseBlockHtmlAdapterMatcher

const databaseBlockHtmlAdapterMatcher: BlockHtmlAdapterMatcher

---

DatabaseBlockMarkdownAdapterExtension

const DatabaseBlockMarkdownAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockMarkdownAdapterMatcher>

---

databaseBlockMarkdownAdapterMatcher

const databaseBlockMarkdownAdapterMatcher: BlockMarkdownAdapterMatcher

---

DatabaseBlockNotionHtmlAdapterExtension

const DatabaseBlockNotionHtmlAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockNotionHtmlAdapterMatcher>

---

databaseBlockNotionHtmlAdapterMatcher

const databaseBlockNotionHtmlAdapterMatcher: BlockNotionHtmlAdapterMatcher

---

DatabaseBlockPlainTextAdapterExtension

const DatabaseBlockPlainTextAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockPlainTextAdapterMatcher>

---

databaseBlockPlainTextAdapterMatcher

const databaseBlockPlainTextAdapterMatcher: BlockPlainTextAdapterMatcher

---

databaseBlockProperties

const databaseBlockProperties: object

Type Declaration

checkboxColumnConfig

checkboxColumnConfig: PropertyMetaConfig<"checkbox", { }, boolean, boolean> = checkboxPropertyConfig

createdTimeColumnConfig

createdTimeColumnConfig: PropertyMetaConfig<"created-time", { }, number | null, number | null>

dateColumnConfig

dateColumnConfig: PropertyMetaConfig<"date", { }, number | null, number | null> = datePropertyConfig

imageColumnConfig

imageColumnConfig: PropertyMetaConfig<"image", { }, string | null, string | null> = propertyPresets.imagePropertyConfig

linkColumnConfig

linkColumnConfig: PropertyMetaConfig<"link", { }, string, string>

multiSelectColumnConfig

multiSelectColumnConfig: PropertyMetaConfig<"multi-select", { options: object[]; }, string[], string[]> = multiSelectPropertyConfig

numberColumnConfig

numberColumnConfig: PropertyMetaConfig<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null> = numberPropertyConfig

progressColumnConfig

progressColumnConfig: PropertyMetaConfig<"progress", { }, number, number> = progressPropertyConfig

richTextColumnConfig

richTextColumnConfig: PropertyMetaConfig<"rich-text", { }, RichTextCellType | undefined, string>

selectColumnConfig

selectColumnConfig: PropertyMetaConfig<"select", { options: object[]; }, string | null, string | null> = selectPropertyConfig

titleColumnConfig

titleColumnConfig: PropertyMetaConfig<"title", { }, Text<{ bold?: true | null; code?: true | null; italic?: true | null; link?: string | null; strike?: true | null; underline?: true | null; }> | undefined, string>

---

DatabaseConfigExtension

const DatabaseConfigExtension: ConfigFactory<{ configure: (...args) => MenuOptions; }>

---

databasePropertyConverts

const databasePropertyConverts: ({ convert: ConvertFunction<PropertyModel<"multi-select", { options: object[]; }, string[], string[]>, PropertyModel<"select", { options: object[]; }, string | null, string | null>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null>, PropertyModel<"progress", { }, number, number>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"progress", { }, number, number>, PropertyModel<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"select", { options: object[]; }, string | null, string | null>, PropertyModel<"multi-select", { options: object[]; }, string[], string[]>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>, PropertyModel<"select", { options: object[]; }, string | null, string | null>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>, PropertyModel<"multi-select", { options: object[]; }, string[], string[]>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>, PropertyModel<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>, PropertyModel<"progress", { }, number, number>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>, PropertyModel<"checkbox", { }, boolean, boolean>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"checkbox", { }, boolean, boolean>, PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"multi-select", { options: object[]; }, string[], string[]>, PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"number", { decimal?: number; format: "number" | "numberWithCommas" | "percent" | "currencyYen" | "currencyINR" | "currencyCNY" | "currencyUSD" | "currencyEUR" | "currencyGBP"; }, number | null, number | null>, PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"progress", { }, number, number>, PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>>; from: any; to: any; } | { convert: ConvertFunction<PropertyModel<"select", { options: object[]; }, string | null, string | null>, PropertyModel<"rich-text", { }, RichTextCellType | undefined, string>>; from: any; to: any; })[]

---

DatabaseSelectionExtension

const DatabaseSelectionExtension: ExtensionType

---

DataSourceScope

const DataSourceScope: ServiceScope

---

dataViewCommonStyle()

const dataViewCommonStyle: (selector) => string

Parameters

selector

string

Returns

string

---

dataViewCssVariable()

const dataViewCssVariable: () => string

Returns

string

---

defaultGroupBy()

const defaultGroupBy: (dataSource, propertyMeta, propertyId, data) => GroupBy | undefined

Parameters

dataSource

DataSource

propertyMeta

PropertyMetaConfig

propertyId

string

data

NonNullable<unknown>

Returns

GroupBy | undefined

---

defineUniComponent()

const defineUniComponent: <T, Expose>(renderTemplate) => UniComponent<T, Expose>

Type Parameters

T

T

Expose

Expose extends NonNullable<unknown>

Parameters

renderTemplate

(props, expose) => TemplateResult

Returns

UniComponent<T, Expose>

---

dt

const dt: object

Type Declaration

boolean

boolean: DataType

date

date: DataType

image

image: DataType

number

number: DataType

richText

richText: DataType

string

string: DataType

tag

tag: DataType

url

url: DataType

user

user: DataType

---

EditorHostKey

const EditorHostKey: ServiceIdentifier<EditorHost> & <U>(variant) => ServiceIdentifier<U>

---

emptyFilterGroup

const emptyFilterGroup: FilterGroup

---

evalFilter()

const evalFilter: (filterGroup, row) => boolean

Parameters

filterGroup

Filter

row

Record<string, unknown>

Returns

boolean

---

ExternalGroupByConfigProvider

const ExternalGroupByConfigProvider: ServiceIdentifier & <U>(variant) => ServiceIdentifier

---

findGroupByConfigByName()

const findGroupByConfigByName: (dataSource, name) => GroupByConfig | undefined

Parameters

dataSource

DataSource

name

string

Returns

GroupByConfig | undefined

---

firstFilter()

const firstFilter: (vars) => SingleFilter

Parameters

vars

Variable[]

Returns

SingleFilter

---

firstFilterByRef()

const firstFilterByRef: (vars, ref) => SingleFilter

Parameters

vars

Variable[]

ref

VariableRef

Returns

SingleFilter

---

firstFilterInGroup()

const firstFilterInGroup: (vars) => FilterGroup

Parameters

vars

Variable[]

Returns

FilterGroup

---

firstFilterName()

const firstFilterName: (vars, ref) => string | undefined

Parameters

vars

Variable[]

ref

VariableRef

Returns

string | undefined

---

getColorByColor()

const getColorByColor: (color) => string

Parameters

color

string

Returns

string

---

getGroupByService()

const getGroupByService: (dataSource) => GroupByService

Parameters

dataSource

DataSource

Returns

GroupByService

---

getTagColor()

const getTagColor: () => string

Returns

string

---

groupByMatchers

const groupByMatchers: GroupByConfig[]

---

GroupByProvider

const GroupByProvider: ServiceIdentifier & <U>(variant) => ServiceIdentifier

---

groupTraitKey

const groupTraitKey: TraitKey

---

insertDatabaseBlockCommand

const insertDatabaseBlockCommand: Command<{ place?: "after" | "before"; removeEmptyLine?: boolean; selectedModels?: BlockModel[]; viewType: string; }, { insertedDatabaseBlockId: string; }>

---

lazy()

const lazy: <T>(fn) => object

Type Parameters

T

T

Parameters

fn

() => T

Returns

object

value

value: T

---

popCreateFilter()

const popCreateFilter: (target, props, ops?) => void

Parameters

target

PopupTarget

props

onBack?

() => void

onClose?

() => void

onSelect

(filter) => void

vars

ReadonlySignal<Variable[]>

ops?

middleware?

Middleware[]

Returns

void

---

popTagSelect()

const popTagSelect: (target, ops) => () => void

Parameters

target

PopupTarget

ops

TagSelectOptions

Returns

(): void

Returns

void

---

propertyType()

const propertyType: <Type>(type) => object

Type Parameters

Type

Type extends string

Parameters

type

Type

Returns

object

modelConfig()

modelConfig: <PropertyData, RawValue, JsonValue>(ops) => PropertyModel<Type, PropertyData, RawValue, JsonValue>

Type Parameters

PropertyData

PropertyData extends Record<string, unknown> = Record<string, never>

RawValue

RawValue = unknown

JsonValue

JsonValue = unknown

Parameters

ops

PropertyConfig<PropertyData, RawValue, JsonValue>

Returns

PropertyModel<Type, PropertyData, RawValue, JsonValue>

type

type: Type

---

renderUniLit()

const renderUniLit: <Props, Expose>(uni, props?, options?) => TemplateResult

Type Parameters

Props

Props

Expose

Expose extends NonNullable<unknown>

Parameters

uni

UniComponent<Props, Expose> | undefined

props?

Props

options?

class?

string

ref?

Signal<Expose | undefined>

style?

Readonly<StyleInfo>

Returns

TemplateResult

---

richTextColumnConfig

const richTextColumnConfig: PropertyMetaConfig<"rich-text", { }, RichTextCellType | undefined, string>

---

selectOptionColors

const selectOptionColors: SelectOptionColor[]

---

SelectTagSchema

const SelectTagSchema: zod.ZodObject<{ color: zod.ZodString; id: zod.ZodString; value: zod.ZodString; }, "strip", zod.ZodTypeAny, { color: string; id: string; value: string; }, { color: string; id: string; value: string; }>

---

sortByManually()

const sortByManually: <T>(arr, getId, ids) => T[]

Type Parameters

T

T

Parameters

arr

T[]

getId

(v) => string

ids

string[]

Returns

T[]

---

t

const t: object

Type Declaration

array

array: object

array.instance()

array.instance: <Element>(element) => ArrayTypeInstance

Type Parameters

Element

Element extends TypeInstance

Parameters

element

Element

Returns

ArrayTypeInstance

array.is()

array.is: (type) => type is ArrayTypeInstance

Parameters

type

AnyTypeInstance

Returns

type is ArrayTypeInstance

boolean

boolean: DataType

date

date: DataType

fn

fn: object

fn.instance()

fn.instance: <Args, Return>(args, rt, vars?) => FnTypeInstance

Type Parameters

Args

Args extends readonly TypeInstance[]

Return

Return extends TypeInstance

Parameters

args

Args

rt

Return

vars?

TypeVarDefinitionInstance[]

Returns

FnTypeInstance

fn.is()

fn.is: (type) => type is FnTypeInstance

Parameters

type

AnyTypeInstance

Returns

type is FnTypeInstance

image

image: DataType

number

number: DataType

richText

richText: DataType

string

string: DataType

tag

tag: DataType

typeVarDefine

typeVarDefine: object

typeVarDefine.create()

typeVarDefine.create: <Name, Type>(name, typeConstraint?) => TypeVarDefinitionInstance

Type Parameters

Name

Name extends string = string

Type

Type extends TypeInstance = TypeInstance

Parameters

name

Name

typeConstraint?

Type

Returns

TypeVarDefinitionInstance

typeVarReference

typeVarReference: object

typeVarReference.create()

typeVarReference.create: <Name>(name) => TypeVarReferenceInstance

Type Parameters

Name

Name extends string

Parameters

name

Name

Returns

TypeVarReferenceInstance

typeVarReference.is()

typeVarReference.is: (type) => type is TypeVarReferenceInstance

Parameters

type

TypeInstance

Returns

type is TypeVarReferenceInstance

unknown

unknown: DataType

url

url: DataType

user

user: DataType

---

typeSystem

const typeSystem: TypeSystem

---

ungroups

const ungroups: object

Type Declaration

key

key: string

value

value: null

---

uniMap()

const uniMap: <T, R, P>(component, map) => UniComponent<R, P>

Type Parameters

T

T

R

R

P

P extends NonNullable<unknown>

Parameters

component

UniComponent<T, P>

map

(r) => T

Returns

UniComponent<R, P>

---

unknown

const unknown: DataType

---

UserInfoSchema

const UserInfoSchema: zod.ZodObject<{ userListService: zod.ZodType<UserListService, zod.ZodTypeDef, UserListService>; userService: zod.ZodType<UserService, zod.ZodTypeDef, UserService>; }, "strip", zod.ZodTypeAny, { userListService: UserListService; userService: UserService; }, { userListService: UserListService; userService: UserService; }>

---

viewType()

const viewType: <Type>(type) => object

Type Parameters

Type

Type extends string

Parameters

type

Type

Returns

object

createModel()

createModel: <Data>(model) => DataViewModel<Type, Data> & object

Type Parameters

Data

Data extends DataViewDataType

Parameters

model

DataViewModelConfig<Data>

Returns

DataViewModel<Type, Data> & object

type

type: Type

Functions

addProperty()

addProperty(model, position, column): string

Parameters

model

DatabaseBlockModel

position

InsertToPosition

column

Omit<ColumnDataType<Record<string, unknown>>, "id"> & object

Returns

string

---

consumeTagDraftFromTableCellHost()

consumeTagDraftFromTableCellHost(fromElement): string | undefined

Parameters

fromElement

Element

Returns

string | undefined

---

convertToDatabase()

convertToDatabase(host, viewType): void

Parameters

host

EditorHost

viewType

string

Returns

void

---

copyCellsByProperty()

copyCellsByProperty(model, fromId, toId): void

Parameters

model

DatabaseBlockModel

fromId

string

toId

string

Returns

void

---

databaseViewInitTemplate()

databaseViewInitTemplate(datasource, viewType): void

Parameters

datasource

DatabaseBlockDataSource

viewType

string

Returns

void

---

deleteColumn()

deleteColumn(model, columnId): void

Parameters

model

DatabaseBlockModel

columnId

string

Returns

void

---

deleteRows()

deleteRows(model, rowIds): void

Parameters

model

DatabaseBlockModel

rowIds

string[]

Returns

void

---

deleteView()

deleteView(model, id): void

Parameters

model

DatabaseBlockModel

id

string

Returns

void

---

duplicateView()

duplicateView(model, id): string

Parameters

model

DatabaseBlockModel

id

string

Returns

string

---

generateDefaultValues()

generateDefaultValues(filter, _vars): Record<string, DVJSON>

Generate default values for a new row based on current filter conditions. If a property has multiple conditions, no value will be set to avoid conflicts.

Parameters

filter

FilterGroup

_vars

Variable[]

Returns

Record<string, DVJSON>

---

getCell()

getCell(model, rowId, columnId): CellDataType | null

Parameters

model

DatabaseBlockModel

rowId

string

columnId

string

Returns

CellDataType | null

---

getProperty()

getProperty(model, id): ColumnDataType<Record<string, unknown>> | undefined

Parameters

model

DatabaseBlockModel

id

string

Returns

ColumnDataType<Record<string, unknown>> | undefined

---

initDatabaseBlock()

initDatabaseBlock(doc, model, databaseId, viewType, isAppendNewRow): void

Parameters

doc

Store

model

BlockModel

databaseId

string

viewType

string

isAppendNewRow

boolean = true

Returns

void

---

moveViewTo()

moveViewTo(model, id, position): void

Parameters

model

DatabaseBlockModel

id

string

position

InsertToPosition

Returns

void

---

updateCell()

updateCell(model, rowId, cell): void

Parameters

model

DatabaseBlockModel

rowId

string

cell

CellDataType

Returns

void

---

updateCells()

updateCells(model, columnId, cells): void

Parameters

model

DatabaseBlockModel

columnId

string

cells

Record<string, unknown>

Returns

void

---

updateProperty()

updateProperty(model, id, updater, defaultValue?): string | undefined

Parameters

model

DatabaseBlockModel

id

string

updater

ColumnUpdater

defaultValue?

Record<string, unknown>

Returns

string | undefined

---

updateView()

updateView<ViewData>(model, id, update): void

Type Parameters

ViewData

ViewData extends ViewBasicDataType

Parameters

model

DatabaseBlockModel

id

string

update

(data) => Partial<ViewData>

Returns

void