API Reference
@univerjs
@univerjs/ui
interfaces
Ilayoutservice

@univerjs/ui v0.1.17Docs


Interface: ILayoutService

Properties

PropertyModifierTypeDefined in
isFocusedreadonlybooleanpackages/ui/src/services/layout/layout.service.ts:36 (opens in a new tab)

Accessors

rootContainerElement

get rootContainerElement(): Nullable<HTMLElement>

Returns

Nullable<HTMLElement>

Defined in

packages/ui/src/services/layout/layout.service.ts:38 (opens in a new tab)

Methods

checkCanvasIsFocused()

checkCanvasIsFocused(): boolean

Returns

boolean

Defined in

packages/ui/src/services/layout/layout.service.ts:54 (opens in a new tab)


checkElementInCurrentContainers()

checkElementInCurrentContainers(element): boolean

Parameters

ParameterType
elementHTMLElement

Returns

boolean

Defined in

packages/ui/src/services/layout/layout.service.ts:53 (opens in a new tab)


focus()

focus(): void

Re-focus the currently focused Univer business instance.

Returns

void

Defined in

packages/ui/src/services/layout/layout.service.ts:40 (opens in a new tab)


getCanvasElement()

getCanvasElement(): HTMLCanvasElement

Returns

HTMLCanvasElement

Defined in

packages/ui/src/services/layout/layout.service.ts:51 (opens in a new tab)


registerCanvasElement()

registerCanvasElement(container): IDisposable

Register a canvas element.

Parameters

ParameterType
containerHTMLCanvasElement

Returns

IDisposable

Defined in

packages/ui/src/services/layout/layout.service.ts:47 (opens in a new tab)


registerContainerElement()

registerContainerElement(container): IDisposable

Register an element as a container, especially floating components like Dialogs and Notifications.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable

Defined in

packages/ui/src/services/layout/layout.service.ts:49 (opens in a new tab)


registerFocusHandler()

registerFocusHandler(type, handler): IDisposable

Register a focus handler to focus on certain type of Univer unit.

Parameters

ParameterType
typeUniverInstanceType
handlerFocusHandlerFn

Returns

IDisposable

Defined in

packages/ui/src/services/layout/layout.service.ts:43 (opens in a new tab)


registerRootContainerElement()

registerRootContainerElement(container): IDisposable

Register the root container element.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable

Defined in

packages/ui/src/services/layout/layout.service.ts:45 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.