Class EraseTool

Remarks

Erase tool - Element erasure with configurable size

Hierarchy (View Summary)

BaseMenuItem<HTMLDivElement>
- EraseTool

Index

Constructors

Properties

canvas config element? logger

Accessors

Methods

createElement destroy getElement update updateDisabled updateVisible

Constructors

constructor

new EraseTool(canvas: TInteractiveInkCanvas, idPrefix?: string): EraseTool
Parameters
- canvas: TInteractiveInkCanvas
- idPrefix: string = "ms-menu-tool"
Returns EraseTool
Overrides BaseMenuItem.constructor
- Defined in menu/tools/EraseTool.ts:24

Properties

`Protected`canvas

canvas: TInteractiveInkCanvas

`Protected`config

config: TGenericMenuItem

`Protected` `Optional`element

element?: HTMLDivElement

`Protected`logger

logger: Logger = ...

Accessors

`Protected`dom

get dom(): typeof DOMFactory
Returns typeof DOMFactory
Inherited from BaseMenuItem.dom
- Defined in menu/items/BaseMenuItem.ts:34

Methods

createElement

createElement(): HTMLDivElement
Creates the HTML element

Returns HTMLDivElement
Overrides BaseMenuItem.createElement
- Defined in menu/tools/EraseTool.ts:64

destroy

destroy(): void
Destroys the element and cleans up resources

Returns void
Overrides BaseMenuItem.destroy
- Defined in menu/tools/EraseTool.ts:109

getElement

getElement(): HTMLDivElement
Returns the HTML element

Returns HTMLDivElement
Inherited from BaseMenuItem.getElement
- Defined in menu/items/BaseMenuItem.ts:56

update

update(): void
Updates the element (for reactivity)

Returns void
Overrides BaseMenuItem.update
- Defined in menu/tools/EraseTool.ts:117

`Protected`updateDisabled

updateDisabled(): void
Updates the disabled state

Returns void
Inherited from BaseMenuItem.updateDisabled
- Defined in menu/items/BaseMenuItem.ts:66

`Protected`updateVisible

updateVisible(): void
Updates the visible state

Returns void
Inherited from BaseMenuItem.updateVisible
- Defined in menu/items/BaseMenuItem.ts:87