BlockSuite API Documentation / @blocksuite/blocks / AffinePieMenuWidget
Class: AffinePieMenuWidget
Extends
Constructors
new AffinePieMenuWidget()
new AffinePieMenuWidget():
AffinePieMenuWidget
Returns
Inherited from
Defined in
node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
Properties
_disposables
protected_disposables:DisposableGroup
Inherited from
Defined in
packages/framework/global/dist/utils/with-disposable.d.ts:5
disposables
readonlydisposables:DisposableGroup
Inherited from
Defined in
packages/framework/global/dist/utils/with-disposable.d.ts:6
handleEvent()
handleEvent: (
name,handler,options?) =>void
Parameters
name
"click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"
handler
options?
global
boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:9
mouse
mouse:
IVec
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:48
selectOnTrigRelease
selectOnTrigRelease:
object
allow
allow:
boolean
timeout?
optionaltimeout:Timeout
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:51
virtualKeyboardPolicy
virtualKeyboardPolicy:
string
Inherited from
WidgetComponent.virtualKeyboardPolicy
Defined in
packages/framework/global/dist/types/virtual-keyboard.d.ts:20
Accessors
block
Get Signature
get block():
B
Returns
B
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:12
currentMenu
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:158
doc
Get Signature
get doc():
Doc
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:13
flavour
Get Signature
get flavour():
string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:14
host
Get Signature
get host():
EditorHost
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:15
isEnabled
Get Signature
get isEnabled():
boolean
Returns
boolean
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:55
isOpen
Get Signature
get isOpen():
boolean
Returns
boolean
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:60
model
Get Signature
get model():
Model
Returns
Model
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:16
rootComponent
Get Signature
get rootComponent():
EdgelessRootBlockComponent
Returns
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:64
service
Get Signature
get service():
S
Returns
S
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:17
std
Get Signature
get std():
BlockStdScope
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:18
widgetId
Get Signature
get widgetId():
string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:19
Methods
_createMenu()
_createMenu(
schema,__namedParameters):PieMenu
Parameters
schema
PieMenuSchema
__namedParameters
widgetComponent
x
number
y
number
Returns
PieMenu
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:103
bindHotKey()
bindHotKey(
keymap,options?):void
Parameters
keymap
Record<string, UIEventHandler>
options?
global
boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:20
connectedCallback()
connectedCallback():
void
Invoked when the component is added to the document's DOM.
In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.
connectedCallback() {
super.connectedCallback();
addEventListener('keydown', this._handleKeydown);
}Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().
Returns
void
Overrides
WidgetComponent.connectedCallback
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:129
disconnectedCallback()
disconnectedCallback():
void
Invoked when the component is removed from the document's DOM.
This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.
disconnectedCallback() {
super.disconnectedCallback();
window.removeEventListener('keydown', this._handleKeydown);
}An element may be re-connected after being disconnected.
Returns
void
Overrides
WidgetComponent.disconnectedCallback
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:148
render()
render(): typeof
nothing|PieMenu
Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.
Returns
typeof nothing | PieMenu
Overrides
Defined in
packages/blocks/src/root-block/widgets/pie-menu/index.ts:153