ENVELOPE

ENVELOPE

Used in: CONFIG   REQUEST   RESPONSE   MARKUP
Servers: Image   Query   Feature   Extract   Metadata   ArcMap
Parent elements: DATAFRAME   EXTRACT   FCLASS   FEATURE   FEATURES   IMAGE   LAYERINFO   LAYOUT   LAYOUTINFO   METADATA_DATASET   PARTITION   PROPERTIES   PUT_METADATA   SEARCH_METADATA   SPATIALFILTER

<ENVELOPE	Attribute Description Table
When parent element is ALL except PROPERTIES and SEARCH_METADATA: *maxx ="double"* *maxy ="double"* *minx ="double"* *miny ="double"* When parent element is PROPERTIES: *maxx ="double"* *maxy ="double"* *minx ="double"* *miny ="double"* name ="Initial_Extent \| Extent_Limit" [Initial_Extent] reaspect ="true \| false" [true] When parent element is SEARCH_METADATA: *maxx ="double"* *maxy ="double"* *minx ="double"* *miny ="double"* spatialoperator ="within \| overlaps" [overlaps] > No Child Elements </ENVELOPE >
Bold: Attribute or child element is required.

Description:

Provides a minimum and maximum x and y extent. In a request, the ENVELOPE extent is usually defined by the user. In a response, the ENVELOPE extent defines the boundary of the returned features. In a configuration file, ENVELOPE defines the initial extent of a map view. When used with metadata, the ENVELOPE defines the geographic extent of a document.

Restrictions:

Name is used only in viewer configuration files, most commonly default.axl, when parent element is PROPERTIES.
Reaspect is used only when parent element is PROPERTIES. It is valid only for Image Services and is ignored in Feature and ArcMap Image Services.

Notes:

When ENVELOPE is used as a child element to LAYOUTINFO or LAYOUT, the values for the envelope are in page units rather than map units.

Attribute Descriptions for ENVELOPE:

When parent element is ALL except PROPERTIES and SEARCH_METADATA:

Attribute	Usage	Back to Top
maxx	1 Right top x-coordinate. Units are in map units for all elements except LAYOUT and LAYOUTINFO, which are in page units.
maxy	2 Right top y-coordinate. Units are in map units for all elements except LAYOUT and LAYOUTINFO, which are in page units.
minx	3 Left bottom x-coordinate. Units are in map units for all elements except LAYOUT and LAYOUTINFO, which are in page units.
miny	4 Left bottom y-coordinate. Units are in map units for all elements except LAYOUT and LAYOUTINFO, which are in page units.

When parent element is PROPERTIES:

Attribute	Usage	Back to Top
maxx	1 Right top x-coordinate in map units.
maxy	2 Right top y-coordinate in map units.
minx	3 Left bottom x-coordinate in map units.
miny	4 Left bottom y-coordinate in map units.
name	5 Identifies the type of envelope extent in a viewer configuration file. Initial_Extent is the full extent drawn when a file is first accessed. Extent_Limit is the maximum extent allowable when zooming out. When an extent limit is used in a viewer configuration file, two ENVELOPE elements are needed: <PROPERTIES> <ENVELOPE minx="-61.1" miny="3.7" maxx="91.7" maxy="61.3" name="Initial_Extent"/> <ENVELOPE minx="-61.1" miny="3.7" maxx="91.7" maxy="61.3" name="Extent_Limit"/> <PROPERTIES> The two ENVELOPE extents do not need to be the same.
reaspect	6 Flag indicating whether the ENVELOPE should be stretched to fit the viewing area in the client. By default, the pixel width and height ratio stays the same. By setting reaspect to false, the pixel width and height are stretched. Valid only with Image Services.

When parent element is SEARCH_METADATA:

Attribute	Usage	Back to Top
maxx	1 Right top x-coordinate in map units.
maxy	2 Right top y-coordinate in map units.
minx	3 Left bottom x-coordinate in map units.
miny	4 Left bottom y-coordinate in map units.
spatialoperator	5 The restrictions on the envelope.

Examples for ENVELOPE:

Example 1: When limiting a metadata search to the region defined within the ENVELOPE.

Back to Top

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA operator="and">
        <ENVELOPE xmin="-176.98" ymin="18.93" xmax="-66.97" ymax="71.35" spatialoperator="within" />
        <TAGVALUE tag="metadata/dataqual/lineage/srcinfo/srccite/citeinfo/pubdate" greaterthan="1990" />
        <FULLTEXT word="cities"/>
        <SEARCH_METADATA operator="or">
          <TAGTEXT tag="metadata/idinfo/citation/citeinfo/geoform" word="data"/>
          <TAGTEXT tag="metadata/idinfo/citation/citeinfo/geoform" word="digital"/>
        </SEARCH_METADATA>
      </SEARCH_METADATA>
    </GET_METADATA>
  </REQUEST>
</ARCXML>

Example 2: Used in CONFIG to set the initial extent.

Back to Top

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>
      <LOCALE country="US" language="en" variant="" />
      <UIFONT color="0,0,0" name="Arial" size="12" style="regular" />
      <SCREEN dpi="96" />
    </ENVIRONMENT>
    <MAP>
      <PROPERTIES>
       <ENVELOPE minx="-178.2" miny="18.9" maxx="-66.9" maxy="71.4" name="Initial_Extent" />
       <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <WORKSPACES>
       <SHAPEWORKSPACE name="shp_ws-0" directory="<path to USA ESRIDATA>" />
      </WORKSPACES>
      <LAYER type="featureclass" name="STATES" visible="true" id="0">
       <DATASET name="STATES" type="polygon" workspace="shp_ws-0" />
       <SIMPLERENDERER>
         <SIMPLEPOLYGONSYMBOL fillcolor="255,255,153" filltype="solid" />
       </SIMPLERENDERER>
      </LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

Example 3: When in a GET_IMAGE REQUEST to set the selection area for the spatial filter (first ENVELOPE) and the overall extent of the map (second ENVELOPE).

Back to Top

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <REQUEST>
  <GET_IMAGE>
    <PROPERTIES>
      <ENVELOPE minx="-180" miny="-90" maxx="180" maxy="90" />
      <LAYERLIST>
        <LAYERDEF id="Cities">
          <SIMPLERENDERER>
            <SIMPLEMARKERSYMBOL size="16" color="0,0,0" />
          </SIMPLERENDERER>
         <SPATIALQUERY>
            <SPATIALFILTER relation="area_intersection">
            <ENVELOPE maxy="60" maxx="60" miny="0" minx="0" />
         </SPATIALFILTER>
         </SPATIALQUERY>
      </LAYERDEF>
      </LAYERLIST>
   </PROPERTIES>
  </GET_IMAGE>
  </REQUEST>
</ARCXML>

Example 4: Identifies the initial extent and the extent of a layer in a SERVICEINFO response.

Back to Top

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <RESPONSE>
    <SERVICEINFO>
      <ENVIRONMENT>
        <LOCALE language="en" country="US" />
        <UIFONT name="Arial" color="0,0,0" size="12" style="regular" />
        <SEPARATORS cs=" " ts=";"/>
        <SCREEN dpi="96"/>
        <IMAGELIMIT pixelcount="1048576" />
      </ENVIRONMENT>
      <PROPERTIES>
        <ENVELOPE minx="-180" miny="-90" maxx="180" maxy="90" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <LAYERINFO type="featureclass" visible="true" name="Cities" id="0">
        <FCLASS type="point">
          <ENVELOPE minx="-165.270004272461" miny="-53.1500015258789" maxx="177.130187988281" maxy="78.1999969482422" />
        </FCLASS>
      </LAYERINFO>
    </SERVICEINFO>
  </RESPONSE>
</ARCXML>

Example 5: When using in GET_LAYOUT. Note the ENVELOPE in the PROPERTIES section is in page units.

Back to Top

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_LAYOUT>
      <PROPERTIES>
        <ENVELOPE minx="0" miny="0" maxx="8.5" maxy="11" />
        <FILTERCOORDSYS id="54030" />
        <FEATURECOORDSYS id="54030" />
        <IMAGESIZE width="800" height="600" />
        <OUTPUT type="JPG" />
      </PROPERTIES>
      <DATAFRAME id="Layers" >
        <FILTERCOORDSYS id="4326" />
        <FEATURECOORDSYS id="4326" />
        <ENVELOPE minx="-121" miny="36" maxx="-112" maxy="44" />
      </DATAFRAME>
    </GET_LAYOUT>
  </REQUEST>
</ARCXML>