This is the DBUtils package which contains useful services that DBpixelhouse developers can utilize when developing in either 3DVista or React
Component | Type | Extends | Proxies | Parameters | Description |
---|---|---|---|---|---|
EventManager | Class | - | - | event{string}, fn{function}, context{object} | An EventEmitter environment to allow listening and emitting custom events, it includes an event cache to allow for the removal on specific event listeners even if there are multiple listeners cached for a type |
IFrameManager | Class | EventEmitter | - | scope{object}, options{object}, host{object}, bond{object} | Creates a communication bridge between the current window and a parent or child window, this allows data to be sent between the two environments using the EventManager |
openWindow | Function | - | WindowManager | url{string}, name{string}, options{object} | A quick way to open a window using the WindowManager, no need to call .open() as the window or tab will automatically open upon invoking this function |
Tracker | Function | - | TrackingManager | name{string}, options{object} | A shorthand way of creating or retrieving a TrackingManager environment, if the passed name exists this function will return the existing instance for said name, if not one will be created and then returned |
TrackingManager | Class | EventEmitter | - | name{string}, options{object} | Creates an environment for emitting tracking data to a given API endpoint, unless given a specific uuid the environment uses the uuid function to give the device being used a personal uuid that can be used in all calls |
uuid | Function | - | - | - | Using v4 of the uuid npm package this function will check the localStorage for an existing uuid value, if one is found it will be used, if nothing was found it will generate a new uuid and store it in the browsers localStorage |
WindowManager | Class | EventEmitter | - | url{string}, name{string}, options{object} | Creates a configuration scope for a browser tab or popup window, it can be opened and closed via code and has custom events 'opened' and 'closed' so code can be triggered upon those events |