BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/affine-model / EmbedGithubModel

Class: EmbedGithubModel ​

Extends ​

Constructors ​

new EmbedGithubModel() ​

new EmbedGithubModel(): EmbedGithubModel

Returns ​

EmbedGithubModel

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).constructor

Defined in ​

packages/framework/store/dist/schema/base.d.ts:134

Properties ​

[modelLabel] ​

[modelLabel]: object & EmbedGithubBlockUrlData & GfxCompatibleProps

Type declaration ​

caption ​

caption: null | string

githubId ​

githubId: string

githubType ​

githubType: "issue" | "pr"

owner ​

owner: string

repo ​

repo: string

style ​

style: EmbedCardStyle

url ​

url: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).[modelLabel]

Defined in ​

packages/framework/store/dist/schema/base.d.ts:116

assignees ​

assignees: null | string[]

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).assignees

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:14

assignees$ ​

assignees$: Signal<null | string[]>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).assignees$

caption ​

caption: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).caption

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:31

caption$ ​

caption$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).caption$

childMap ​

childMap: ReadonlySignal<Map<string, number>>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).childMap

Defined in ​

packages/framework/store/dist/schema/base.d.ts:109

connectable ​

connectable: boolean

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).connectable

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:8

created ​

created: Slot<void>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).created

Defined in ​

packages/framework/store/dist/schema/base.d.ts:110

createdAt ​

createdAt: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).createdAt

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:13

createdAt$ ​

createdAt$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).createdAt$

deleted ​

deleted: Slot<void>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).deleted

Defined in ​

packages/framework/store/dist/schema/base.d.ts:111

description ​

description: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).description

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:12

description$ ​

description$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).description$

flavour ​

flavour: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).flavour

Defined in ​

packages/framework/store/dist/schema/base.d.ts:112

githubId ​

githubId: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubId

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:29

githubId$ ​

githubId$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubId$

githubType ​

githubType: "issue" | "pr"

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubType

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:28

githubType$ ​

githubType$: Signal<"issue" | "pr">

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubType$

id ​

id: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).id

Defined in ​

packages/framework/store/dist/schema/base.d.ts:113

image ​

image: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).image

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:8

image$ ​

image$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).image$

index ​

index: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).index

Defined in ​

packages/affine/model/src/utils/gfx-compatible.ts:8

index$ ​

index$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).index$

isEmpty ​

isEmpty: ReadonlySignal<boolean>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).isEmpty

Defined in ​

packages/framework/store/dist/schema/base.d.ts:114

keys ​

keys: string[]

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).keys

Defined in ​

packages/framework/store/dist/schema/base.d.ts:115

owner ​

owner: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).owner

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:26

owner$ ​

owner$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).owner$

page ​

page: Doc

Deprecated ​

use doc instead

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).page

Defined in ​

packages/framework/store/dist/schema/base.d.ts:120

pop() ​

pop: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "description" | "caption" | "style" | "image" | "title" | "url" | "status" | "owner" | "repo" | "githubType" | "githubId" | "statusReason" | "createdAt" | "assignees"

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).pop

Defined in ​

packages/framework/store/dist/schema/base.d.ts:121

propsUpdated ​

propsUpdated: Slot<object>

Type declaration ​

key ​

key: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).propsUpdated

Defined in ​

packages/framework/store/dist/schema/base.d.ts:122

repo ​

repo: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).repo

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:27

repo$ ​

repo$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).repo$

role ​

role: "root" | "hub" | "content"

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).role

Defined in ​

packages/framework/store/dist/schema/base.d.ts:125

rotate ​

rotate: number

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).rotate

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:9

stash() ​

stash: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "description" | "caption" | "style" | "image" | "title" | "url" | "status" | "owner" | "repo" | "githubType" | "githubId" | "statusReason" | "createdAt" | "assignees"

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).stash

Defined in ​

packages/framework/store/dist/schema/base.d.ts:126

status ​

status: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).status

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:9

status$ ​

status$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).status$

statusReason ​

statusReason: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).statusReason

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:10

statusReason$ ​

statusReason$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).statusReason$

style ​

style: EmbedCardStyle

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).style

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:25

style$ ​

style$: Signal<EmbedCardStyle>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).style$

text? ​

optional text: Text

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).text

Defined in ​

packages/framework/store/dist/schema/base.d.ts:127

title ​

title: null | string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).title

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:11

title$ ​

title$: Signal<null | string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).title$

url ​

url: string

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).url

Defined in ​

packages/affine/model/src/blocks/embed/github/github-model.ts:30

url$ ​

url$: Signal<string>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).url$

version ​

version: number

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).version

Defined in ​

packages/framework/store/dist/schema/base.d.ts:128

xywh ​

xywh: `[${number},${number},${number},${number}]`

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).xywh

Defined in ​

packages/affine/model/src/utils/gfx-compatible.ts:7

xywh$ ​

xywh$: Signal<`[${number},${number},${number},${number}]`>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).xywh$

yBlock ​

yBlock: YBlock

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).yBlock

Defined in ​

packages/framework/store/dist/schema/base.d.ts:129

Accessors ​

children ​

get children(): BlockModel<object, SignaledProps<object>>[]

Returns ​

BlockModel<object, SignaledProps<object>>[]

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).children

Defined in ​

packages/framework/store/dist/schema/base.d.ts:130

doc ​

get doc(): Doc

set doc(doc): void

Parameters ​

• doc: Doc

Returns ​

Doc

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).doc

Defined in ​

packages/framework/store/dist/schema/base.d.ts:131

elementBound ​

get elementBound(): Bound

Returns ​

Bound

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).elementBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:10

externalBound ​

get externalBound(): null | Bound

Returns ​

null | Bound

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).externalBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:11

externalXYWH ​

get externalXYWH(): undefined | `[${number},${number},${number},${number}]`

set externalXYWH(xywh): void

Parameters ​

• xywh: undefined | `[${number},${number},${number},${number}]`

Returns ​

undefined | `[${number},${number},${number},${number}]`

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).externalXYWH

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:12

group ​

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns ​

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).group

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:14

groups ​

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns ​

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).groups

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:15

parent ​

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).parent

Defined in ​

packages/framework/store/dist/schema/base.d.ts:133

Methods ​

[dispose]() ​

[dispose](): void

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).[dispose]

Defined in ​

packages/framework/store/dist/schema/base.d.ts:138

containsBound() ​

containsBound(bounds): boolean

Parameters ​

• bounds: Bound

Returns ​

boolean

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).containsBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:16

dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).dispose

Defined in ​

packages/framework/store/dist/schema/base.d.ts:135

firstChild() ​

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).firstChild

Defined in ​

packages/framework/store/dist/schema/base.d.ts:136

getLineIntersections() ​

getLineIntersections(start, end): null | PointLocation[]

Parameters ​

• start: IVec

• end: IVec

Returns ​

null | PointLocation[]

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getLineIntersections

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:17

getNearestPoint() ​

getNearestPoint(point): IVec

Parameters ​

• point: IVec

Returns ​

IVec

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getNearestPoint

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:18

getRelativePointLocation() ​

getRelativePointLocation(relativePoint): PointLocation

Parameters ​

• relativePoint: IVec

Returns ​

PointLocation

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).getRelativePointLocation

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:19

includesPoint() ​

includesPoint(x, y, _, __): boolean

Parameters ​

• x: number

• y: number

• _: PointTestOptions

• __: EditorHost

Returns ​

boolean

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).includesPoint

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:20

intersectsBound() ​

intersectsBound(bound): boolean

Parameters ​

• bound: Bound

Returns ​

boolean

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).intersectsBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:21

lastChild() ​

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).lastChild

Defined in ​

packages/framework/store/dist/schema/base.d.ts:137

Copyright © 2022-present Toeverything