API Reference
@univerjs
@univerjs/ui
classes
Canvaspopupservice

@univerjs/ui v0.4.2Docs


Class: CanvasPopupService

Extends

Implements

Constructors

new CanvasPopupService()

new CanvasPopupService(): CanvasPopupService

Returns

CanvasPopupService

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
popups$readonlyObservable<[string, IPopup][]>undefined-packages/ui/src/services/popup/canvas-popup.service.ts:57 (opens in a new tab)

Accessors

activePopupId

get activePopupId(): Nullable<string>

which popup is under hovering now

Returns

Nullable<string>

Implementation of

ICanvasPopupService.activePopupId

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:62 (opens in a new tab)


popups

get popups(): [string, IPopup][]

Returns

[string, IPopup][]

Implementation of

ICanvasPopupService.popups

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:58 (opens in a new tab)

Methods

addPopup()

addPopup(item): string

Parameters

ParameterType
itemIPopup

Returns

string

Implementation of

ICanvasPopupService.addPopup

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:78 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:70 (opens in a new tab)


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


removeAll()

removeAll(): void

Returns

void

Implementation of

ICanvasPopupService.removeAll

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:101 (opens in a new tab)


removePopup()

removePopup(id): void

Parameters

ParameterType
idstring

Returns

void

Implementation of

ICanvasPopupService.removePopup

Defined in

packages/ui/src/services/popup/canvas-popup.service.ts:95 (opens in a new tab)


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