Top-level namespace and entry point of the framework.
Classes
- Dom
- A scoped DOM wrapper, adding convenience functionality used to manipulate the element and restricts access to anything above the root element.
- Node
- An HTMLElement wrapper, adding convenience functionality used to manipulate the element.
Namespaces
- Detectors
- This namespace contains all the Detectors used by the framework.
- Dtos
- This namespace contains all the Dtos used by the framework.
- Errors
- Events
- Exceptions
- This namespace contains all the Exceptions used by the framework.
- Libraries
- Any libraries that are used are loaded into this namespace.
- ModuleAssets
- This namespace contains module assets.
- Modules
- Pdk
- This namespace contains controller base classes, module base classes, interfaces and other extendable functionality.
- Utils
- A collection of useful util functions.
- Widgets
Methods
-
staticGoBrain.create(container, embedSettings){GoBrain.Widgets.Widget}
GoBrain.Core/src/gobrain.js, line 479Creates a Widget.
-
Creates a Widget.
Name Type Description container
HTMLElement embedSettings
EmbedSettings - See:
Returns:
Type Description GoBrain.Widgets.Widget -
staticGoBrain.destroy(widgetId, deleteElement){GoBrain}
GoBrain.Core/src/gobrain.js, line 503Destroys a Widget.
-
Destroys a Widget.
Name Type Description widgetId
String deleteElement
Boolean optional Returns:
Type Description GoBrain -
staticGoBrain.initialize(embedSettings){GoBrain.Widgets.Widget}
GoBrain.Core/src/gobrain.js, line 456Initializes a Widget.
-
Initializes a Widget.
Name Type Description embedSettings
EmbedSettings - See:
Returns:
Type Description GoBrain.Widgets.Widget -
staticGoBrain.require(path, separator, object){Object}
GoBrain.Core/src/gobrain.js, line 517Creates a namespace if it doesn't exist.
-
Creates a namespace if it doesn't exist.
Name Type Description path
String separator
String object
Object optional Object to require a namespace within. Defaults to 'window'.
Returns:
Type Description Object -
staticGoBrain.widgets(id){GoBrain.Widgets.Widget|WidgetCollection|null}
GoBrain.Core/src/gobrain.js, line 540Gets a Widget from the WidgetCollection.
-
Gets a Widget from the WidgetCollection.
Name Type Description id
String Returns:
Type Description GoBrain.Widgets.Widget | WidgetCollection | null