public class MapParameter
extends java.lang.Object
implements java.io.Serializable
Map parameter
${services_components_commontypes_MapParameter_Description}
Modifier and Type | Field and Description |
---|---|
double |
angle
${services_components_commontypes_MapParameter_attribute_angle_Title}
|
boolean |
antialias
${services_components_commontypes_MapParameter_attribute_antialias_Title}
|
boolean |
autoAvoidEffectEnabled
Whether to enable automatic avoidance effect.
|
Style |
backgroundStyle
${services_components_commontypes_MapParameter_attribute_backgroundStyle_Title}
|
Rectangle2D |
bounds
The full range of the map.
|
boolean |
cacheEnabled
${services_components_commontypes_MapParameter_attribute_isCacheEnabled_Title}
|
Point2D |
center
${services_components_commontypes_MapParameter_attribute_center_Title}
|
Geometry |
clipRegion
${services_components_commontypes_MapParameter_attribute_clipRegion_Title}
|
boolean |
clipRegionEnabled
${services_components_commontypes_MapParameter_attribute_clipRegionEnabled_Title}
|
MapColorMode |
colorMode
${services_components_commontypes_MapParameter_attribute_colorMode_Title}
|
Unit |
coordUnit
${services_components_commontypes_MapParameter_attribute_coordUnit_Title}
|
Rectangle2D |
customEntireBounds
Customs the display range of full-size map.
|
boolean |
customEntireBoundsEnabled
Whether it is valid that customing the display range of full-size map.
|
java.lang.String |
customParams
${services_components_commontypes_MapParameter_attribute_customParams_Title}
|
PrjCoordSysType |
customPrjCoordSysType
Stores the projection type of coordinate set by users.
|
java.lang.String |
description
${services_components_commontypes_MapParameter_attribute_description_Title}
|
Unit |
distanceUnit
${services_components_commontypes_MapParameter_attribute_distanceUnit_Title}
|
boolean |
dynamicProjection
${services_components_commontypes_MapParameter_attribute_dynamicProjection_Title}
|
java.util.List<Layer> |
layers
${services_components_commontypes_MapParameter_attribute_layers_Title}
|
boolean |
markerAngleFixed
${services_components_commontypes_MapParameter_attribute_markerAngleFixed_Title}
|
double |
maxScale
${services_components_commontypes_MapParameter_attribute_maxScale_Title}
|
double |
maxVisibleTextSize
The maximum visible size of text, unit: mm.
|
int |
maxVisibleVertex
The maximum number of visible nodes of geometric object, geometric object will not be displayed if its nodes number is more than the specified number.
|
double |
minScale
${services_components_commontypes_MapParameter_attribute_minScale_Title}
|
double |
minVisibleTextSize
The minimum visible size of text, unit: mm.
|
java.lang.String |
name
${services_components_commontypes_MapParameter_attribute_name_Title}
|
boolean |
overlapDisplayed
In the same range, whether the map objects overlay to display, the default is False.
|
OverlapDisplayedOptions |
overlapDisplayedOptions
The map's gland filtering display option is valid when
overlapDisplayed is false. |
boolean |
paintBackground
${services_components_commontypes_MapParameter_attribute_paintBackground_Title}
|
PrjCoordSys |
prjCoordSys
${services_components_commontypes_MapParameter_attribute_prjCoordSys_Title}
|
RectifyType |
rectifyType
${services_components_commontypes_MapParameter_attribute_rectifyType_Title}
|
boolean |
returnImage
${services_components_commontypes_MapParameter_attribute_returnImage_Title}
|
ReturnType |
returnType
The returned type for image.
|
double |
scale
${services_components_commontypes_MapParameter_attribute_scale_Title}
|
boolean |
textAngleFixed
${services_components_commontypes_MapParameter_attribute_textAngleFixed_Title}
|
boolean |
textOrientationFixed
${services_components_commontypes_MapParameter_attribute_textOrientationFixed_Title}
|
java.lang.String |
tileversion |
TrackingLayer |
trackingLayer
The tracking layers.
|
UserInfo |
userToken
${services_components_commontypes_MapParameter_attribute_userToken_Title}
|
Rectangle2D |
viewBounds
The map range corresponding with viewer (
viewer , map image range) |
Rectangle |
viewer
View Also be called the range of map image.
|
double[] |
visibleScales
Returns the visible scale array of the map.
|
boolean |
visibleScalesEnabled
Returns whether or not to use a fixed scale to display the map.
|
Constructor and Description |
---|
MapParameter()
${services_components_commontypes_MapParameter_constructorByDefault_Title}
|
MapParameter(MapParameter mapParameter)
Constructs a new MapParameter object according to existed MapParameter object.
|
MapParameter(java.lang.String mapName) |
Modifier and Type | Method and Description |
---|---|
boolean |
compareLayerQueryable(java.util.List<Layer> targetLayers)
${services_components_commontypes_MapParameter_method_compareLayerQueryable_Title}
|
boolean |
compareLayerVisible(java.util.List<Layer> targetLayers)
${services_components_commontypes_MapParameter_method_compareLayerVisible_Title}
|
boolean |
equals(java.lang.Object obj)
${services_components_commontypes_MapParameter_method_equals_Title}
|
int |
hashCode()
${services_components_commontypes_MapParameter_method_hashCode_Title}
|
void |
rectify(MapParameter referMapParam)
${services_components_commontypes_MapParameter_method_rectifyByReferMapParam_Title}
|
void |
rectify(MapParameter referMapParam, RectifyType rectifyType)
${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_Title}
|
void |
standardize(MapParameter standardMapParam)
${services_components_commontypes_MapParameter_method_standardize_Title}
|
int |
toMapStatusHashCode()
Generates hash code of parameter related with map statues, without center point and the viewer range.
|
java.lang.String |
toString() |
java.lang.String |
toStringSimple() |
public double minScale
${services_components_commontypes_MapParameter_attribute_minScale_Title}
${services_components_commontypes_MapParameter_attribute_minScale_Description}
public double scale
${services_components_commontypes_MapParameter_attribute_scale_Title}
${services_components_commontypes_MapParameter_attribute_scale_Description}
public double maxScale
${services_components_commontypes_MapParameter_attribute_maxScale_Title}
${services_components_commontypes_MapParameter_attribute_maxScale_Description}
public java.lang.String name
${services_components_commontypes_MapParameter_attribute_name_Title}
${services_components_commontypes_MapParameter_attribute_name_Description}
public Point2D center
${services_components_commontypes_MapParameter_attribute_center_Title}
${services_components_commontypes_MapParameter_attribute_center_Description}
public Rectangle2D viewBounds
The map range corresponding with viewer (viewer
, map image range)
The unit is geographical coordinates.
public ReturnType returnType
The returned type for image.
Pictures can be returned in binary, file path, URL path, and so on. Valid when returnImage is true.
public Rectangle2D bounds
The full range of the map.
The unit is geographical coordinates.
public Rectangle viewer
View Also be called the range of map image.
When requesting a map image, it will ask how much picture (pixel coordinates, such as 512 * 512), that is, the range of the window.
public boolean returnImage
${services_components_commontypes_MapParameter_attribute_returnImage_Title}
${services_components_commontypes_MapParameter_attribute_returnImage_Description}
public java.util.List<Layer> layers
${services_components_commontypes_MapParameter_attribute_layers_Title}
${services_components_commontypes_MapParameter_attribute_layers_Description}
public TrackingLayer trackingLayer
The tracking layers.
The tracking layer is a transparent layer at the top of layers of the map, it is used to temporarily store some graphic objects, texts etc., and now it mainly used for storing the highlight information, that's the reason why it can also be called as highlight layer.
public PrjCoordSys prjCoordSys
${services_components_commontypes_MapParameter_attribute_prjCoordSys_Title}
${services_components_commontypes_MapParameter_attribute_prjCoordSys_Description}
public PrjCoordSysType customPrjCoordSysType
public boolean cacheEnabled
${services_components_commontypes_MapParameter_attribute_isCacheEnabled_Title}
${services_components_commontypes_MapParameter_attribute_isCacheEnabled_Description}
public java.lang.String customParams
${services_components_commontypes_MapParameter_attribute_customParams_Title}
${services_components_commontypes_MapParameter_attribute_customParams_Description}
public UserInfo userToken
${services_components_commontypes_MapParameter_attribute_userToken_Title}
${services_components_commontypes_MapParameter_attribute_userToken_Description}
public RectifyType rectifyType
${services_components_commontypes_MapParameter_attribute_rectifyType_Title}
${services_components_commontypes_MapParameter_attribute_rectifyType_Description}
public Geometry clipRegion
${services_components_commontypes_MapParameter_attribute_clipRegion_Title}
${services_components_commontypes_MapParameter_attribute_clipRegion_Description}
public boolean clipRegionEnabled
${services_components_commontypes_MapParameter_attribute_clipRegionEnabled_Title}
${services_components_commontypes_MapParameter_attribute_clipRegionEnabled_Description}
public Rectangle2D customEntireBounds
Customs the display range of full-size map.
When the property value of customEntireBoundsEnabled
is true, viewEntire() from component Map
will be used the range marked by this field to full extent map.
public boolean customEntireBoundsEnabled
Whether it is valid that customing the display range of full-size map.
When the property value is true, viewEntire() from component Map
will be used the range marked by this field customEntireBounds
to full extent map.
public double angle
${services_components_commontypes_MapParameter_attribute_angle_Title}
${services_components_commontypes_MapParameter_attribute_angle_Description}
public boolean antialias
${services_components_commontypes_MapParameter_attribute_antialias_Title}
${services_components_commontypes_MapParameter_attribute_antialias_Description}
public Style backgroundStyle
${services_components_commontypes_MapParameter_attribute_backgroundStyle_Title}
${services_components_commontypes_MapParameter_attribute_backgroundStyle_Description}
public MapColorMode colorMode
${services_components_commontypes_MapParameter_attribute_colorMode_Title}
${services_components_commontypes_MapParameter_attribute_colorMode_Description}
public Unit coordUnit
${services_components_commontypes_MapParameter_attribute_coordUnit_Title}
${services_components_commontypes_MapParameter_attribute_coordUnit_Description}
public Unit distanceUnit
${services_components_commontypes_MapParameter_attribute_distanceUnit_Title}
${services_components_commontypes_MapParameter_attribute_distanceUnit_Description}
public java.lang.String description
${services_components_commontypes_MapParameter_attribute_description_Title}
${services_components_commontypes_MapParameter_attribute_description_Description}
public boolean dynamicProjection
${services_components_commontypes_MapParameter_attribute_dynamicProjection_Title}
${services_components_commontypes_MapParameter_attribute_dynamicProjection_Description}
public boolean markerAngleFixed
${services_components_commontypes_MapParameter_attribute_markerAngleFixed_Title}
${services_components_commontypes_MapParameter_attribute_markerAngleFixed_Description}
public double maxVisibleTextSize
The maximum visible size of text, unit: mm.
The default value is 1000, That is, geometric object will not be displayed if its size is more than 1000 mm.
public int maxVisibleVertex
The maximum number of visible nodes of geometric object, geometric object will not be displayed if its nodes number is more than the specified number.
public double minVisibleTextSize
The minimum visible size of text, unit: mm.
The default value is 0.1.
public boolean overlapDisplayed
In the same range, whether the map objects overlay to display, the default is False.
If it is true, the same range of objects will be overlaid; Otherwise, controlling that the objects do not overlay through overlapDisplayedOptions
.
public OverlapDisplayedOptions overlapDisplayedOptions
The map's gland filtering display option is valid when overlapDisplayed
is false.
Used to enhance the handling of the map overlay display.
public boolean paintBackground
${services_components_commontypes_MapParameter_attribute_paintBackground_Title}
${services_components_commontypes_MapParameter_attribute_paintBackground_Description}
public boolean textAngleFixed
${services_components_commontypes_MapParameter_attribute_textAngleFixed_Title}
${services_components_commontypes_MapParameter_attribute_textAngleFixed_Description}
public boolean textOrientationFixed
${services_components_commontypes_MapParameter_attribute_textOrientationFixed_Title}
${services_components_commontypes_MapParameter_attribute_textOrientationFixed_Description}
public double[] visibleScales
Returns the visible scale array of the map.
public boolean visibleScalesEnabled
public boolean autoAvoidEffectEnabled
Whether to enable automatic avoidance effect.
public java.lang.String tileversion
public MapParameter()
${services_components_commontypes_MapParameter_constructorByDefault_Title}
${services_components_commontypes_MapParameter_constructorByDefault_Description}
public MapParameter(java.lang.String mapName)
public MapParameter(MapParameter mapParameter)
mapParameter
- ${services_components_commontypes_MapParameter_constructorByMapParameter_param_mapParameter}IllegalArgumentException${services_components_commontypes_MapParameter_constructorByMapParameter_exception_IllegalArgumentException}
public int hashCode()
${services_components_commontypes_MapParameter_method_hashCode_Title}
${services_components_commontypes_MapParameter_method_hashCode_Description}
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
${services_components_commontypes_MapParameter_method_equals_Title}
${services_components_commontypes_MapParameter_method_equals_Description}
equals
in class java.lang.Object
obj
- ${services_components_commontypes_MapParameter_method_equals_param_object}public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringSimple()
public boolean compareLayerQueryable(java.util.List<Layer> targetLayers)
${services_components_commontypes_MapParameter_method_compareLayerQueryable_Title}
${services_components_commontypes_MapParameter_method_compareLayerQueryable_Description}
targetLayers
- ${services_components_commontypes_MapParameter_method_compareLayerQueryable_param_targetLayers}public boolean compareLayerVisible(java.util.List<Layer> targetLayers)
${services_components_commontypes_MapParameter_method_compareLayerVisible_Title}
${services_components_commontypes_MapParameter_method_compareLayerVisible_Description}
targetLayers
- ${services_components_commontypes_MapParameter_method_compareLayerVisible_param_targetLayers}public void standardize(MapParameter standardMapParam)
${services_components_commontypes_MapParameter_method_standardize_Title}
${services_components_commontypes_MapParameter_method_standardize_Description}
standardMapParam
- ${services_components_commontypes_MapParameter_method_standardize_param_standardMapParam}public void rectify(MapParameter referMapParam)
${services_components_commontypes_MapParameter_method_rectifyByReferMapParam_Title}
${services_components_commontypes_MapParameter_method_rectifyByReferMapParam_Description}
referMapParam
- ${services_components_commontypes_MapParameter_method_rectifyByReferMapParam_param_referMapParam}public void rectify(MapParameter referMapParam, RectifyType rectifyType)
${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_Title}
${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_Description}
referMapParam
- ${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_param_referMapParam}rectifyType
- ${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_param_rectifyType}IllegalArgumentException${services_components_commontypes_MapParameter_method_rectifyByReferMapParamAndRectifyType_exception_IllegalArgumentException}
public int toMapStatusHashCode()