@univerjs/engine-render v0.5.0-beta.1 • Docs

Class: DocumentSkeleton

Extends

Skeleton

Constructors

new DocumentSkeleton()

new DocumentSkeleton(_docViewModel, localeService): DocumentSkeleton

Parameters

Parameter	Type
`_docViewModel`	`DocumentViewModel`
`localeService`	`LocaleService`

Returns

DocumentSkeleton

Overrides

Skeleton.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:128

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Skeleton`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`_localeService`	`readonly`	`LocaleService`	`undefined`	`Skeleton`.`_localeService`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/skeleton.ts:25
`dirty$`	`readonly`	`Observable`<`boolean`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:115

Accessors

dirty

Get Signature

get dirty(): boolean

Returns

boolean

Inherited from

Skeleton.dirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/skeleton.ts:31

Methods

calculate()

calculate(bounds?): void

Layout the document. PS: This method has significant impact on performance.

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:154

dispose()

dispose(): void

Returns

void

Overrides

Skeleton.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:139

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Skeleton.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Skeleton.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100

findCharIndexByPosition()

findCharIndexByPosition(position): Nullable<number>

Parameters

Parameter	Type
`position`	`INodePosition`

Returns

Nullable<number>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:276

findEditAreaByCoord()

findEditAreaByCoord(
   coord, 
   pageLayoutType, 
   pageMarginLeft, 
   pageMarginTop): {
  editArea: DocumentEditArea;
  page: Nullable<IDocumentSkeletonPage>;
  pageNumber: number;
}

Parameters

Parameter	Type
`coord`	`Vector2`
`pageLayoutType`	`PageLayoutType`
`pageMarginLeft`	`number`
`pageMarginTop`	`number`

Returns

{
  editArea: DocumentEditArea;
  page: Nullable<IDocumentSkeletonPage>;
  pageNumber: number;
}

Name	Type	Defined in
`editArea`	`DocumentEditArea`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:426
`page`	`Nullable`<`IDocumentSkeletonPage`>	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:428
`pageNumber`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:427

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:420

findGlyphByPosition()

findGlyphByPosition(position): undefined | IDocumentSkeletonGlyph

Parameters

Parameter	Type
`position`	`Nullable`<`INodePosition`>

Returns

undefined | IDocumentSkeletonGlyph

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:362

findNodeByCharIndex()

findNodeByCharIndex(
   charIndex, 
   segmentId, 
segmentPageIndex): Nullable<IDocumentSkeletonGlyph>

Parameters

Parameter	Type	Default value
`charIndex`	`number`	`undefined`
`segmentId`	`string`	`''`
`segmentPageIndex`	`number`	`-1`

Returns

Nullable<IDocumentSkeletonGlyph>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:356

findNodeByCoord()

findNodeByCoord(
   coord, 
   pageLayoutType, 
   pageMarginLeft, 
   pageMarginTop, 
restrictions?): Nullable<INodeInfo>

Parameters

Parameter	Type
`coord`	`Vector2`
`pageLayoutType`	`PageLayoutType`
`pageMarginLeft`	`number`
`pageMarginTop`	`number`
`restrictions`?	`IFindNodeRestrictions`

Returns

Nullable<INodeInfo>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:493

findNodePositionByCharIndex()

findNodePositionByCharIndex(
   charIndex, 
   isBack, 
   segmentId, 
segmentPIndex): Nullable<INodePosition>

Parameters

Parameter	Type	Default value
`charIndex`	`number`	`undefined`
`isBack`	`boolean`	`true`
`segmentId`	`string`	`''`
`segmentPIndex`	`number`	`-1`

Returns

Nullable<INodePosition>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:299

findPositionByGlyph()

findPositionByGlyph(glyph, segmentPage): Nullable<INodeSearch>

Parameters

Parameter	Type
`glyph`	`IDocumentSkeletonGlyph`
`segmentPage`	`number`

Returns

Nullable<INodeSearch>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:213

getActualSize()

getActualSize(): {
  actualHeight: number;
  actualWidth: number;
}

Returns

{
  actualHeight: number;
  actualWidth: number;
}

Name	Type	Defined in
`actualHeight`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:186
`actualWidth`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:185

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:171

getFontLocale()

getFontLocale(): IFontLocale

Returns

IFontLocale

Inherited from

Skeleton.getFontLocale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/skeleton.ts:35

getPageSize()

getPageSize(): undefined | ISize

Returns

undefined | ISize

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:209

getSkeletonData()

getSkeletonData(): Nullable<IDocumentSkeletonCached>

Returns

Nullable<IDocumentSkeletonCached>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:167

getViewModel()

getViewModel(): DocumentViewModel

Returns

DocumentViewModel

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:146

makeDirty()

makeDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

Skeleton.makeDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/skeleton.ts:39

create()

static create(docViewModel, localeService): DocumentSkeleton

Parameters

Parameter	Type
`docViewModel`	`DocumentViewModel`
`localeService`	`LocaleService`

Returns

DocumentSkeleton

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/layout/doc-skeleton.ts:135

Docbackground Documentviewmodel