ClientMapInfo (Geomajas server: Main

java.lang.Object
- org.geomajas.configuration.client.ClientMapInfo

All Implemented Interfaces:

Serializable, ClientWidgetInfo, IsInfo
```
@Api(allMethods=true)
public class ClientMapInfo
extends Object
implements ClientWidgetInfo
```
Map configuration.
Since version 1.10.0 this configuration object implements ClientWidgetInfo, so that it can be easily retrieved like any other widget configuration object.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClientMapInfo()

Constructors
Constructor and Description
`ClientMapInfo()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBackgroundColor()` Gets the background color of the map, expressed as a hexadecimal string (eg '#FFFFFF').
`String`	`getCrs()` Get the coordinate reference system of this map (SRS notation).
`UnitType`	`getDisplayUnitType()` Returns the display unit type of this map.
`String`	`getId()` Get the id of this map.
`org.geomajas.geometry.Bbox`	`getInitialBounds()` Returns the startup bounds/extent of this map.
`List<ClientLayerInfo>`	`getLayers()` Get the list of layers of this map.
`ClientLayerTreeInfo`	`getLayerTree()` Get the layer tree that belongs with this map.
`FeatureStyleInfo`	`getLineSelectStyle()` Get the line selection style for this map.
`org.geomajas.geometry.Bbox`	`getMaxBounds()` Returns the maximum bounds/extent of this map.
`float`	`getMaximumScale()` Deprecated. use `getScaleConfiguration()`
`double`	`getPixelLength()` Get the length in meters of a pixel on the map.
`FeatureStyleInfo`	`getPointSelectStyle()` Get the point selection style for this map.
`FeatureStyleInfo`	`getPolygonSelectStyle()` Get the polygon selection style for this map.
`int`	`getPrecision()` Get the precision of this map (number of decimals).
`ClientPreferredPixelsPerTile`	`getPreferredPixelsPerTile()` Get the preferred pixels per tile size you wish the client will fetch from the server.
`List<Double>`	`getResolutions()` Deprecated. use `getScaleConfiguration()`
`ScaleConfigurationInfo`	`getScaleConfiguration()` Retruns the scale configuration of this map.
`ClientToolbarInfo`	`getToolbar()` Get the tool bar that belongs with this map.
`double`	`getUnitLength()` Get the unit length of this map in actual meters.
`ClientUserDataInfo`	`getUserData()` Get the custom configuration data.
`BoundsLimitOption`	`getViewBoundsLimitOption()` Get configuration option for limiting the mapview's bounds.
`Map<String,ClientWidgetInfo>`	`getWidgetInfo()` Get configuration for (custom) map widgets.
`ClientWidgetInfo`	`getWidgetInfo(String widget)` Get configuration for a (custom) map widgets.
`boolean`	`isPanButtonsEnabled()` Should this map show pan buttons ?
`boolean`	`isResolutionsRelative()` Deprecated. use `getScaleConfiguration()`
`boolean`	`isScaleBarEnabled()` Should this map show a scalebar ?
`void`	`setBackgroundColor(String backgroundColor)` Set the background color of this map, expressed as a hexadecimal string (eg '#FFFFFF').
`void`	`setCrs(String crs)` Set the coordinate reference system of this map (SRS notation).
`void`	`setDisplayUnitType(UnitType displayUnitType)` Set the display unit type of this map.
`void`	`setId(String id)` Set the id of this map (auto-set by spring).
`void`	`setInitialBounds(org.geomajas.geometry.Bbox initialBounds)` Set the startup bounds/extent of this map.
`void`	`setLayers(List<ClientLayerInfo> layers)` Set the list of layers of this map.
`void`	`setLayerTree(ClientLayerTreeInfo layerTree)` Set layer tree that belongs with this map.
`void`	`setLineSelectStyle(FeatureStyleInfo lineSelectStyle)` Set the line selection style for this map.
`void`	`setMaxBounds(org.geomajas.geometry.Bbox maxBounds)` Sets the maximum bounds/extent of this map.
`void`	`setMaximumScale(float maximumScale)` Deprecated. use `setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)`
`void`	`setPanButtonsEnabled(boolean panButtonsEnabled)` Enable the pan buttons for this map.
`void`	`setPixelLength(double pixelLength)` Set the unit length in meters of a pixel the map (auto-set by Spring).
`void`	`setPointSelectStyle(FeatureStyleInfo pointSelectStyle)` Set the point selection style for this map.
`void`	`setPolygonSelectStyle(FeatureStyleInfo polygonSelectStyle)` Set the polygon selection style for this map.
`void`	`setPrecision(int precision)` Set the precision of this map (number of decimals).
`void`	`setPreferredPixelsPerTile(ClientPreferredPixelsPerTile preferredPixelsPerTile)` Set the preferred pixels per tile size you wish the client will fetch from the server.
`void`	`setResolutions(List<Double> resolutions)` Deprecated. use `setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)`
`void`	`setResolutionsRelative(boolean resolutionsRelative)` Deprecated. use `setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)`
`void`	`setScaleBarEnabled(boolean scaleBarEnabled)` Enable the scalebar for this map.
`void`	`setScaleConfiguration(ScaleConfigurationInfo scaleConfiguration)` Sets the scale configuration of this map.
`void`	`setToolbar(ClientToolbarInfo toolbar)` Set tool bar that belongs with this map.
`void`	`setUnitLength(double unitLength)` Set the unit length of the map (auto-set by Spring).
`void`	`setUserData(ClientUserDataInfo userData)` Set the custom configuration data you wish to pass to the client.
`void`	`setViewBoundsLimitOption(BoundsLimitOption viewBoundsLimitOption)` Sets the configuration option for limiting the mapview's bounds.
`void`	`setWidgetInfo(Map<String,ClientWidgetInfo> widgetInfo)` Set configuration for (custom) map widgets.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClientMapInfo
```
public ClientMapInfo()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the id of this map. This id is unique within the application.
    
    Returns:
    the unique id
  - setId
```
public void setId(String id)
```
    Set the id of this map (auto-set by spring). The id must not be globally unique, but must be unique within the application.
    
    Parameters:
    id - id
  - getBackgroundColor
```
public String getBackgroundColor()
```
    Gets the background color of the map, expressed as a hexadecimal string (eg '#FFFFFF').
    
    Returns:
    the hex string of the background color
  - setBackgroundColor
```
public void setBackgroundColor(String backgroundColor)
```
    Set the background color of this map, expressed as a hexadecimal string (eg '#FFFFFF').
    
    Parameters:
    backgroundColor - the hex string of the background color
  - getLineSelectStyle
```
public FeatureStyleInfo getLineSelectStyle()
```
    Get the line selection style for this map.
    
    Returns:
    the line selection style
  - setLineSelectStyle
```
public void setLineSelectStyle(FeatureStyleInfo lineSelectStyle)
```
    Set the line selection style for this map.
    
    Parameters:
    lineSelectStyle - line selection style
  - getPointSelectStyle
```
public FeatureStyleInfo getPointSelectStyle()
```
    Get the point selection style for this map.
    
    Returns:
    the point selection style
  - setPointSelectStyle
```
public void setPointSelectStyle(FeatureStyleInfo pointSelectStyle)
```
    Set the point selection style for this map.
    
    Parameters:
    pointSelectStyle - point selection style
  - getPolygonSelectStyle
```
public FeatureStyleInfo getPolygonSelectStyle()
```
    Get the polygon selection style for this map.
    
    Returns:
    the polygon selection style
  - setPolygonSelectStyle
```
public void setPolygonSelectStyle(FeatureStyleInfo polygonSelectStyle)
```
    Set the polygon selection style for this map.
    
    Parameters:
    polygonSelectStyle - polygon selection style
  - getCrs
```
public String getCrs()
```
    Get the coordinate reference system of this map (SRS notation).
    
    Returns:
    the CRS (SRS notation)
  - setCrs
```
public void setCrs(String crs)
```
    Set the coordinate reference system of this map (SRS notation).
    
    Parameters:
    crs - the CRS (SRS notation)
  - getPrecision
```
public int getPrecision()
```
    Get the precision of this map (number of decimals).
    
    Returns:
    the precision of this map (number of decimals)
  - setPrecision
```
public void setPrecision(int precision)
```
    Set the precision of this map (number of decimals).
    
    Parameters:
    precision - the precision of this map (number of decimals)
  - isScaleBarEnabled
```
public boolean isScaleBarEnabled()
```
    Should this map show a scalebar ?
    
    Returns:
    true if shown
  - setScaleBarEnabled
```
public void setScaleBarEnabled(boolean scaleBarEnabled)
```
    Enable the scalebar for this map.
    
    Parameters:
    scaleBarEnabled - true if enabled (shown)
  - isPanButtonsEnabled
```
public boolean isPanButtonsEnabled()
```
    Should this map show pan buttons ?
    
    Returns:
    true if shown
  - setPanButtonsEnabled
```
public void setPanButtonsEnabled(boolean panButtonsEnabled)
```
    Enable the pan buttons for this map.
    
    Parameters:
    panButtonsEnabled - true if enabled (shown)
  - getDisplayUnitType
```
public UnitType getDisplayUnitType()
```
    Returns the display unit type of this map. This unit type will be used in eg the scalebar.
    
    Returns:
    the display unit type
  - setDisplayUnitType
```
public void setDisplayUnitType(UnitType displayUnitType)
```
    Set the display unit type of this map.
    
    Parameters:
    displayUnitType - unit type of this map
  - getScaleConfiguration
```
public ScaleConfigurationInfo getScaleConfiguration()
```
    Retruns the scale configuration of this map.
    
    Returns:
    scale configuration.
    Since:
    
    1.7.0
  - setScaleConfiguration
```
public void setScaleConfiguration(ScaleConfigurationInfo scaleConfiguration)
```
    Sets the scale configuration of this map.
    
    Parameters:
    scaleConfiguration - the scale configuration
    Since:
    
    1.7.0
  - getMaximumScale
```
@Deprecated
public float getMaximumScale()
```
    Deprecated. use getScaleConfiguration()
    
    Returns the maximum scale (maximum zoom in) of this map. The minimum scale is indirectly determined from the maximum bounds. As a better alternative for this value, use getScaleConfiguration().
    
    Returns:
    the maximum scale (pixels/unit)
  - setMaximumScale
```
@Deprecated
public void setMaximumScale(float maximumScale)
```
    Deprecated. use setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)
    
    Set maximum scale (maximum zoom in) of this map. As a better alternative for this value, use getScaleConfiguration().
    
    Parameters:
    maximumScale - the maximum scale (pixels/unit)
  - getInitialBounds
```
public org.geomajas.geometry.Bbox getInitialBounds()
```
    Returns the startup bounds/extent of this map. Warning: the map's view will be fitted to the initial bounds, but the view's aspect ratio will not be affected !
    
    Returns:
    the initial bounds
  - setInitialBounds
```
public void setInitialBounds(org.geomajas.geometry.Bbox initialBounds)
```
    Set the startup bounds/extent of this map. Warning: the map's view will be fitted to the initial bounds, but the view's aspect ratio will not be affected !
    
    Parameters:
    initialBounds - initial bounds
  - getResolutions
```
@Deprecated
public List<Double> getResolutions()
```
    Deprecated. use getScaleConfiguration()
    
    Returns the list of resolutions (inverse scale values) allowed by this map. This determines the predefined scale levels at which this map will be shown. If this list is non-empty, the map will not adjust to arbitrary scale levels but will instead snap to one of the scale levels defined in this list when zooming.
    
    Returns:
    a list of resolutions (unit/pixel or pure number if relative)
  - setResolutions
```
@Deprecated
public void setResolutions(List<Double> resolutions)
```
    Deprecated. use setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)
    
    Sets the list of resolutions (inverse scale values) allowed by this map. This determines the predefined scale levels at which this map will be shown. If this list is non-empty, the map will not adjust to arbitrary scale levels but will instead snap to one of the scale levels defined in this list when zooming.
    
    Parameters:
    resolutions - a list of resolutions (unit/pixel or pure number if relative)
  - isResolutionsRelative
```
@Deprecated
public boolean isResolutionsRelative()
```
    Deprecated. use getScaleConfiguration()
    
    Are the resolutions relative ? If true, the resolutions are expressed as pure numbers and denote the ratio of the map unit and 1 m on the screen (as computed from the screen DPI).
    
    Returns:
    true if relative
  - setResolutionsRelative
```
@Deprecated
public void setResolutionsRelative(boolean resolutionsRelative)
```
    Deprecated. use setScaleConfiguration(org.geomajas.configuration.client.ScaleConfigurationInfo)
    
    If true, the resolutions are expressed as pure numbers and denote the ratio of the map unit and 1 m on the screen (as computed from the screen dpi).
    
    Parameters:
    resolutionsRelative - true if relative
  - getLayerTree
```
public ClientLayerTreeInfo getLayerTree()
```
    Get the layer tree that belongs with this map.
    
    Returns:
    the layer tree
  - setLayerTree
```
public void setLayerTree(ClientLayerTreeInfo layerTree)
```
    Set layer tree that belongs with this map.
    
    Parameters:
    layerTree - the layer tree
  - getToolbar
```
public ClientToolbarInfo getToolbar()
```
    Get the tool bar that belongs with this map.
    
    Returns:
    the tool bar
  - setToolbar
```
public void setToolbar(ClientToolbarInfo toolbar)
```
    Set tool bar that belongs with this map.
    
    Parameters:
    toolbar - the layer tree
  - getLayers
```
public List<ClientLayerInfo> getLayers()
```
    Get the list of layers of this map. The order is the drawing order.
    
    Returns:
    the layers
  - setLayers
```
public void setLayers(List<ClientLayerInfo> layers)
```
    Set the list of layers of this map. The order is the drawing order.
    
    Parameters:
    layers - the layers
  - getUnitLength
```
public double getUnitLength()
```
    Get the unit length of this map in actual meters. This is an approximate value in the horizontal direction and in the initial center of the map.
    
    Returns:
    unit length in m
  - setUnitLength
```
public void setUnitLength(double unitLength)
```
    Set the unit length of the map (auto-set by Spring).
    
    Parameters:
    unitLength - unit length in m
  - getPixelLength
```
public double getPixelLength()
```
    Get the length in meters of a pixel on the map.
    
    Returns:
    length in meters of a pixel on the map (measured at the center of the map)
  - setPixelLength
```
public void setPixelLength(double pixelLength)
```
    Set the unit length in meters of a pixel the map (auto-set by Spring).
    
    Parameters:
    pixelLength - length of pixel in m
  - getMaxBounds
```
public org.geomajas.geometry.Bbox getMaxBounds()
```
    Returns the maximum bounds/extent of this map.
    
    Returns:
    the maximum bounds
  - setMaxBounds
```
public void setMaxBounds(org.geomajas.geometry.Bbox maxBounds)
```
    Sets the maximum bounds/extent of this map.
    
    Parameters:
    maxBounds - the maximum bounds
  - getViewBoundsLimitOption
```
public BoundsLimitOption getViewBoundsLimitOption()
```
    Get configuration option for limiting the mapview's bounds.
    
    Returns:
    BoundsLimitOption The current value of the configuration item for limiting the mapview's bounds when applying the maxBounds limitation.
    Since:
    
    1.10.0
  - setViewBoundsLimitOption
```
public void setViewBoundsLimitOption(BoundsLimitOption viewBoundsLimitOption)
```
    Sets the configuration option for limiting the mapview's bounds.
    
    Parameters:
    viewBoundsLimitOption - The desired value of the configuration item for limiting the mapview's bounds when applying the maxBounds limitation.
    Since:
    
    1.10.0
  - getWidgetInfo
```
@Api
public Map<String,ClientWidgetInfo> getWidgetInfo()
```
    Get configuration for (custom) map widgets.
    
    Returns:
    map keyed on widget id containing widget configurations
    Since:
    
    1.8.0
  - getWidgetInfo
```
@Api
public ClientWidgetInfo getWidgetInfo(String widget)
```
    Get configuration for a (custom) map widgets.
    
    Parameters:
    widget - widget key
    
    Returns:
    widget configuration
    Since:
    
    1.8.0
  - setWidgetInfo
```
public void setWidgetInfo(Map<String,ClientWidgetInfo> widgetInfo)
```
    Set configuration for (custom) map widgets.
    
    Parameters:
    widgetInfo - map keyed on widget id containing widget configurations
    Since:
    
    1.8.0
  - getUserData
```
public ClientUserDataInfo getUserData()
```
    Get the custom configuration data. The idea is that you extend this object, so that you can store any information you want.
    
    Returns:
    custom configuration data
  - setUserData
```
public void setUserData(ClientUserDataInfo userData)
```
    Set the custom configuration data you wish to pass to the client. The idea is that you extend this object, so that you can store any information you want.
    
    Parameters:
    userData - Custom configuration data
  - setPreferredPixelsPerTile
```
@Api
public void setPreferredPixelsPerTile(ClientPreferredPixelsPerTile preferredPixelsPerTile)
```
    Set the preferred pixels per tile size you wish the client will fetch from the server. This allows some tweaks for performance. The default is closest to 256x256 pixels.
    
    Parameters:
    preferredPixelsPerTile - the preferredPixelsPerTile to set
    Since:
    
    1.9.0
  - getPreferredPixelsPerTile
```
@Api
public ClientPreferredPixelsPerTile getPreferredPixelsPerTile()
```
    Get the preferred pixels per tile size you wish the client will fetch from the server. This allows some tweaks for performance. The default is closest to 256x256 pixels.
    
    Returns:
    the preferredPixelsPerTile
    Since:
    
    1.9.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClientMapInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientMapInfo

Method Detail

getId

setId

getBackgroundColor

setBackgroundColor

getLineSelectStyle

setLineSelectStyle

getPointSelectStyle

setPointSelectStyle

getPolygonSelectStyle

setPolygonSelectStyle

getCrs

setCrs

getPrecision

setPrecision

isScaleBarEnabled

setScaleBarEnabled

isPanButtonsEnabled

setPanButtonsEnabled

getDisplayUnitType

setDisplayUnitType

getScaleConfiguration

setScaleConfiguration

getMaximumScale

setMaximumScale

getInitialBounds

setInitialBounds

getResolutions

setResolutions

isResolutionsRelative

setResolutionsRelative

getLayerTree

setLayerTree

getToolbar

setToolbar

getLayers

setLayers

getUnitLength

setUnitLength

getPixelLength

setPixelLength

getMaxBounds

setMaxBounds

getViewBoundsLimitOption

setViewBoundsLimitOption

getWidgetInfo

getWidgetInfo

setWidgetInfo

getUserData

setUserData

setPreferredPixelsPerTile

getPreferredPixelsPerTile

toString