Class BimCTContextMenu

Class representing a BimCT context menu.

Hierarchy

BimCTPopupMenu
- BimCTContextMenu

Constructors

constructor

new BimCTContextMenu(renderer: LocalBIMRenderer): BimCTContextMenu
Creates an instance of BimCTContextMenu.
Parameters
- renderer: LocalBIMRenderer
  
  The renderer associated with the context menu.
Returns BimCTContextMenu
Overrides BimCTPopupMenu.constructor
- Defined in gui/bimct-context-menu.ts:906

Accessors

popUpX

get popUpX(): number
Returns number
Inherited from BimCTPopupMenu.popUpX
- Defined in gui/bimct-context-menu.ts:720

popUpY

get popUpY(): number
Returns number
Inherited from BimCTPopupMenu.popUpY
- Defined in gui/bimct-context-menu.ts:724

renderer

get renderer(): LocalBIMRenderer
Gets the renderer associated with the popup menu.

Returns
The renderer.

Returns LocalBIMRenderer
Inherited from BimCTPopupMenu.renderer
- Defined in gui/bimct-context-menu.ts:588

showing

get showing(): boolean
Gets whether the menu is currently showing.

Returns
True if the menu is showing, otherwise false.

Returns boolean
Inherited from BimCTPopupMenu.showing
- Defined in gui/bimct-context-menu.ts:580

Methods

addCustomMenu

addCustomMenu(customMenu: BimCTCustomMenu): void
Adds a new custom menu that is placed on top of the context menu.
Parameters
- customMenu: BimCTCustomMenu
Returns void
- Defined in gui/bimct-context-menu.ts:914

addCustomMenuItem

addCustomMenuItem(customMenuItem: BimCTCustomMenuItem): void
Adds a custom menu item to the default custom menu
Parameters
- customMenuItem: BimCTCustomMenuItem
  
  The custom menu item to add.
Returns void
- Defined in gui/bimct-context-menu.ts:939

addSeperator

addSeperator(): void
Adds a separator to the menu.

Returns void
Inherited from BimCTPopupMenu.addSeperator
- Defined in gui/bimct-context-menu.ts:659

clearCustomMenuItems

clearCustomMenuItems(): void
Clears all custom menu items.

Returns void
- Defined in gui/bimct-context-menu.ts:946

clearCustomMenus

clearCustomMenus(): void
Clears all custom menus.

Returns void
- Defined in gui/bimct-context-menu.ts:953

constructMenu

constructMenu(x: number, y: number): Promise<void>
Constructs the context menu.
Parameters
- x: number
  
  The X coordinate for the menu.
- y: number
  
  The Y coordinate for the menu.
Returns Promise<void>
- Defined in gui/bimct-context-menu.ts:1086

createBoldItalicSubMenu

createBoldItalicSubMenu(text: string, isI18n: boolean, type: SUBMENU_TYPE): BimCTPopupSubMenuItem
Creates a bold and italic submenu.

Returns
The created submenu.
Parameters
- text: string
  
  The text of the submenu.
- isI18n: boolean
  
  Whether the text is internationalized.
- type: SUBMENU_TYPE
  
  The type of the submenu.
Returns BimCTPopupSubMenuItem
Inherited from BimCTPopupMenu.createBoldItalicSubMenu
- Defined in gui/bimct-context-menu.ts:634

createCheckMenuItem

createCheckMenuItem(text: string, isI18n: boolean, shortcut: string, checked: boolean, click: BimCTMenuEventCallback, enabled?: BimCTMenuEnabledCallback): BimCTPopupCheckMenuItem
Creates a check menu item.

Returns
The created menu item.
Parameters
- text: string
  
  The text of the menu item.
- isI18n: boolean
  
  Whether the text is internationalized.
- shortcut: string
  
  The shortcut key for the menu item.
- checked: boolean
  
  Whether the menu item is checked.
- click: BimCTMenuEventCallback
  
  The click event callback.
- Optional enabled: BimCTMenuEnabledCallback
  
  Callback to check if the menu item is enabled.
Returns BimCTPopupCheckMenuItem
Inherited from BimCTPopupMenu.createCheckMenuItem
- Defined in gui/bimct-context-menu.ts:619

createMenuItem

createMenuItem(text: string, isI18n: boolean, shortcut: string, click: BimCTMenuEventCallback, enabled?: BimCTMenuEnabledCallback, image?: string): BimCTPopupMenuItem
Creates a menu item.

Returns
The created menu item.
Parameters
- text: string
  
  The text of the menu item.
- isI18n: boolean
  
  Whether the text is internationalized.
- shortcut: string
  
  The shortcut key for the menu item.
- click: BimCTMenuEventCallback
  
  The click event callback.
- Optional enabled: BimCTMenuEnabledCallback
  
  Callback to check if the menu item is enabled.
- image: string = null
  
  The image for the menu item.
Returns BimCTPopupMenuItem
Inherited from BimCTPopupMenu.createMenuItem
- Defined in gui/bimct-context-menu.ts:602

createSubMenu

createSubMenu(text: string, isI18n: boolean, type: SUBMENU_TYPE, icon?: string): BimCTPopupSubMenuItem
Creates a submenu.

Returns
The created submenu.
Parameters
- text: string
  
  The text of the submenu.
- isI18n: boolean
  
  Whether the text is internationalized.
- type: SUBMENU_TYPE
  
  The type of the submenu.
- Optional icon: string
Returns BimCTPopupSubMenuItem
Inherited from BimCTPopupMenu.createSubMenu
- Defined in gui/bimct-context-menu.ts:649

delete

delete(): void
Deletes the popup menu.

Returns void
Inherited from BimCTPopupMenu.delete
- Defined in gui/bimct-context-menu.ts:843

divElement

divElement(): HTMLDivElement
Gets the HTML div element of the popup menu.

Returns
The HTML div element.

Returns HTMLDivElement
Inherited from BimCTPopupMenu.divElement
- Defined in gui/bimct-context-menu.ts:856

hide

hide(): boolean
Hides the context menu.

Returns
True if the menu was showing, otherwise false.

Returns boolean
Overrides BimCTPopupMenu.hide
- Defined in gui/bimct-context-menu.ts:991

isClickedOnMenu

isClickedOnMenu(clientX: number, clientY: number): boolean
Checks if the menu was clicked.

Returns
True if the menu was clicked, otherwise false.
Parameters
- clientX: number
  
  The X coordinate of the click.
- clientY: number
  
  The Y coordinate of the click.
Returns boolean
Inherited from BimCTPopupMenu.isClickedOnMenu
- Defined in gui/bimct-context-menu.ts:866

isShowing

isShowing(): boolean
Checks if the context menu is currently showing.

Returns
True if the context menu is showing, otherwise false.

Returns boolean
- Defined in gui/bimct-context-menu.ts:1006

remove

remove(item: BimCTMenuItem): void
Removes a menu item.
Parameters
- item: BimCTMenuItem
  
  The menu item to remove.
Returns void
Inherited from BimCTPopupMenu.remove
- Defined in gui/bimct-context-menu.ts:669

removeCustomMenu

removeCustomMenu(customMenu: BimCTCustomMenu): void
Removes a custom menu.
Parameters
- customMenu: BimCTCustomMenu
Returns void
- Defined in gui/bimct-context-menu.ts:922

setCustomMenuText

setCustomMenuText(text: string | BimCTTextCallback): void
Sets the custom menu text of the default custom menu.
Parameters
- text: string | BimCTTextCallback
  
  The custom menu text.
Returns void
- Defined in gui/bimct-context-menu.ts:931

show

show(event: UIEvent): void
Shows the context menu.
Parameters
- event: UIEvent
  
  The UI event that triggered the context menu.
Returns void
Overrides BimCTPopupMenu.show
- Defined in gui/bimct-context-menu.ts:961

Class BimCTContextMenu

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

renderer: LocalBIMRenderer

Returns BimCTContextMenu

Accessors

popUpX

Returns number

popUpY

Returns number

renderer

Returns

Returns LocalBIMRenderer

showing

Returns

Returns boolean

Methods

addCustomMenu

Parameters

customMenu: BimCTCustomMenu

Returns void

addCustomMenuItem

Parameters

customMenuItem: BimCTCustomMenuItem

Returns void

addSeperator

Returns void

clearCustomMenuItems

Returns void

clearCustomMenus

Returns void

constructMenu

Parameters

x: number

y: number

Returns Promise<void>

createBoldItalicSubMenu

Returns

Parameters

text: string

isI18n: boolean

type: SUBMENU_TYPE

Returns BimCTPopupSubMenuItem

createCheckMenuItem

Returns

Parameters

text: string

isI18n: boolean

shortcut: string

checked: boolean

click: BimCTMenuEventCallback

Optional enabled: BimCTMenuEnabledCallback

Returns BimCTPopupCheckMenuItem

createMenuItem

Returns

Parameters

text: string

isI18n: boolean

shortcut: string

click: BimCTMenuEventCallback

Optional enabled: BimCTMenuEnabledCallback

image: string = null

Returns BimCTPopupMenuItem

createSubMenu

Returns

Parameters

text: string

isI18n: boolean

type: SUBMENU_TYPE

Optional icon: string

Returns BimCTPopupSubMenuItem

delete

Returns void

divElement

`Optional` enabled: BimCTMenuEnabledCallback

`Optional` enabled: BimCTMenuEnabledCallback

`Optional` icon: string