Class: UIBase

UIBase

UIBase is an abstract class providing a base structure for UI components. It manages the creation and manipulation of a container element, visibility, and event handling through an EventEmitter.

new UIBase()

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 7

Methods

emit(eventName, args)

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 86

Emits an event with the provided arguments.

Name Type Description
eventName string

The name of the event.

args any repeatable

Arguments to pass to the event handlers.

getContainer(){HTMLDivElement}

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 43

Retrieves the container element.

Returns:
Type Description
HTMLDivElement The container element.

getEventHandlers(eventName){Array.<function()>}

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 104

Retrieves all event handlers for a given event.

Name Type Description
eventName string

The name of the event.

Returns:
Type Description
Array.<function()> An array of event handlers.

hasEvent(eventName){boolean}

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 95

Checks if an event has any registered handlers.

Name Type Description
eventName string

The name of the event.

Returns:
Type Description
boolean True if the event has handlers, otherwise false.

off(eventName, callback)

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 77

Removes an event handler. If no callback is provided, removes all handlers for the event.

Name Type Description
eventName string optional

The name of the event.

callback function optional

The callback function to remove.

on(eventName, callback)

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 59

Registers an event handler that will be invoked every time the event is emitted.

Name Type Description
eventName string

The name of the event.

callback function

The callback function to handle the event.

once(eventName, callback)

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 68

Registers a one-time event handler that will be invoked only the next time the event is emitted.

Name Type Description
eventName string

The name of the event.

callback function

The callback function to handle the event.

setContainer()

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 50

set the container element.

setVisibility(visible)

Layers/GoVerticalRemoteSensing/clases/UI/components/UIBase/index.ts, line 34

Sets the visibility of the UI component.

Name Type Description
visible boolean

True to show the component, false to hide it.