|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.MapDescription
public class MapDescription
The Map Description coclass contains settings of a map in the current document.
A MapServer service can have an associated tiled map cache. This cache is a collection of pre-rendered map tiles that are used for the display of the map service. A cache can either be a fused cache where all layers within the map service are cached or a Multi-layer cache where only select map layers are cached. Working with MapServer and a cached map service can be different than working with a map service without a cache. Though you will be able to query against a cached map service just as you would a non-cached map service, you will see differences when working with cached map service's MapDescription.
If the map service has a fused cache custom graphics, including the rendering of selected features, cannot be applied to the MapDescription. In addition, applying a new spatial reference on cached map services though IMapDescription will not work. The cached layers will not draw. You will need to use ITileCacheInfo to change the spatial reference.
Constructor Summary | |
---|---|
MapDescription()
Constructs a MapDescription using ArcGIS Engine. |
|
MapDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MapDescription theMapDescription = (MapDescription) obj; |
Method Summary | |
---|---|
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(Object o)
Compare this object with another |
IFillSymbol |
getBackgroundSymbol()
Background symbol of the Map. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IGraphicElements |
getCustomGraphics()
Custom graphics. |
IGeoTransformation |
getGeoTransformation()
On-the-fly geographic transformations. |
ILayerDescriptions |
getLayerDescriptions()
A collection of Layer Description objects, each describing a layer within the map (data frame). |
IMapArea |
getMapArea()
The display area of the map (data frame). |
double |
getMapRotation()
The angle/rotation of the map (data frame) in degrees, measured anti-clockwise. |
String |
getName()
The name of the map (data frame). |
IColor |
getSelectionColor()
The default selection color. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISpatialReference |
getSpatialReference()
The spatial reference of the map (data frame). |
ITimeReference |
getTimeReference()
Time reference used by the time aware content. |
int |
getTimeRelation()
Time relation for the time query. |
ITimeValue |
getTimeValue()
Time value that will be used by the time aware content of the map. |
IColor |
getTransparentColor()
The color that is transparent (100 %). |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setBackgroundSymbol(IFillSymbol fillSymbol)
Background symbol of the Map. |
void |
setCustomGraphics(IGraphicElements elements)
Custom graphics. |
void |
setGeoTransformationByRef(IGeoTransformation transformations)
On-the-fly geographic transformations. |
void |
setLayerDescriptions(ILayerDescriptions layerDescriptions)
A collection of Layer Description objects, each describing a layer within the map (data frame). |
void |
setMapArea(IMapArea area)
The display area of the map (data frame). |
void |
setMapRotation(double angleDegrees)
The angle/rotation of the map (data frame) in degrees, measured anti-clockwise. |
void |
setName(String name)
The name of the map (data frame). |
void |
setSelectionColor(IColor color)
The default selection color. |
void |
setSpatialReferenceByRef(ISpatialReference spatialReference)
The spatial reference of the map (data frame). |
void |
setTimeReferenceByRef(ITimeReference timeReference)
Time reference used by the time aware content. |
void |
setTimeRelation(int relation)
Time relation for the time query. |
void |
setTimeValueByRef(ITimeValue timeValue)
Time value that will be used by the time aware content of the map. |
void |
setTransparentColor(IColor color)
The color that is transparent (100 %). |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public MapDescription() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic MapDescription(Object obj) throws IOException
MapDescription theMapDescription = (MapDescription) obj;
obj
to MapDescription
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String getName() throws IOException, AutomationException
getName
in interface IMapDescription
getName
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface IMapDescription
setName
in interface IMapDescription2
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMapArea getMapArea() throws IOException, AutomationException
getMapArea
in interface IMapDescription
getMapArea
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapArea(IMapArea area) throws IOException, AutomationException
setMapArea
in interface IMapDescription
setMapArea
in interface IMapDescription2
area
- A reference to a com.esri.arcgis.carto.IMapArea (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayerDescriptions getLayerDescriptions() throws IOException, AutomationException
getLayerDescriptions
in interface IMapDescription
getLayerDescriptions
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescriptions(ILayerDescriptions layerDescriptions) throws IOException, AutomationException
setLayerDescriptions
in interface IMapDescription
setLayerDescriptions
in interface IMapDescription2
layerDescriptions
- A reference to a com.esri.arcgis.carto.ILayerDescriptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMapRotation() throws IOException, AutomationException
getMapRotation
in interface IMapDescription
getMapRotation
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapRotation(double angleDegrees) throws IOException, AutomationException
setMapRotation
in interface IMapDescription
setMapRotation
in interface IMapDescription2
angleDegrees
- The angleDegrees (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws IOException, AutomationException
getSpatialReference
in interface IMapDescription
getSpatialReference
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference spatialReference) throws IOException, AutomationException
setSpatialReferenceByRef
in interface IMapDescription
setSpatialReferenceByRef
in interface IMapDescription2
spatialReference
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGraphicElements getCustomGraphics() throws IOException, AutomationException
Use CustomGraphics to display text or geometric shapes on the map. When interacting with the display of labels, CustomGraphics will honor the Feature Weight value for the default graphics layer set in the Label Weight Ranking dialog in the map document. A setting of High, the ArcMap default, will result in labels not drawing within the bounds of the custom graphics. If the Feature Weight for the default graphics layer is None, Low or Medium labels will draw within the bounds of the custom graphics. With None, all labels should display. With Low or Medium, the amount of labels that draw may vary.
Please note that the optimized MapServer only supports the esriSFSSolid style of ISimpleFillSymbol. For other types of fills, use other fill symbol types such as ILineSymbol. For hollow symbols, you should use IColor::NullColor with esriSFSSolid instead of using the esriSFSNull style.
getCustomGraphics
in interface IMapDescription
getCustomGraphics
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomGraphics(IGraphicElements elements) throws IOException, AutomationException
setCustomGraphics
in interface IMapDescription
setCustomGraphics
in interface IMapDescription2
elements
- A reference to a com.esri.arcgis.carto.IGraphicElements (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getTransparentColor() throws IOException, AutomationException
getTransparentColor
in interface IMapDescription
getTransparentColor
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTransparentColor(IColor color) throws IOException, AutomationException
setTransparentColor
in interface IMapDescription
setTransparentColor
in interface IMapDescription2
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getSelectionColor() throws IOException, AutomationException
getSelectionColor
in interface IMapDescription
getSelectionColor
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectionColor(IColor color) throws IOException, AutomationException
setSelectionColor
in interface IMapDescription
setSelectionColor
in interface IMapDescription2
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFillSymbol getBackgroundSymbol() throws IOException, AutomationException
If the background symbol and color are not explicitly set in the original map document (.mxd), the default background symbol a solid-filled symbol with an off-white color (RGB value of 253,253,253).
getBackgroundSymbol
in interface IMapDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackgroundSymbol(IFillSymbol fillSymbol) throws IOException, AutomationException
setBackgroundSymbol
in interface IMapDescription2
fillSymbol
- A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeValue getTimeValue() throws IOException, AutomationException
getTimeValue
in interface IMapTimeDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeValueByRef(ITimeValue timeValue) throws IOException, AutomationException
setTimeValueByRef
in interface IMapTimeDescription
timeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeReference getTimeReference() throws IOException, AutomationException
You should set this property when the TimeValue that you are passing in is in different timezone that any of the dataframe's or layer's TimeReference in the MapServer.
When TimeReference is set to Null/Nothing, MapServer assumes the TimeValue is in layer's TimeReference while searching features from layer. For example, there may be two layers in the map, one is in Pacific Standard Time (PST) and the other is in Eastern Standard Time (EST). If the TimeValue you are passing in is PST, but you have TimeReference is set to Null, when MapServer searches for feature for the first layer, it will assume the input TimeValue is in PST and find the correct features. While it searches for the features from the second layer, it will assume the input TimeValue is in EST and will get incorrect features.
getTimeReference
in interface IMapTimeDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeReferenceByRef(ITimeReference timeReference) throws IOException, AutomationException
setTimeReferenceByRef
in interface IMapTimeDescription
timeReference
- A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTimeRelation() throws IOException, AutomationException
getTimeRelation
in interface IMapTimeDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeRelation(int relation) throws IOException, AutomationException
setTimeRelation
in interface IMapTimeDescription2
relation
- A com.esri.arcgis.system.esriTimeRelation constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setGeoTransformationByRef(IGeoTransformation transformations) throws IOException, AutomationException
setGeoTransformationByRef
in interface IMapServerGeoTransformation
transformations
- A reference to a com.esri.arcgis.geometry.IGeoTransformation (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoTransformation getGeoTransformation() throws IOException, AutomationException
GeoTransformation provides access to members that define a geographic (datum) transformation.
getGeoTransformation
in interface IMapServerGeoTransformation
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |