Class OverlayMenuAction

Remarks

Menu action for overlay configuration (block overlays badge/border)

Hierarchy (View Summary)

SubMenuItem
- OverlayMenuAction

Index

Constructors

Properties

arrowSpan? canvas closedRotation config element? logger openedRotation subMenuContent? subMenuItems subMenuWrapper? trigger?

Accessors

Methods

close createElement destroy getArrowRotationForPosition getElement open toggle unwrap update updateDisabled updateVisible wrap

Constructors

constructor

new OverlayMenuAction(
    canvas: TInteractiveInkCanvas,
    idPrefix?: string,
    itemsConfig?: TOverlayActionItemsConfig,
): OverlayMenuAction
Parameters
- canvas: TInteractiveInkCanvas
- idPrefix: string = "ms-menu-action"
- OptionalitemsConfig: TOverlayActionItemsConfig
Returns OverlayMenuAction
Overrides SubMenuItem.constructor
- Defined in menu/actions/OverlayMenuAction.ts:24

Properties

`Protected` `Optional`arrowSpan

arrowSpan?: HTMLSpanElement

`Protected`canvas

canvas: TInteractiveInkCanvas

`Protected`closedRotation

closedRotation: number = 0

`Protected`config

config: TMenuSubMenu

`Protected` `Optional`element

element?: HTMLDivElement

`Protected`logger

logger: Logger = ...

`Protected`openedRotation

openedRotation: number = 180

`Protected` `Optional`subMenuContent

subMenuContent?: HTMLDivElement

`Protected`subMenuItems

subMenuItems: Map<string, BaseMenuItem<HTMLElement>> = ...

`Protected` `Optional`subMenuWrapper

subMenuWrapper?: HTMLElement

`Protected` `Optional`trigger

trigger?: HTMLButtonElement

Accessors

`Protected`dom

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

Methods

close

close(): void
Closes the submenu

Returns void
Inherited from SubMenuItem.close
- Defined in menu/items/SubMenuItem.ts:169

createElement

createElement(): HTMLDivElement
Creates the HTML element

Returns HTMLDivElement
Inherited from SubMenuItem.createElement
- Defined in menu/items/SubMenuItem.ts:64

destroy

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

Returns void
Inherited from SubMenuItem.destroy
- Defined in menu/items/SubMenuItem.ts:218

`Protected`getArrowRotationForPosition

getArrowRotationForPosition(position: TMenuPosition): number
Parameters
- position: TMenuPosition
Returns number
Inherited from SubMenuItem.getArrowRotationForPosition
- Defined in menu/items/SubMenuItem.ts:52

getElement

getElement(): HTMLDivElement
Returns the HTML element

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

open

open(): void
Opens the submenu

Returns void
Inherited from SubMenuItem.open
- Defined in menu/items/SubMenuItem.ts:159

toggle

toggle(): void
Toggles the submenu state

Returns void
Inherited from SubMenuItem.toggle
- Defined in menu/items/SubMenuItem.ts:179

unwrap

unwrap(): void
Unwraps the submenu (mobile mode)

Returns void
Inherited from SubMenuItem.unwrap
- Defined in menu/items/SubMenuItem.ts:190

update

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

Returns void
Inherited from SubMenuItem.update
- Defined in menu/items/SubMenuItem.ts:209

`Protected`updateDisabled

updateDisabled(): void
Updates the disabled state

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

`Protected`updateVisible

updateVisible(): void
Updates the visible state

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

wrap

wrap(): void
Wraps the submenu (desktop mode)

Returns void
Inherited from SubMenuItem.wrap
- Defined in menu/items/SubMenuItem.ts:201