BlockSuite API Documentation / @blocksuite/blocks / LatexBlockModel
Class: LatexBlockModel
Extends
LatexBlockModel_base
Implements
GfxElementGeometry
Constructors
new LatexBlockModel()
new LatexBlockModel():
LatexBlockModel
Returns
Inherited from
LatexBlockModel_base.constructor
Defined in
packages/affine/model/dist/blocks/latex/latex-model.d.ts:24
Properties
[modelLabel]
[modelLabel]:
LatexProps
Inherited from
LatexBlockModel_base.[modelLabel]
Defined in
packages/framework/store/dist/schema/base.d.ts:120
childMap
childMap:
ReadonlySignal<Map<string,number>>
Inherited from
LatexBlockModel_base.childMap
Defined in
packages/framework/store/dist/schema/base.d.ts:113
connectable
connectable:
boolean
Inherited from
LatexBlockModel_base.connectable
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:12
created
created:
Slot<void>
Inherited from
LatexBlockModel_base.created
Defined in
packages/framework/store/dist/schema/base.d.ts:114
deleted
deleted:
Slot<void>
Inherited from
LatexBlockModel_base.deleted
Defined in
packages/framework/store/dist/schema/base.d.ts:115
flavour
flavour:
string
Inherited from
LatexBlockModel_base.flavour
Defined in
packages/framework/store/dist/schema/base.d.ts:116
id
id:
string
Inherited from
LatexBlockModel_base.id
Defined in
packages/framework/store/dist/schema/base.d.ts:117
index
index:
string
Inherited from
LatexBlockModel_base.index
Defined in
packages/affine/model/dist/blocks/latex/latex-model.d.ts:5
index$
index$:
Signal<string>
Inherited from
LatexBlockModel_base.index$
isEmpty
isEmpty:
ReadonlySignal<boolean>
Inherited from
LatexBlockModel_base.isEmpty
Defined in
packages/framework/store/dist/schema/base.d.ts:118
keys
keys:
string[]
Inherited from
LatexBlockModel_base.keys
Defined in
packages/framework/store/dist/schema/base.d.ts:119
latex
latex:
string
Inherited from
LatexBlockModel_base.latex
Defined in
packages/affine/model/dist/blocks/latex/latex-model.d.ts:8
latex$
latex$:
Signal<string>
Inherited from
LatexBlockModel_base.latex$
page
page:
Doc
Deprecated
use doc instead
Inherited from
LatexBlockModel_base.page
Defined in
packages/framework/store/dist/schema/base.d.ts:109
pop()
pop: (
prop) =>void
Parameters
• prop: "xywh" | "index" | "rotate" | "latex" | "scale"
Returns
void
Inherited from
LatexBlockModel_base.pop
Defined in
packages/framework/store/dist/schema/base.d.ts:121
propsUpdated
propsUpdated:
Slot<object>
Type declaration
key
key:
string
Inherited from
LatexBlockModel_base.propsUpdated
Defined in
packages/framework/store/dist/schema/base.d.ts:122
role
role:
"root"|"hub"|"content"
Inherited from
LatexBlockModel_base.role
Defined in
packages/framework/store/dist/schema/base.d.ts:125
rotate
rotate:
number
Inherited from
LatexBlockModel_base.rotate
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:13
rotate$
rotate$:
Signal<number>
Inherited from
LatexBlockModel_base.rotate$
scale
scale:
number
Inherited from
LatexBlockModel_base.scale
Defined in
packages/affine/model/dist/blocks/latex/latex-model.d.ts:6
scale$
scale$:
Signal<number>
Inherited from
LatexBlockModel_base.scale$
stash()
stash: (
prop) =>void
Parameters
• prop: "xywh" | "index" | "rotate" | "latex" | "scale"
Returns
void
Inherited from
LatexBlockModel_base.stash
Defined in
packages/framework/store/dist/schema/base.d.ts:126
text?
optionaltext:Text
Inherited from
LatexBlockModel_base.text
Defined in
packages/framework/store/dist/schema/base.d.ts:127
version
version:
number
Inherited from
LatexBlockModel_base.version
Defined in
packages/framework/store/dist/schema/base.d.ts:128
xywh
xywh: `[${number},${number},${number},${number}]`
Inherited from
LatexBlockModel_base.xywh
Defined in
packages/affine/model/dist/blocks/latex/latex-model.d.ts:4
xywh$
xywh$:
Signal<`[${number},${number},${number},${number}]`>
Inherited from
LatexBlockModel_base.xywh$
yBlock
yBlock:
YBlock
Inherited from
LatexBlockModel_base.yBlock
Defined in
packages/framework/store/dist/schema/base.d.ts:129
Accessors
children
getchildren():BlockModel<object,SignaledProps<object>>[]
Returns
BlockModel<object, SignaledProps<object>>[]
Inherited from
LatexBlockModel_base.children
Defined in
packages/framework/store/dist/schema/base.d.ts:130
container
getcontainer():null| GfxModel & GfxContainerElement
Returns
null | GfxModel & GfxContainerElement
Inherited from
LatexBlockModel_base.container
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:14
deserializedXYWH
getdeserializedXYWH():XYWH
Returns
XYWH
Inherited from
LatexBlockModel_base.deserializedXYWH
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:15
doc
getdoc():Doc
setdoc(doc):void
Parameters
• doc: Doc
Returns
Inherited from
LatexBlockModel_base.doc
Defined in
packages/framework/store/dist/schema/base.d.ts:131
elementBound
getelementBound():Bound
Returns
Bound
Inherited from
LatexBlockModel_base.elementBound
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:16
externalBound
getexternalBound():null|Bound
Returns
null | Bound
Inherited from
LatexBlockModel_base.externalBound
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:17
externalXYWH
getexternalXYWH():undefined| `[${number},${number},${number},${number}]`
setexternalXYWH(xywh):void
Parameters
• xywh: undefined | `[${number},${number},${number},${number}]`
Returns
undefined | `[${number},${number},${number},${number}]`
Inherited from
LatexBlockModel_base.externalXYWH
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:18
group
getgroup():null|SurfaceGroupLikeModel<BaseElementProps>
Returns
null | SurfaceGroupLikeModel<BaseElementProps>
Inherited from
LatexBlockModel_base.group
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:20
groups
getgroups():SurfaceGroupLikeModel<BaseElementProps>[]
Returns
SurfaceGroupLikeModel<BaseElementProps>[]
Inherited from
LatexBlockModel_base.groups
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:21
h
geth():number
Returns
number
Inherited from
LatexBlockModel_base.h
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:22
parent
getparent():null|BlockModel<object,SignaledProps<object>>
Returns
null | BlockModel<object, SignaledProps<object>>
Inherited from
LatexBlockModel_base.parent
Defined in
packages/framework/store/dist/schema/base.d.ts:133
surface
getsurface():null|SurfaceBlockModel
Returns
null | SurfaceBlockModel
Inherited from
LatexBlockModel_base.surface
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:23
w
getw():number
Returns
number
Inherited from
LatexBlockModel_base.w
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:24
x
getx():number
Returns
number
Inherited from
LatexBlockModel_base.x
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:25
y
gety():number
Returns
number
Inherited from
LatexBlockModel_base.y
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:26
Methods
[dispose]()
[dispose]():
void
Returns
void
Inherited from
LatexBlockModel_base.[dispose]
Defined in
packages/framework/store/dist/schema/base.d.ts:138
containsBound()
containsBound(
bounds):boolean
Parameters
• bounds: Bound
Returns
boolean
Implementation of
GfxElementGeometry.containsBound
Inherited from
LatexBlockModel_base.containsBound
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:27
dispose()
dispose():
void
Returns
void
Inherited from
LatexBlockModel_base.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
LatexBlockModel_base.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[]
Implementation of
GfxElementGeometry.getLineIntersections
Inherited from
LatexBlockModel_base.getLineIntersections
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:28
getNearestPoint()
getNearestPoint(
point):IVec
Parameters
• point: IVec
Returns
IVec
Implementation of
GfxElementGeometry.getNearestPoint
Inherited from
LatexBlockModel_base.getNearestPoint
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:29
getRelativePointLocation()
getRelativePointLocation(
relativePoint):PointLocation
Parameters
• relativePoint: IVec
Returns
PointLocation
Implementation of
GfxElementGeometry.getRelativePointLocation
Inherited from
LatexBlockModel_base.getRelativePointLocation
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:30
includesPoint()
includesPoint(
x,y,_,__):boolean
Parameters
• x: number
• y: number
• _: PointTestOptions
• __: EditorHost
Returns
boolean
Implementation of
GfxElementGeometry.includesPoint
Inherited from
LatexBlockModel_base.includesPoint
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:31
intersectsBound()
intersectsBound(
bound):boolean
Parameters
• bound: Bound
Returns
boolean
Implementation of
GfxElementGeometry.intersectsBound
Inherited from
LatexBlockModel_base.intersectsBound
Defined in
packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:32
lastChild()
lastChild():
null|BlockModel<object,SignaledProps<object>>
Returns
null | BlockModel<object, SignaledProps<object>>
Inherited from
LatexBlockModel_base.lastChild
Defined in
packages/framework/store/dist/schema/base.d.ts:137