OBJECT

Used in

Servers

Image

Parent elements

Syntax

<OBJECT	Attribute Description Table
(r)units="database \| pixel" alignment="bottom_left \| bottom_right \| center \| center_left \| center_right \| bottom_center \| top_left \| top_right \| top_center" [bottom_left] lower="string" [1:1] upper="string" [1:infinity] > For lines, option 1 using LINE: (r)<LINE... /> <COORDSYS... /> For lines, option 2 using POLYLINE and one symbol: (r)<POLYLINE... /> (r)<HASHLINESYMBOL... /> [Or] (r)<RASTERMARKERSYMBOL... /> [Or] (r)<SIMPLELINESYMBOL... /> [Or] (r)<SIMPLEMARKERSYMBOL... /> [Or] (r)<TRUETYPEMARKERSYMBOL... /> [Or] <COORDSYS... /> For points, option 1 using POINT: (r)<POINT... /> <COORDSYS... /> For points, option 2 using MULTIPOINT and one symbol: (r)<MULTIPOINT... /> (r)<RASTERMARKERSYMBOL... /> [Or] (r)<SIMPLEMARKERSYMBOL... /> [Or] (r)<TRUETYPEMARKERSYMBOL... /> [Or] <COORDSYS... /> For polygons, option 1 using POLYGON. RING and HOLE are not permitted: (r)<POLYGON... /> <COORDSYS... /> For polygons, option 2 using POLYGON and one symbol. RING and HOLE are permitted: (r)<POLYGON... /> (r)<GRADIENTFILLSYMBOL... /> [Or] (r)<HASHLINESYMBOL... /> [Or] (r)<RASTERFILLSYMBOL... /> [Or] (r)<RASTERMARKERSYMBOL... /> [Or] (r)<SIMPLELINESYMBOL... /> [Or] (r)<SIMPLEMARKERSYMBOL... /> [Or] (r)<SIMPLEPOLYGONSYMBOL... /> [Or] (r)<TRUETYPEMARKERSYMBOL... /> [Or] <COORDSYS... /> Other OBJECT child elements with Image Services: (r)<NORTHARROW... /> [Or] (r)<SCALEBAR... /> [Or] (r)<TEXT... /> [Or] <COORDSYS... /> </OBJECT >
(r): Attribute or child element is required.

Description

Defines an object to be placed on an acetate layer.

Restrictions

Acetate layers are designed to show a limited number of graphic features such as a northarrow, scalebar, some text, and one or two points, lines, or polygons. The acetate layer is not designed for displaying large numbers of features. If you add many features to an acetate layer, a noticeable degradation in response time and performance is likely. If too many features are added, the service may stop responding.
When drawing lines, point, or polygons on an acetate layer, either Option 1 or Option 2 can be used, but not both. If Option 2 is selected, one symbol is also required. NORTHARROW, SCALEBAR, and TEXT have only one option for specifying a location.
Acetate layers can only be used with Image Services in HTML Viewers.

Notes

In acetate layers, two options are available for defining the location of a point, line, or polygon. In Option 1 for points, POINT includes the geometry, and one symbol element must be included as a child element of POINT. In Option 2, MULTIPOINT includes the geometry. The symbol is included as a child element of OBJECT.

Option 1 for Points	Option 2 for Points
<OBJECT units="pixel"> <POINT coords="0 0"> <SYMBOL> <POINT> </OBJECT>	<OBJECT units="pixel" > <SYMBOL> <MULTIPOINT> <POINT x="0" y="0" /> </MULTIPOINT> </OBJECT>

In Option 1 for lines, LINE includes the geometry, and one symbol element must be included as a child element of LINE. In Option 2, POLYLINE, PATH, and either POINT or COORDS include the geometry. The symbol is included as a child element of OBJECT. Note that with Option 2, multiple PATHs can be included within one POLYLINE.

Option 1 for Lines	Option 2 for Lines
<OBJECT units="pixel"> <LINE coords="0 0;400 0;400 13;0 13"> <SYMBOL /> </LINE> </OBJECT>	<OBJECT units="database"> <SYMBOL /> <POLYLINE> <PATH> <COORDS>0 0;400 0;400 13;0 13</COORDS> </PATH> </POLYLINE> </OBJECT>

In Option 1 for polygons, POLYGON includes the geometry, and one symbol element must be included as a child element of POLYGON. In Option 2, POLYGON, RING, HOLE, and either POINT or COORDS include the geometry. The symbol is included as a child element of OBJECT. Note that with Option 2, multiple RINGS and HOLEs can be included within one POLGYON.

Option 1 for Polygons	Option 2 for Polygons
<OBJECT units="pixel"> <POLYGON coords="10 10;400 10;400 20;10 20;10 10"> <SYMBOL /> </POLYGON> </OBJECT>	<OBJECT units="database"> <SYMBOL /> <POLYGON> <RING> <POINT x="83.15" y="38.07" /> <POINT x="111.09" y="-4.70" /> <POINT x="155.10" y="-10.38" /> <POINT x="139.10" y="66.38" /> <POINT x="83.15" y="38.07" /> <HOLE> <COORDS>100.15 20.07;103.09 30.70;106.10 30.38;100.15 20.07</COORDS> </HOLE> </RING> </POLYGON> </OBJECT>

In order to project an acetate layer, COORDSYS must be included as a child element of OBJECT. COORDSYS is valid only when OBJECT units="database". The COORDSYS id should specify the current coordinate system of the x,y coordinates listed within the OBJECT.
Scales can be set in ArcXML using a relative scale or by calculating the number of map units per pixel. A relative scale represents the scale in a ratio such as 1:24000. In this example, 1 meter equals 24000 meters, or 1 inch equals 24000 inches. When using relative scale, always use a colon (:) between the two values.

Map units per pixel refers to the number of meters, feet, or decimal degrees represented by one pixel in a map. To convert from a relative scale to map units per pixel, the size of a pixel must first be calculated. The formula for finding the number of meters in a pixel is 0.0254 / dpi. The value 0.0254 is the number of meters in an inch, and dpi is the dpi set in the ArcIMS service or request. If no dpi is set in the service or request, the dpi is assumed to be 96. As an example of pixel size, if the dpi is 96, the pixel size is 0.0254 / 96 or 0.000265 m. To convert from a relative scale to map units per pixel:
1. If the scale is in meters. To calculate the number of meters per pixel, take the relative scale and multiply by 0.000265. For example, if the relative scale is 1:24000, then the number of meters per pixel is 24000 * 0.000265, or 6.36 meters.
2. If the scale is in feet. Do the calculation for meters (#1). Multiply the result by 3.28 (the number of feet in a meter). For example, if the number of meters per pixel is 6.36, the number of feet is 6.36 * 3.28, or 20.86 feet.
3. If the scale is in decimal degrees. For these calculations, the Earth is assumed to be an exact sphere with a circumference of 40030.174 km. One degree is 111.195 km (40030.174/360 degrees), or 111195 meters. To calculate the number of degrees, first do the calculation for meters (#1). Next, divide the result by 111195. For example, if the number of meters per pixel is 6.36, the number of degrees is 6.36 / 111195, or 0.0000571968.

Attribute Descriptions for OBJECT

Attribute	Usage
alignment	When an acetate object is placed on a map, the origin point 0,0 is in the bottom left corner of the image by default. When using SEPARATELAYER, the desired point of origin is often the center of the image. This attribute allows you to determine the 0,0 origin point in relation to the output image. Valid only when units="pixel". The following child elements can be aligned: SCALEBAR, NORTHARROW, TEXTMARKERSYMBOL, RASTERMARKERSYMBOL, and TRUETYPEMARKERSYMBOL.
lower	Minimum scale to display an object using a relative scale such as 1:24000. Scale can also be calculated as the number of map units per pixel.
units	Determines how coordinates for the object are specified. Coordinates can be specified two ways: Database. Refers to positioning an object using x,y coordinates in the coordinate system of the ArcIMS service or request. For example, if the service is in Robinson, then the coordinates for the object should also be in Robinson. If the coordinates for the object are different from the coordinate system used in the service or request, then COORDSYS should be used. <OBJECT...> <COORDSYS.../> ... </OBJECT> Pixel. Refers to positioning an object using x,y coordinates in pixels. The pixels along the left edge of the map frame have an x-coordinate of zero. The pixels along the bottom edge have a y-coordinate of zero.
upper	Maximum scale to display an object using a relative scale such as 1:24000. Scale can also be calculated as the number of map units per pixel.

Examples for OBJECT

Example 1: When in CONFIG.

<?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="-141.003006" miny="41.913319" maxx="-52.620281" maxy="83.108322" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
        <FEATURECOORDSYS id="4326" />
        <FILTERCOORDSYS id="4326" />
      </PROPERTIES>
      <WORKSPACES>
        <SHAPEWORKSPACE name="shp_ws-16" directory="<path to CANADA ESRIDATA>" />
      </WORKSPACES>
      <LAYER type="featureclass" name="province" visible="true" id="0">
        <DATASET name="province" type="polygon" workspace="shp_ws-16" />
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL fillcolor="227,127,227" filltype="solid" />
        </SIMPLERENDERER>
      </LAYER>
      <LAYER type="acetate" name="Selectedmark" id="acetate">
        <OBJECT units="pixel">
          <NORTHARROW type="4" size="15" coords="20 30" shadow="32,32,32" angle="0" antialiasing="true" overlap="false"/>
        </OBJECT>
      </LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

Example 2: When in a GET_IMAGE request.

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_IMAGE>
      <PROPERTIES>
      <ENVELOPE minx="-180" miny="-90" maxx="180" maxy="90" />
      <IMAGESIZE width="643" height="502" />
      </PROPERTIES>
      <LAYER type="acetate" name="acetate" id="acetate">
      <OBJECT units="pixel">
          <TEXT coords="100 100" label="You are here">
            <TEXTMARKERSYMBOL font="Arial" />
        </TEXT>
      </OBJECT>
      </LAYER>
    </GET_IMAGE>
  </REQUEST>
</ARCXML>

Example 3: When using POINT for one acetate layer and MULTIPOINT for a second acetate layer.

Example 4: When using POLYLINE for one acetate layer and LINE for a second acetate layer.

Example 5: When using POLYGON (Option 1) for one acetate layer and POLYGON, RING, and HOLE (Option 2) for a second acetate layer.

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_IMAGE>
      <PROPERTIES>
        <ENVELOPE minx="-180.0" miny="-90.0" maxx="180.0" maxy="90.0" />
        <IMAGESIZE width="800" height="600" />
      </PROPERTIES>
      <LAYER type="acetate" name="acetate" id="acetate">
        <OBJECT units="pixel">
          <POLYGON coords="10 10;400 10;400 20;10 20;10 10">
            <SIMPLEPOLYGONSYMBOL fillcolor="255,255,0" />
          </POLYGON>
        </OBJECT>
      </LAYER>
      <LAYER type="acetate" name="acetate1" id="acetate1">
        <OBJECT units="database">
          <SIMPLEPOLYGONSYMBOL fillcolor="0,255,0" />
          <POLYGON>
            <RING>
              <POINT x="83.15605550814075" y="38.07185101549165" />
              <POINT x="111.09942196116728" y="-4.70645066589869" />
              <POINT x="155.1079549837513" y="-10.38915084069517" />
              <POINT x="139.1079549837513" y="66.38915084069517" />
              <POINT x="83.15605550814075" y="38.07185101549165" />
              <HOLE>
                <POINT x="100.15605550814075" y="20.07185101549165" />
                <POINT x="103.09942196116728" y="30.70645066589869" />
                <POINT x="106.1079549837513" y="30.38915084069517" />
                <POINT x="100.15605550814075" y="20.07185101549165" />
              </HOLE>
            </RING>
          </POLYGON>
        </OBJECT>
      </LAYER>
    </GET_IMAGE>
  </REQUEST>
</ARCXML>