Add a UI component to a custom div. Do not listen to event from here, pass in the props
the div id to insert the component in
the UI react component
Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
Returns the object whose event listener's callback is currently being invoked.
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
Generate a unique id if an id was not provided
an id to return if it was already passed
the generated id
Returns true if event was dispatched by the user agent, and false otherwise.
Returns the object to which event is dispatched (its target).
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
Returns the type of event, e.g. "click", "hashchange", or "submit".
Add new plugin
the plugin id
id of map to add this plugin to
the plugin class (React Component)
the plugin properties
Call map ready functions and the init callback once everything is done loading including plugins
Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
A function that will load each plugin on a map then checks if there are a next plugin to load
the map index to load the plugin at
the plugin index to load
Load plugins provided by map config
Load a package script on runtime
the package id to load
Get the instance of a map by it's ID to access API functions
the map id
map api functions
If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.
Check if map rendering / drawing is ready then run the callback function Timeout does not effect rendering speed, each map will cancel the previous timer after it renders so timing of rendering will be based on device specs.
a callback to make once the map has rendered
Delete a plugin
the id of the plugin to delete
the map id to remove the plugin from (if not provided then plugin will be removed from all maps)
Delete all plugins loaded in a map
the map id to remove the plugin from (if not provided then plugin will be removed from all maps)
Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.
When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
Generated using TypeDoc
export interface TypeApi extends API, Event, Projection, Plugin {} //#427