Initializes and returns a legend panel instance configured with the specified options.
DOM element associated with the view.
Data used when rendering the view, if any.
Identifier associated with the view.
The underlying legend view instance.
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
Collapses the panel if the panel is toggleable and expanded.
Returns the DOM element container for the view content.
Returns whether the listeners are registered for the specified event name.
Hides the 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
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.
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.
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.
Shows the view.
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
Generated using TypeDoc
A
LegendPanelis a panel component that renders and manages aLegendViewinstance.