Interface: IModalTool
Properties
id
readonlyid:string
Remarks
Unique ID for the tool
onModalToolActivation
onModalToolActivation:
EventSink<ModalToolLifecycleEventPayload>
Remarks
Provides lifecycle activation events for a modal tool
Methods
bindPropertyPane()
bindPropertyPane(
pane):void
Parameters
| Parameter | Type |
|---|---|
pane | IPropertyPane |
Returns
void
dispose()
dispose():
void
Returns
void
hide()
hide():
void
Returns
void
registerKeyBinding()
registerKeyBinding(
action,button,modifier?):void
Parameters
| Parameter | Type |
|---|---|
action | SupportedKeyboardActionTypes |
button | KeyboardKey |
modifier? | InputModifier |
Returns
void
registerMouseButtonBinding()
registerMouseButtonBinding(
action):void
Parameters
| Parameter | Type |
|---|---|
action | SupportedMouseActionTypes |
Returns
void
registerMouseDragBinding()
registerMouseDragBinding(
action):void
Parameters
| Parameter | Type |
|---|---|
action | SupportedMouseActionTypes |
Returns
void
registerMouseWheelBinding()
registerMouseWheelBinding(
action):void
Parameters
| Parameter | Type |
|---|---|
action | SupportedMouseActionTypes |
Returns
void
show()
show():
void
Returns
void
unregisterInputBindings()
unregisterInputBindings():
void
Returns
void