Module actions/flyout

Index

Functions

Functions

closeComponent

closeComponent(id: string): ICloseComponentInFlyoutAction

Closes the component in the given flyout

export
Parameters
- id: string
Returns ICloseComponentInFlyoutAction

closeContextMenu

closeContextMenu(): ICloseContextMenuAction

Closes the context menu

since
0.13

Returns ICloseContextMenuAction

closeFlyout

closeFlyout(id: string): ICloseFlyoutAction

Closes the specified flyout menu

export
Parameters
- id: string
Returns ICloseFlyoutAction

openComponent

openComponent(id: string, metrics: IDOMElementMetrics, name: string, props: any): IOpenComponentInFlyoutAction

Load the specified component in the given flyout with the given component props

export
Parameters
- id: string
- metrics: IDOMElementMetrics
- name: string
- props: any
Returns IOpenComponentInFlyoutAction

openContextMenu

openContextMenu(position: { x: number; y: number }): IOpenContextMenuAction

Opens the context menu at the specific position

since
0.13

Parameters
- position: { x: number; y: number }
  
  The client x/y position
  - x: number
  - y: number
Returns IOpenContextMenuAction

openFlyout

openFlyout(id: string, metrics: IDOMElementMetrics): IOpenFlyoutAction

Opens the specified flyout menu

export
Parameters
- id: string
- metrics: IDOMElementMetrics
Returns IOpenFlyoutAction

Generated using TypeDoc