Class: IFCButton

IFCButton

Class representing a button within the GoIFCComponents framework. Provides functionality for creating and managing buttons with various options.

new IFCButton(ui, options, parent)

Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 40

Constructor for the IFCButton class.

Name	Type	Description
`ui`	GoIFCUI	The GoIFCUI instance to be associated with this button.
`options`	IFCButtonOptions	The options for this button.
`parent`	module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton	optional The parent button for this button, if any.

Members

active

Sets the active state of the button.

active

Gets the active state of the button.

Methods

addChild(button) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 308

Adds a child button to this button.

Name	Type	Description
`button`	module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton	The child button to add.

getChildren(id){module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 290

Retrieves a specific child button by its id.

Name	Type	Description
`id`	string	The id of the child button to retrieve.

Returns:

Type	Description
module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton	The child button with the specified id.

getChildrens(){Map.<string, module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton>} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 268

Retrieves the child buttons associated with this button.

Returns:

Type	Description
Map.<string, module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton>	The map of child buttons.

getChildrensArray(){Array.<module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton>} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 280

Retrieves the child buttons associated with this button as an array.

Returns:

Type	Description
Array.<module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton>	The array of child buttons.

getContainer(){HTMLElement} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 326

Retrieves the container element for this button.

Returns:

Type	Description
HTMLElement	The container element for this button.

getIFCContainer(){HTMLElement} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 353

Retrieves the IFC container element associated with this button.

Returns:

Type	Description
HTMLElement	The IFC container element associated with this button.

getLoader(){GoIFCLoader} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 344

Retrieves the GoIFCLoader instance associated with this button.

Returns:

Type	Description
GoIFCLoader	The GoIFCLoader instance associated with this button.

getOCComponents(){Components} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 362

Retrieves the OpenBIM Components instance associated with this button.

Returns:

Type	Description
Components	The OpenBIM Components instance associated with this button.

getOptions(){IFCButtonOptions} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 299

Retrieves the options for this button.

Returns:

Type	Description
IFCButtonOptions	The options for this button.

getParent(){module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton|undefined} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 130

Gets the parent button of this button.

Returns:

Type	Description
module:Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts~IFCButton \| undefined	The parent button, or undefined if there is no parent.

getUI(){GoIFCUI} Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 335

Retrieves the GoIFCUI instance associated with this button.

Returns:

Type	Description
GoIFCUI	The GoIFCUI instance associated with this button.

offClick(callback) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 114

Removes a click event listener from this button.

Name	Type	Description
`callback`	function	The callback function to remove.

offDblClick(callback) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 146

Removes a double-click event listener from this button.

Name	Type	Description
`callback`	function	The callback function to remove.

offOnHover(callback) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 122

Removes a hover event listener from this button.

Name	Type	Description
`callback`	function	The callback function to remove.

onClick(callback) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 181

Sets a callback function to be executed when the button is clicked.

Name	Type	Description
`callback`	function	The callback function to be executed on click.

onDblClick(callback) Interactions/IFC/interact/GoIFCComponents/subClasses/GoIFCUI/ifc-buttons/ifc.button/index.ts, line 138

Adds a double-click event listener to this button.

Name	Type	Description
`callback`	function	The callback function to execute on double-click.