Initializes and returns an info panel instance for the specified configuration options.
DOM element associated with the view.
Data used when rendering the view, if any.
Identifier associated with the view.
Configuration options.
Current component state.
Interface DOM targets, which are only available after the view has been rendered to the DOM.
A Boolean indicating whether the panel is currently visible.
Adds the view's element to the DOM by appending it to the specified target.
DOM target in which the view will be appended
Closes the info panel.
Returns the size required for the panel's content.
Returns the DOM element container for the view content.
Returns whether the listeners are registered for the specified event name.
Hides the view.
Loads and renders data for the current content view.
Updates the view's position to the specified x and y values with optional offsets. The view must be configured with absolute positioning.
Removes a registered listener function for the specified event.
Name of the event to remove the listener for.
Handler function to remove so it won't be executed next time the event is triggered.
Registers a listener function to be executed each time an event occurs
Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.
Handler function to be called when the event occurs
Registers a listener function to be executed the first time an event occurs.
Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.
Handler function to be called when the event occurs
Expands the panel if the panel is toggleable and collapsed.
Parent DOM target, if any. Parent will be null
if the view has not been added to the DOM.
Positions the view by pinning it relative to its parent container. The view must be configured with absolute positioning.
Anchor position of the view within its container
Removes the view from the DOM.
Resets the content view.
Adds a content view option to the panel and associates it with the specified key identifier.
Sets the maximum height for the panel. Depending on the internal content view, the actual rendered height may be less than the value provided.
Sets the measurement units to display.
Updates the component state with the provided properties. Only those state properties provided will be updated, while all other state properties will retain their existing values.
Sets the current title.
Assigns the UI targets according to the view's configured interface selectors.
Note that this method should only be called after the view has been rendered and added to the DOM.
Sets the width of the panel.
Shows the info panel with optional title and data. If data is provided, it will be used when rendering the current content view.
To change the content view used, see showContent()
.
Shows the info panel using the content view associated with the specified key
and with
optional title and data.
The key associated with the content view to use when rendering the panel content
Toggles the open/closed state.
Triggers the specified event so that all registered listeners will be executed with the specified parameters.
Event name to trigger
Updates the content view using the specified data.
Generated using TypeDoc
An
InfoPanel
is a panel component that is responsible for displaying a variety of content related to map data, such as markers and/or polygons, or requesting and rendering data assocated with a specific geographical coordinate.