Marks class as having been finalized, which includes creating properties from static properties, but does not include all properties created from decorators.

Nocollapse

Inherited from

GfxBlockComponent.finalized

onDisconnectedMap

static onDisconnectedMap: WeakMap<Constructor, WeakMap<Node, null | () => void>>

Defined in: packages/framework/block-std/dist/view/element/shadowless-element.d.ts:6

Inherited from

GfxBlockComponent.onDisconnectedMap

_renderers

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:51

Inherited from

GfxBlockComponent._renderers

blob

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:123

blobUrl

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:126

blockId

Get Signature

get blockId(): string

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:18

Returns

string

Inherited from

GfxBlockComponent.blockId

captionEditor

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:129

childBlocks

Get Signature

get childBlocks(): BlockComponent<BlockModel<object>, BlockService, string>[]

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:19

Returns

BlockComponent<BlockModel<object>, BlockService, string>[]

Inherited from

GfxBlockComponent.childBlocks

classList

Get Signature

get classList(): DOMTokenList

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8237

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

Returns

DOMTokenList

Set Signature

set classList(value): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8238

Parameters

value

string

Returns

void

Inherited from

GfxBlockComponent.classList

doc

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:53

Inherited from

GfxBlockComponent.doc

downloading

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:132

error

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:135

fallbackCard

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:138

flavour

Get Signature

get flavour(): string

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:20

Returns

string

Inherited from

GfxBlockComponent.flavour

gfx

Get Signature

get gfx(): GfxController

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:8

Returns

GfxController

Inherited from

GfxBlockComponent.gfx

host

Get Signature

get host(): EditorHost

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:21

Returns

EditorHost

Inherited from

GfxBlockComponent.host

isVersionMismatch

Get Signature

get isVersionMismatch(): boolean

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:22

Returns

boolean

Inherited from

GfxBlockComponent.isVersionMismatch

lastSourceId

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:141

loading

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:144

model

Get Signature

get model(): Model

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:23

Returns

Model

Inherited from

GfxBlockComponent.model

parentComponent

Get Signature

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

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:24

Returns

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

Inherited from

GfxBlockComponent.parentComponent

part

Get Signature

get part(): DOMTokenList

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8283

MDN Reference

Returns

DOMTokenList

Set Signature

set part(value): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8284

Parameters

value

string

Returns

void

Inherited from

GfxBlockComponent.part

renderChildren

Get Signature

get renderChildren(): (model, filter?) => TemplateResult

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:25

Returns

Function

Parameters

model

BlockModel

filter?

(model) => boolean

Returns

TemplateResult

Inherited from

GfxBlockComponent.renderChildren

resizableImg

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:147

retryCount

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:150

rootComponent

Get Signature

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

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:26

Returns

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

Inherited from

GfxBlockComponent.rootComponent

selection

Get Signature

get selection(): StoreSelectionExtension

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:27

Returns

StoreSelectionExtension

Inherited from

GfxBlockComponent.selection

service

Get Signature

get service(): Service

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:28

Returns

Service

Inherited from

GfxBlockComponent.service

std

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:11

Inherited from

GfxBlockComponent.std

style

Get Signature

get style(): CSSStyleDeclaration

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8500

MDN Reference

Returns

CSSStyleDeclaration

Set Signature

set style(cssText): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8501

Parameters

cssText

string

Returns

void

Inherited from

GfxBlockComponent.style

topContenteditableElement

Get Signature

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

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:29

Returns

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

Inherited from

GfxBlockComponent.topContenteditableElement

viewType

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:54

Inherited from

GfxBlockComponent.viewType

widgetComponents

Get Signature

get widgetComponents(): Partial<Record<WidgetName, WidgetComponent<BlockModel<object>, BlockComponent<BlockModel<object>, BlockService, string>, BlockService>>>

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:30

Returns

Partial<Record<WidgetName, WidgetComponent<BlockModel<object>, BlockComponent<BlockModel<object>, BlockService, string>, BlockService>>>

Inherited from

GfxBlockComponent.widgetComponents

widgets

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:55

Inherited from

GfxBlockComponent.widgets

addEventListener()

Call Signature

addEventListener<K>(type, listener, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10753

Type Parameters

K

K extends keyof HTMLElementEventMap

Parameters

type

K

listener

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

GfxBlockComponent.addEventListener

Call Signature

addEventListener(type, listener, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10754

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

GfxBlockComponent.addEventListener

addRenderer()

addRenderer(renderer): void

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:33

Parameters

renderer

(content) => unknown

Returns

void

Inherited from

GfxBlockComponent.addRenderer

after()

after(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:6167

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.after

animate()

animate(keyframes, options?): Animation

Defined in: node_modules/typescript/lib/lib.dom.d.ts:2702

MDN Reference

Parameters

keyframes

null | Keyframe[] | PropertyIndexedKeyframes

options?

number | KeyframeAnimationOptions

Returns

Animation

Inherited from

GfxBlockComponent.animate

append()

append(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17771

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.append

appendChild()

appendChild<T>(node): T

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17099

MDN Reference

Type Parameters

T

T extends Node

Parameters

node

T

Returns

T

Inherited from

GfxBlockComponent.appendChild

attachInternals()

attachInternals(): ElementInternals

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10744

MDN Reference

Returns

ElementInternals

Inherited from

GfxBlockComponent.attachInternals

attachShadow()

attachShadow(init): ShadowRoot

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8322

Creates a shadow root for element and returns it.

MDN Reference

Parameters

init

ShadowRootInit

Returns

ShadowRoot

Inherited from

GfxBlockComponent.attachShadow

before()

before(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:6175

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.before

bindHotKey()

bindHotKey(keymap, options?): () => void

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:34

Parameters

keymap

Record<string, UIEventHandler>

options?

flavour?

boolean

global?

boolean

Returns

Function

Returns

void

Inherited from

GfxBlockComponent.bindHotKey

blur()

blur(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:12797

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.blur

checkVisibility()

checkVisibility(options?): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8324

MDN Reference

Parameters

options?

CheckVisibilityOptions

Returns

boolean

Inherited from

GfxBlockComponent.checkVisibility

click()

click(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10746

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.click

cloneNode()

cloneNode(subtree?): Node

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17105

Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference

Parameters

subtree?

boolean

Returns

Node

Inherited from

GfxBlockComponent.cloneNode

closest()

Call Signature

closest<K>(selector): null | HTMLElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8330

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

MDN Reference

Type Parameters

K

K extends keyof HTMLElementTagNameMap

Parameters

selector

K

Returns

null | HTMLElementTagNameMap[K]

Inherited from

GfxBlockComponent.closest

Call Signature

closest<K>(selector): null | SVGElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8331

Type Parameters

K

K extends keyof SVGElementTagNameMap

Parameters

selector

K

Returns

null | SVGElementTagNameMap[K]

Inherited from

GfxBlockComponent.closest

Call Signature

closest<K>(selector): null | MathMLElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8332

Type Parameters

K

K extends keyof MathMLElementTagNameMap

Parameters

selector

K

Returns

null | MathMLElementTagNameMap[K]

Inherited from

GfxBlockComponent.closest

Call Signature

closest<E>(selectors): null | E

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8333

Type Parameters

E

E extends Element = Element

Parameters

selectors

string

Returns

null | E

Inherited from

GfxBlockComponent.closest

compareDocumentPosition()

compareDocumentPosition(other): number

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17111

Returns a bitmask indicating the position of other relative to node.

MDN Reference

Parameters

other

Node

Returns

number

Inherited from

GfxBlockComponent.compareDocumentPosition

computedStyleMap()

computedStyleMap(): StylePropertyMapReadOnly

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8335

MDN Reference

Returns

StylePropertyMapReadOnly

Inherited from

GfxBlockComponent.computedStyleMap

connectedCallback()

connectedCallback(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:59

Returns

void

Overrides

GfxBlockComponent.connectedCallback

contains()

contains(other): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17117

Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference

Parameters

other

null | Node

Returns

boolean

Inherited from

GfxBlockComponent.contains

convertToCardView()

convertToCardView(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:29

Returns

void

copy()

copy(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:33

Returns

void

disconnectedCallback()

disconnectedCallback(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:73

Returns

void

Overrides

GfxBlockComponent.disconnectedCallback

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8882

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

event

Event

Returns

boolean

Inherited from

GfxBlockComponent.dispatchEvent

download()

download(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:37

Returns

void

focus()

focus(options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:12799

MDN Reference

Parameters

options?

FocusOptions

Returns

void

Inherited from

GfxBlockComponent.focus

getAnimations()

getAnimations(options?): Animation[]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:2704

MDN Reference

Parameters

options?

GetAnimationsOptions

Returns

Animation[]

Inherited from

GfxBlockComponent.getAnimations

getAttribute()

getAttribute(qualifiedName): null | string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8341

Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

MDN Reference

Parameters

qualifiedName

string

Returns

null | string

Inherited from

GfxBlockComponent.getAttribute

getAttributeNames()

getAttributeNames(): string[]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8353

Returns the qualified names of all element's attributes. Can contain duplicates.

MDN Reference

Returns

string[]

Inherited from

GfxBlockComponent.getAttributeNames

getAttributeNode()

getAttributeNode(qualifiedName): null | Attr

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8355

MDN Reference

Parameters

qualifiedName

string

Returns

null | Attr

Inherited from

GfxBlockComponent.getAttributeNode

getAttributeNodeNS()

getAttributeNodeNS(namespace, localName): null | Attr

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8357

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

null | Attr

Inherited from

GfxBlockComponent.getAttributeNodeNS

getAttributeNS()

getAttributeNS(namespace, localName): null | string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8347

Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

null | string

Inherited from

GfxBlockComponent.getAttributeNS

getBoundingClientRect()

getBoundingClientRect(): DOMRect

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8359

MDN Reference

Returns

DOMRect

Inherited from

GfxBlockComponent.getBoundingClientRect

getClientRects()

getClientRects(): DOMRectList

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8361

MDN Reference

Returns

DOMRectList

Inherited from

GfxBlockComponent.getClientRects

getCSSTransform()

getCSSTransform(): string

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:10

Returns

string

Inherited from

GfxBlockComponent.getCSSTransform

getElementsByClassName()

getElementsByClassName(classNames): HTMLCollectionOf<Element>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8367

Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

MDN Reference

Parameters

classNames

string

Returns

HTMLCollectionOf<Element>

Inherited from

GfxBlockComponent.getElementsByClassName

getElementsByTagName()

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8369

MDN Reference

Type Parameters

K

K extends keyof HTMLElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from

GfxBlockComponent.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8370

Type Parameters

K

K extends keyof SVGElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from

GfxBlockComponent.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8371

Type Parameters

K

K extends keyof MathMLElementTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Inherited from

GfxBlockComponent.getElementsByTagName

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8373

Type Parameters

K

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

qualifiedName

K

Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Inherited from

GfxBlockComponent.getElementsByTagName

Call Signature

getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8374

Parameters

qualifiedName

string

Returns

HTMLCollectionOf<Element>

Inherited from

GfxBlockComponent.getElementsByTagName

getElementsByTagNameNS()

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8376

MDN Reference

Parameters

namespaceURI

"http://www.w3.org/1999/xhtml"

localName

string

Returns

HTMLCollectionOf<HTMLElement>

Inherited from

GfxBlockComponent.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8377

Parameters

namespaceURI

"http://www.w3.org/2000/svg"

localName

string

Returns

HTMLCollectionOf<SVGElement>

Inherited from

GfxBlockComponent.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8378

Parameters

namespaceURI

"http://www.w3.org/1998/Math/MathML"

localName

string

Returns

HTMLCollectionOf<MathMLElement>

Inherited from

GfxBlockComponent.getElementsByTagNameNS

Call Signature

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8379

Parameters

namespace

null | string

localName

string

Returns

HTMLCollectionOf<Element>

Inherited from

GfxBlockComponent.getElementsByTagNameNS

getHTML()

getHTML(options?): string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8381

MDN Reference

Parameters

options?

GetHTMLOptions

Returns

string

Inherited from

GfxBlockComponent.getHTML

getRenderingRect()

getRenderingRect(): object

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:11

Returns

object

h

h: any

w

w: any

x

x: any

y

y: any

zIndex

zIndex: string

Inherited from

GfxBlockComponent.getRenderingRect

getRootNode()

getRootNode(options?): Node

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17123

Returns node's root.

MDN Reference

Parameters

options?

GetRootNodeOptions

Returns

Node

Inherited from

GfxBlockComponent.getRootNode

hasAttribute()

hasAttribute(qualifiedName): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8387

Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

MDN Reference

Parameters

qualifiedName

string

Returns

boolean

Inherited from

GfxBlockComponent.hasAttribute

hasAttributeNS()

hasAttributeNS(namespace, localName): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8393

Returns true if element has an attribute whose namespace is namespace and local name is localName.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

boolean

Inherited from

GfxBlockComponent.hasAttributeNS

hasAttributes()

hasAttributes(): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8399

Returns true if element has attributes, and false otherwise.

MDN Reference

Returns

boolean

Inherited from

GfxBlockComponent.hasAttributes

hasChildNodes()

hasChildNodes(): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17129

Returns whether node has children.

MDN Reference

Returns

boolean

Inherited from

GfxBlockComponent.hasChildNodes

hasPointerCapture()

hasPointerCapture(pointerId): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8401

MDN Reference

Parameters

pointerId

number

Returns

boolean

Inherited from

GfxBlockComponent.hasPointerCapture

hidePopover()

hidePopover(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10748

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.hidePopover

insertAdjacentElement()

insertAdjacentElement(where, element): null | Element

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8403

MDN Reference

Parameters

where

InsertPosition

element

Element

Returns

null | Element

Inherited from

GfxBlockComponent.insertAdjacentElement

insertAdjacentHTML()

insertAdjacentHTML(position, string): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8405

MDN Reference

Parameters

position

InsertPosition

string

string

Returns

void

Inherited from

GfxBlockComponent.insertAdjacentHTML

insertAdjacentText()

insertAdjacentText(where, data): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8407

MDN Reference

Parameters

where

InsertPosition

data

string

Returns

void

Inherited from

GfxBlockComponent.insertAdjacentText

insertBefore()

insertBefore<T>(node, child): T

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17131

MDN Reference

Type Parameters

T

T extends Node

Parameters

node

T

child

null | Node

Returns

T

Inherited from

GfxBlockComponent.insertBefore

isDefaultNamespace()

isDefaultNamespace(namespace): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17133

MDN Reference

Parameters

namespace

null | string

Returns

boolean

Inherited from

GfxBlockComponent.isDefaultNamespace

isEqualNode()

isEqualNode(otherNode): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17139

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

otherNode

null | Node

Returns

boolean

Inherited from

GfxBlockComponent.isEqualNode

isSameNode()

isSameNode(otherNode): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17141

MDN Reference

Parameters

otherNode

null | Node

Returns

boolean

Inherited from

GfxBlockComponent.isSameNode

lookupNamespaceURI()

lookupNamespaceURI(prefix): null | string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17143

MDN Reference

Parameters

prefix

null | string

Returns

null | string

Inherited from

GfxBlockComponent.lookupNamespaceURI

lookupPrefix()

lookupPrefix(namespace): null | string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17145

MDN Reference

Parameters

namespace

null | string

Returns

null | string

Inherited from

GfxBlockComponent.lookupPrefix

matches()

matches(selectors): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8413

Returns true if matching selectors against element's root yields element, and false otherwise.

MDN Reference

Parameters

selectors

string

Returns

boolean

Inherited from

GfxBlockComponent.matches

normalize()

normalize(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17151

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.normalize

prepend()

prepend(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17779

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.prepend

querySelector()

Call Signature

querySelector<K>(selectors): null | HTMLElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17785

Returns the first element that is a descendant of node that matches selectors.

MDN Reference

Type Parameters

K

K extends keyof HTMLElementTagNameMap

Parameters

selectors

K

Returns

null | HTMLElementTagNameMap[K]

Inherited from

GfxBlockComponent.querySelector

Call Signature

querySelector<K>(selectors): null | SVGElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17786

Type Parameters

K

K extends keyof SVGElementTagNameMap

Parameters

selectors

K

Returns

null | SVGElementTagNameMap[K]

Inherited from

GfxBlockComponent.querySelector

Call Signature

querySelector<K>(selectors): null | MathMLElementTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17787

Type Parameters

K

K extends keyof MathMLElementTagNameMap

Parameters

selectors

K

Returns

null | MathMLElementTagNameMap[K]

Inherited from

GfxBlockComponent.querySelector

Call Signature

querySelector<K>(selectors): null | HTMLElementDeprecatedTagNameMap[K]

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17789

Type Parameters

K

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors

K

Returns

null | HTMLElementDeprecatedTagNameMap[K]

Deprecated

Inherited from

GfxBlockComponent.querySelector

Call Signature

querySelector<E>(selectors): null | E

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17790

Type Parameters

E

E extends Element = Element

Parameters

selectors

string

Returns

null | E

Inherited from

GfxBlockComponent.querySelector

querySelectorAll()

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17796

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters

K

K extends keyof HTMLElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from

GfxBlockComponent.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17797

Type Parameters

K

K extends keyof SVGElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from

GfxBlockComponent.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17798

Type Parameters

K

K extends keyof MathMLElementTagNameMap

Parameters

selectors

K

Returns

NodeListOf<MathMLElementTagNameMap[K]>

Inherited from

GfxBlockComponent.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17800

Type Parameters

K

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors

K

Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Inherited from

GfxBlockComponent.querySelectorAll

Call Signature

querySelectorAll<E>(selectors): NodeListOf<E>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17801

Type Parameters

E

E extends Element = Element

Parameters

selectors

string

Returns

NodeListOf<E>

Inherited from

GfxBlockComponent.querySelectorAll

refreshData()

refreshData(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:41

Returns

void

releasePointerCapture()

releasePointerCapture(pointerId): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8415

MDN Reference

Parameters

pointerId

number

Returns

void

Inherited from

GfxBlockComponent.releasePointerCapture

remove()

remove(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:6181

Removes node.

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.remove

removeAttribute()

removeAttribute(qualifiedName): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8421

Removes element's first attribute whose qualified name is qualifiedName.

MDN Reference

Parameters

qualifiedName

string

Returns

void

Inherited from

GfxBlockComponent.removeAttribute

removeAttributeNode()

removeAttributeNode(attr): Attr

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8429

MDN Reference

Parameters

attr

Attr

Returns

Attr

Inherited from

GfxBlockComponent.removeAttributeNode

removeAttributeNS()

removeAttributeNS(namespace, localName): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8427

Removes element's attribute whose namespace is namespace and local name is localName.

MDN Reference

Parameters

namespace

null | string

localName

string

Returns

void

Inherited from

GfxBlockComponent.removeAttributeNS

removeChild()

removeChild<T>(child): T

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17153

MDN Reference

Type Parameters

T

T extends Node

Parameters

child

T

Returns

T

Inherited from

GfxBlockComponent.removeChild

removeEventListener()

Call Signature

removeEventListener<K>(type, listener, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10755

Type Parameters

K

K extends keyof HTMLElementEventMap

Parameters

type

K

listener

(this, ev) => any

options?

boolean | EventListenerOptions

Returns

void

Inherited from

GfxBlockComponent.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10756

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | EventListenerOptions

Returns

void

Inherited from

GfxBlockComponent.removeEventListener

renderBlock()

renderBlock(): unknown

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:18

Returns

unknown

Inherited from

GfxBlockComponent.renderBlock

renderGfxBlock()

renderGfxBlock(): TemplateResult<1>

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:80

Returns

TemplateResult<1>

Overrides

GfxBlockComponent.renderGfxBlock

renderPageContent()

renderPageContent(): unknown

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:20

Returns

unknown

Inherited from

GfxBlockComponent.renderPageContent

renderVersionMismatch()

renderVersionMismatch(expectedVersion, actualVersion): TemplateResult

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:49

Render a warning message when the block version is mismatched.

Parameters

expectedVersion

number

If the schema is not found, the expected version is -1. Which means the block is not supported in the current editor.

actualVersion

number

The version of the block's crdt data.

Returns

TemplateResult

Inherited from

GfxBlockComponent.renderVersionMismatch

replaceChild()

replaceChild<T>(node, child): T

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17155

MDN Reference

Type Parameters

T

T extends Node

Parameters

node

Node

child

T

Returns

T

Inherited from

GfxBlockComponent.replaceChild

replaceChildren()

replaceChildren(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:17809

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.replaceChildren

replaceWith()

replaceWith(...nodes): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:6189

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

nodes

...(string | Node)[]

Returns

void

Inherited from

GfxBlockComponent.replaceWith

requestFullscreen()

requestFullscreen(options?): Promise<void>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8437

Displays element fullscreen and resolves promise when done.

When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

MDN Reference

Parameters

options?

FullscreenOptions

Returns

Promise<void>

Inherited from

GfxBlockComponent.requestFullscreen

requestPointerLock()

requestPointerLock(options?): Promise<void>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8439

MDN Reference

Parameters

options?

PointerLockOptions

Returns

Promise<void>

Inherited from

GfxBlockComponent.requestPointerLock

scroll()

Call Signature

scroll(options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8441

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Inherited from

GfxBlockComponent.scroll

Call Signature

scroll(x, y): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8442

Parameters

x

number

y

number

Returns

void

Inherited from

GfxBlockComponent.scroll

scrollBy()

Call Signature

scrollBy(options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8444

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Inherited from

GfxBlockComponent.scrollBy

Call Signature

scrollBy(x, y): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8445

Parameters

x

number

y

number

Returns

void

Inherited from

GfxBlockComponent.scrollBy

scrollIntoView()

scrollIntoView(arg?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8447

MDN Reference

Parameters

arg?

boolean | ScrollIntoViewOptions

Returns

void

Inherited from

GfxBlockComponent.scrollIntoView

scrollTo()

Call Signature

scrollTo(options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8449

MDN Reference

Parameters

options?

ScrollToOptions

Returns

void

Inherited from

GfxBlockComponent.scrollTo

Call Signature

scrollTo(x, y): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8450

Parameters

x

number

y

number

Returns

void

Inherited from

GfxBlockComponent.scrollTo

setAttribute()

setAttribute(qualifiedName, value): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8456

Sets the value of element's first attribute whose qualified name is qualifiedName to value.

MDN Reference

Parameters

qualifiedName

string

value

string

Returns

void

Inherited from

GfxBlockComponent.setAttribute

setAttributeNode()

setAttributeNode(attr): null | Attr

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8464

MDN Reference

Parameters

attr

Attr

Returns

null | Attr

Inherited from

GfxBlockComponent.setAttributeNode

setAttributeNodeNS()

setAttributeNodeNS(attr): null | Attr

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8466

MDN Reference

Parameters

attr

Attr

Returns

null | Attr

Inherited from

GfxBlockComponent.setAttributeNodeNS

setAttributeNS()

setAttributeNS(namespace, qualifiedName, value): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8462

Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

MDN Reference

Parameters

namespace

null | string

qualifiedName

string

value

string

Returns

void

Inherited from

GfxBlockComponent.setAttributeNS

setHTMLUnsafe()

setHTMLUnsafe(html): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8468

MDN Reference

Parameters

html

string

Returns

void

Inherited from

GfxBlockComponent.setHTMLUnsafe

setPointerCapture()

setPointerCapture(pointerId): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8470

MDN Reference

Parameters

pointerId

number

Returns

void

Inherited from

GfxBlockComponent.setPointerCapture

showPopover()

showPopover(): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10750

MDN Reference

Returns

void

Inherited from

GfxBlockComponent.showPopover

toggleAttribute()

toggleAttribute(qualifiedName, force?): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8478

If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

Returns true if qualifiedName is now present, and false otherwise.

MDN Reference

Parameters

qualifiedName

string

force?

boolean

Returns

boolean

Inherited from

GfxBlockComponent.toggleAttribute

togglePopover()

togglePopover(options?): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:10752

MDN Reference

Parameters

options?

boolean

Returns

boolean

Inherited from

GfxBlockComponent.togglePopover

toZIndex()

toZIndex(): string

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:22

Returns

string

Inherited from

GfxBlockComponent.toZIndex

updateZIndex()

updateZIndex(): void

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:23

Returns

void

Inherited from

GfxBlockComponent.updateZIndex

webkitMatchesSelector()

webkitMatchesSelector(selectors): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8484

Parameters

selectors

string

Returns

boolean

Deprecated

This is a legacy alias of matches.

MDN Reference

Inherited from

GfxBlockComponent.webkitMatchesSelector

addInitializer()

static addInitializer(initializer): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:257

Adds an initializer function to the class that is called during instance construction.

This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.

const myDecorator = (target: typeof ReactiveElement, key: string) => {
  target.addInitializer((instance: ReactiveElement) => {
    // This is run during construction of the element
    new MyController(instance);
  });
}

Decorating a field will then cause each instance to run an initializer that adds a controller:

class MyElement extends LitElement {
  @myDecorator foo;
}

Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.

Parameters

initializer

Initializer

Returns

void

Nocollapse

Inherited from

GfxBlockComponent.addInitializer

finalize()

protected static finalize(): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:441

Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.

This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.

Returns

void

Nocollapse

Inherited from

GfxBlockComponent.finalize

attributes

observedAttributes

Get Signature

get static observedAttributes(): string[]

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:346

Returns a list of attributes corresponding to the registered properties.

Nocollapse

Returns

string[]

Inherited from

GfxBlockComponent.observedAttributes

attributeChangedCallback()

attributeChangedCallback(name, _old, value): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:580

Synchronizes property values when attributes change.

Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.

See using the lifecycle callbacks on MDN for more information about the attributeChangedCallback.

Parameters

name

string

_old

null | string

value

null | string

Returns

void

Inherited from

GfxBlockComponent.attributeChangedCallback

controllers

addController()

addController(controller): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:519

Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.

If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.

Parameters

controller

ReactiveController

Returns

void

Inherited from

GfxBlockComponent.addController

removeController()

removeController(controller): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:524

Removes a ReactiveController from the element.

Parameters

controller

ReactiveController

Returns

void

Inherited from

GfxBlockComponent.removeController

dev-mode

disableWarning()?

static optional disableWarning: (warningKind) => void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:223

Disable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');

// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');

Parameters

warningKind

WarningKind

Returns

void

Nocollapse

Inherited from

GfxBlockComponent.disableWarning

enabledWarnings?

static optional enabledWarnings: WarningKind[]

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:187

Read or set all the enabled warning categories for this class.

This property is only used in development builds.

Nocollapse

Inherited from

GfxBlockComponent.enabledWarnings

enableWarning()?

static optional enableWarning: (warningKind) => void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:205

Enable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');

// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');

Parameters

warningKind

WarningKind

Returns

void

Nocollapse

Inherited from

GfxBlockComponent.enableWarning

properties

elementProperties

static elementProperties: PropertyDeclarationMap

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:280

Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.

Nocollapse

Inherited from

GfxBlockComponent.elementProperties

properties

static properties: PropertyDeclarations

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:306

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

Nocollapse

Inherited from

GfxBlockComponent.properties

createProperty()

static createProperty(name, options?): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:373

Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.

This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:

static createProperty(name, options) {
  options = Object.assign(options, {myOption: true});
  super.createProperty(name, options);
}

Parameters

name

PropertyKey

options?

PropertyDeclaration<unknown, unknown>

Returns

void

Nocollapse

Inherited from

GfxBlockComponent.createProperty

getPropertyDescriptor()

protected static getPropertyDescriptor(name, key, options): undefined | PropertyDescriptor

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:401

Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,

class MyElement extends LitElement {
  static getPropertyDescriptor(name, key, options) {
    const defaultDescriptor =
        super.getPropertyDescriptor(name, key, options);
    const setter = defaultDescriptor.set;
    return {
      get: defaultDescriptor.get,
      set(value) {
        setter.call(this, value);
        // custom action.
      },
      configurable: true,
      enumerable: true
    }
  }
}

Parameters

name

PropertyKey

key

string | symbol

options

PropertyDeclaration

Returns

undefined | PropertyDescriptor

Nocollapse

Inherited from

GfxBlockComponent.getPropertyDescriptor

getPropertyOptions()

static getPropertyOptions(name): PropertyDeclaration<unknown, unknown>

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:416

Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).

Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.

Parameters

name

PropertyKey

Returns

PropertyDeclaration<unknown, unknown>

Nocollapse

Final

Inherited from

GfxBlockComponent.getPropertyOptions

rendering

renderOptions

readonly renderOptions: RenderOptions

Defined in: node_modules/lit-element/development/lit-element.d.ts:88

Inherited from

GfxBlockComponent.renderOptions

renderRoot

readonly renderRoot: HTMLElement | DocumentFragment

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:473

Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.

Inherited from

GfxBlockComponent.renderRoot

shadowRootOptions

static shadowRootOptions: ShadowRootInit

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:452

Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

Nocollapse

Inherited from

GfxBlockComponent.shadowRootOptions

createRenderRoot()

createRenderRoot(): this

Defined in: packages/framework/block-std/dist/view/element/shadowless-element.d.ts:11

Returns

this

Inherited from

GfxBlockComponent.createRenderRoot

render()

render(): unknown

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:41

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

Inherited from

GfxBlockComponent.render

styles

elementStyles

static elementStyles: CSSResultOrNative[]

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:313

Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.

Nocollapse

Inherited from

GfxBlockComponent.elementStyles

styles

static styles: CSSResult

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:21

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:

html

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

Nocollapse

Overrides

GfxBlockComponent.styles

finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

Defined in: packages/framework/block-std/dist/view/element/shadowless-element.d.ts:7

Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

Parameters

styles?

CSSResultGroup

Returns

CSSResultOrNative[]

Nocollapse

Inherited from

GfxBlockComponent.finalizeStyles

updates

hasUpdated

hasUpdated: boolean

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:491

Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.

Inherited from

GfxBlockComponent.hasUpdated

isUpdatePending

isUpdatePending: boolean

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:485

True if there is a pending update as a result of calling requestUpdate(). Should only be read.

Inherited from

GfxBlockComponent.isUpdatePending

updateComplete

Get Signature

get updateComplete(): Promise<boolean>

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:669

Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.

To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.

Returns

Promise<boolean>

A promise of a boolean that resolves to true if the update completed without triggering another update.

Inherited from

GfxBlockComponent.updateComplete

enableUpdating()

protected enableUpdating(_requestedUpdate): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:560

Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.

Parameters

_requestedUpdate

boolean

Returns

void

Inherited from

GfxBlockComponent.enableUpdating

firstUpdated()

protected firstUpdated(_changedProperties): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:740

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.

Parameters

_changedProperties

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

GfxBlockComponent.firstUpdated

getUpdateComplete()

protected getUpdateComplete(): Promise<boolean>

Defined in: packages/framework/block-std/dist/view/element/block-component.d.ts:40

Override point for the updateComplete promise.

It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:

class MyElement extends LitElement {
  override async getUpdateComplete() {
    const result = await super.getUpdateComplete();
    await this._myChild.updateComplete;
    return result;
  }
}

Returns

Promise<boolean>

A promise of a boolean that resolves to true if the update completed without triggering another update.

Inherited from

GfxBlockComponent.getUpdateComplete

performUpdate()

protected performUpdate(): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:629

Performs an element update. Note, if an exception is thrown during the update, firstUpdated and updated will not be called.

Call performUpdate() to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.

Returns

void

Inherited from

GfxBlockComponent.performUpdate

requestUpdate()

requestUpdate(name?, oldValue?, options?): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:596

Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored.

Parameters

name?

PropertyKey

name of requesting property

oldValue?

unknown

old value of requesting property

options?

PropertyDeclaration<unknown, unknown>

property options to use instead of the previously configured options

Returns

void

Inherited from

GfxBlockComponent.requestUpdate

scheduleUpdate()

scheduleUpdate(): Promise<unknown>

Defined in: packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:21

Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.

For instance, to schedule updates to occur just before the next frame:

override protected async scheduleUpdate(): Promise<unknown> {
  await new Promise((resolve) => requestAnimationFrame(() => resolve()));
  super.scheduleUpdate();
}

Returns

Promise<unknown>

Inherited from

GfxBlockComponent.scheduleUpdate

shouldUpdate()

protected shouldUpdate(_changedProperties): boolean

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:702

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

Inherited from

GfxBlockComponent.shouldUpdate

update()

protected update(changedProperties): void

Defined in: node_modules/lit-element/development/lit-element.d.ts:101

Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

Parameters

changedProperties

Map of changed properties with old values

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

GfxBlockComponent.update

updated()

updated(): void

Defined in: packages/affine/blocks/block-image/src/image-edgeless-block.ts:118

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.

Returns

void

Overrides

GfxBlockComponent.updated

willUpdate()

protected willUpdate(_changedProperties): void

Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:651

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

willUpdate(changedProperties) {
  // only need to check changed properties for an expensive computation.
  if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
    this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
  }
}

render() {
  return html`SHA: ${this.sha}`;
}

Parameters

_changedProperties

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

GfxBlockComponent.willUpdate

Class: ImageEdgelessBlockComponent ​

Extends ​

Constructors ​

new ImageEdgelessBlockComponent() ​

Returns ​

Inherited from ​

Other ​

_disposables ​

Inherited from ​

[blockComponentSymbol] ​

Inherited from ​

[GfxElementSymbol] ​

Inherited from ​

accessKey ​

Inherited from ​

accessKeyLabel ​

Inherited from ​

ariaAtomic ​

Inherited from ​

ariaAutoComplete ​

Inherited from ​

ariaBrailleLabel ​

Inherited from ​

ariaBrailleRoleDescription ​

Inherited from ​

ariaBusy ​

Inherited from ​

ariaChecked ​

Inherited from ​

ariaColCount ​

Inherited from ​

ariaColIndex ​

Inherited from ​

ariaColIndexText ​

Inherited from ​

ariaColSpan ​

Inherited from ​

ariaCurrent ​

Inherited from ​

ariaDescription ​

Inherited from ​

ariaDisabled ​

Inherited from ​

ariaExpanded ​

Inherited from ​

ariaHasPopup ​

Inherited from ​

ariaHidden ​

Inherited from ​

ariaInvalid ​

Inherited from ​

ariaKeyShortcuts ​

Inherited from ​

ariaLabel ​

Inherited from ​

ariaLevel ​

Inherited from ​

ariaLive ​

Inherited from ​

ariaModal ​

Inherited from ​

ariaMultiLine ​

Inherited from ​

ariaMultiSelectable ​

Inherited from ​

ariaOrientation ​

Inherited from ​

ariaPlaceholder ​

Inherited from ​

ariaPosInSet ​

Inherited from ​

ariaPressed ​

Inherited from ​

ariaReadOnly ​

Inherited from ​

ariaRelevant ​

Inherited from ​

ariaRequired ​

Inherited from ​

ariaRoleDescription ​

Class: ImageEdgelessBlockComponent

Extends

Constructors

new ImageEdgelessBlockComponent()

Returns

Inherited from

Other

_disposables

Inherited from

[blockComponentSymbol]

Inherited from

[GfxElementSymbol]

Inherited from

accessKey

Inherited from

accessKeyLabel

Inherited from

ariaAtomic

Inherited from

ariaAutoComplete

Inherited from

ariaBrailleLabel

Inherited from

ariaBrailleRoleDescription

Inherited from

ariaBusy

Inherited from

ariaChecked

Inherited from

ariaColCount

Inherited from

ariaColIndex

Inherited from

ariaColIndexText

Inherited from

ariaColSpan

Inherited from

ariaCurrent

Inherited from

ariaDescription

Inherited from

ariaDisabled

Inherited from

ariaExpanded

Inherited from

ariaHasPopup

Inherited from

ariaHidden

Inherited from

ariaInvalid

Inherited from

ariaKeyShortcuts

Inherited from

ariaLabel

Inherited from

ariaLevel

Inherited from

ariaLive

Inherited from

ariaModal

Inherited from

ariaMultiLine

Inherited from

ariaMultiSelectable

Inherited from

ariaOrientation

Inherited from

ariaPlaceholder

Inherited from

ariaPosInSet

Inherited from

ariaPressed

Inherited from

ariaReadOnly

Inherited from

ariaRelevant

Inherited from

ariaRequired

Inherited from

ariaRoleDescription