Class ria.legend.LegendEvent

A LegendEvent is passed to LegendControl.onOverlayToggled() once an overlayToggled event fires. It contains the name of the overlay that was toggled and whether it was turned on or off.

Method Summary
Method Attributes	Method Name and Description
getOverlayName() Returns the overlay name for the event.
isVisible() Returns the visibility state for the overlay for the event.

Constructor Detail

ria.legend.LegendEvent(overlayName, visible)

Parameters:
{String} overlayName: Name of the overlay that triggered the event
{Boolean} visible: Visibility state of the overlay

Method Detail

{String} getOverlayName()

Returns the overlay name for the event. The returned value is the property name of the overlayData object corresponding to the toggled overlay passed into ria.legend.LegendControl#renderData(data).

Returns:: {String} the name of the overlay

{Boolean} isVisible()

Returns the visibility state for the overlay for the event.

Returns:: {Boolean}