com.sas.graphics.components.esrimap
Class ESRIMapModel

com.sas.graphics.components.esrimap.ESRIMapModel

public class ESRIMapModel

An ESRIMapModel encapsulates most of an ESRIMapChart's visual display properties. This contrasts with the ESRIMapChart's data model, which determines data properties.

A ESRIMapModel contains ESRIMapChart-specific properties, common graph properties, and a collection of models that control the appearance of the graph's peripheral elements, such as its legend.

An ESRIMapModel does not allow null values for properties in its contained models. Passing a null parameter to the set method for a contained model property results in an IllegalArgumentException. Guaranteeing non-null properties for a contained model simplifies access to the display properties and ensures that the MapComponent's display state is unambiguous.

Since:

SAS 9.1.3

See Also:

ESRIMapChart, BaseESRIMapChart, OLAPESRIMapChart, ESRIMapDataModel, GraphStyle

Constructor Summary

ESRIMapModel()
Constructs an ESRIMapModel which is assigned to a ESRIMapChart to define most of the display properties.

Method Summary

LegendModel	getLegendModel() Returns the model that encapsulates the display properties for the legend.
java.awt.Color	getSelectionColor() Returns the selection color used by the map
boolean	isDebug() Returns whether or not to print debug information about the map during rendering
void	setDebug(boolean debug) Turns on/off debug information when rendering the map.
void	setLegendModel(LegendModel legendModel) Sets the model that encapsulates the display properties for the legend.
void	setSelectionColor(java.awt.Color selectionColor) Sets the selection color used by the map

Methods inherited from class com.sas.graphics.components.GraphModel

apply, equals, getBackgroundFillStyle, getBrushModel, getDataElementStyles, getDataTipModel, getFrameLineStyle, getLogo, getLogoJustification, hashCode, isAntialiasedGraphics, isAntialiasedText, setAntialiasedGraphics, setAntialiasedText, setBackgroundFillStyle, setBrushModel, setDataElementStyles, setDataTipModel, setFrameLineStyle, setLogo, setLogoJustification

Methods inherited from class com.sas.graphics.components.ModelBase

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, setContainedModel

Constructor Detail

ESRIMapModel

public ESRIMapModel()

Constructs an ESRIMapModel which is assigned to a ESRIMapChart to define most of the display properties.

Method Detail

getLegendModel

public LegendModel getLegendModel()

Returns the model that encapsulates the display properties for the legend.

Returns:

the legend model that encapsulates the display properties for the legend.

See Also:

setLegendModel(com.sas.graphics.components.LegendModel)

setLegendModel

public void setLegendModel(LegendModel legendModel)

Sets the model that encapsulates the display properties for the legend.

The legend displays the association between fill style and data value or measure.

Parameters:

legendModel - a model that encapsulates legend display properties.

Throws:

java.lang.IllegalArgumentException - if legendModel is null.

See Also:

getLegendModel(), LegendModel.apply(com.sas.graphics.components.LegendModel)

isDebug

public boolean isDebug()

Returns whether or not to print debug information about the map during rendering

Returns:

whether debug info is shown

See Also:

setDebug(boolean)

setDebug

public void setDebug(boolean debug)

Turns on/off debug information when rendering the map. This is sometimes useful to see what service is being used, the value of the levelToLayer map and layerToField map, etc.

See Also:

isDebug()

getSelectionColor

public java.awt.Color getSelectionColor()

Returns the selection color used by the map

Returns:

the color

See Also:

setSelectionColor(java.awt.Color)

setSelectionColor

public void setSelectionColor(java.awt.Color selectionColor)

Sets the selection color used by the map

See Also:

getSelectionColor()