edu.ucdavis.cstars.client.dijits

Class Legend.Parameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.dijits.Legend.Parameters

Enclosing class:

Legend

public static class Legend.Parameters
extends com.google.gwt.core.client.JavaScriptObject

Parameters used to configure the dijit.

Method Summary

Methods

Modifier and Type	Method and Description
static Legend.Parameters	create()
void	setArrangement(Legend.LegendAlignment align) Specify the alignment of the legend within the HTML element where the legend is rendered.
void	setLayerInfos(Legend.LayerInfo layerInfo) Specify a subset of the layers in the map to display in the legend.
void	setMap(MapWidget map) Reference to the map.
void	setRespectCurrentMapScale(boolean respectScale) Optional.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Legend.Parameters create()

setArrangement

public final void setArrangement(Legend.LegendAlignment align)

Specify the alignment of the legend within the HTML element where the legend is rendered. The default value of ALIGN_LEFT displays the symbol on the left side of the label Optional

Parameters:

align -

setLayerInfos

public final void setLayerInfos(Legend.LayerInfo layerInfo)

Specify a subset of the layers in the map to display in the legend. If not set all layers in the map will display in the legend. Optional

Parameters:

layerInfo -

setMap

public final void setMap(MapWidget map)

Reference to the map. The map parameter is required. Required

Parameters:

map -

setRespectCurrentMapScale

public final void setRespectCurrentMapScale(boolean respectScale)

Optional. When true the legend will update with every scale change and displays only the layers and sub layers that are visible in the current map scale. When false, the legend does not update on every scale change and all layers and sub layers will be displayed. The default value is true.

Parameters:

respectScale -