Initializes and returns a legend for the specified key and configuration options.
DOM element for the legend.
Aeris account used when requesting data for dynamic legends.
Key associated with the legend.
Configuration options.
Returns whether the listeners are registered for the specified event name.
Hides the legend DOM element.
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
Resets the legend by removing all existing images.
Sets whether to display data values in Metric units.
Sets the size of the legend.
Shows the legend DOM element.
Triggers the specified event so that all registered listeners will be executed with the specified parameters.
Event name to trigger
Returns the unit based on whether the legend is displaying values in Metric or Imperial.
Generated using TypeDoc
An image legend is an object that is responsible for displaying and managing multiple related legends within a single view along with title labels for each as required.
{LegendRenderable}