Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ImageServiceMeasureParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/ImageServiceMeasureParameters"], function(ImageServiceMeasureParameters) { /* code goes here */ });
Description
(Added at v3.14)
Defines parameters for the ImageServiceMeasureTask.Samples
Search for samples that use this class.Constants
| Name | Description |
|---|---|
OPERATION_AREA_PERIMETER | Calculates the area and perimeter of given geometry. The fromGeometry parameter is of type Polygon or Extent. The toGeometry parameter is not required. |
OPERATION_AREA_PERIMETER_3D | Calculates the area and perimeter of the given geometry using the DEM defined by the service to refine the calculation. The fromGeometry parameter is of type Polygon or Extent. The toGeometry parameter is not required. |
OPERATION_BASE_TOP | Calculates the height of a structure by measuring from the base of the structure to the top of the structure. The fromGeometry and toGeometry parameters are of type Point. |
OPERATION_BASE_TOP_SHADOW | Calculates the height of a structure by measuring from the base of the structure to the top of the structure's shadow on the ground. The fromGeometry and toGeometry parameters are of type Point. |
OPERATION_CENTROID | Calculates the centroid of a given area. The fromGeometry parameter is of type Polygon or Extent. |
OPERATION_CENTROID_3D | Calculates the centroid of a given area, using the DEM defined by the service to refine the calculation. The fromGeometry parameter is of type Polygon or Extent. |
OPERATION_DISTANCE_ANGLE | Calculates the distance and azimuth angle between two points. The fromGeometry and toGeometry parameters are of type Point. |
OPERATION_DISTANCE_ANGLE_3D | Calculates the distance and azimuth angle between two points using the DEM defined by the service to refine the calculation. The fromGeometry and toGeometry parameters are of type Point. |
OPERATION_POINT | Measures the location of a given point. The fromGeometry parameter for this operation is of type Point. The toGeometry parameter is not required. |
OPERATION_POINT_3D | Measures the location of a given point, using the DEM defined by the service to refine the calculation. The fromGeometry parameter is of type Point. The toGeometry parameter is not required. |
OPERATION_TOP_TOP_SHADOW | Calculates the height of a structure by measuring from the top of the structure to the top of the structure's shadow on the ground. The points on the structure and its shadow must represent the same point. The fromGeometry and toGeometry parameters are of type Point. |
Properties
| Name | Type | Summary |
|---|---|---|
| angularUnit | String | The angular unit in which directions of line segments will be calculated. |
| areaUnit | String | The area unit in which areas of polygons will be calculated. |
| fromGeometry | Geometry | A geometry that defines the "from" location of the measurement. |
| linearUnit | String | The linear unit in which height, length, or perimeters will be calculated. |
| mosaicRule | MosaicRule | Specifies the mosaic rule when defining how individual images should be mosaicked. |
| operation | String | The mensuration rule to apply to the measure operation. |
| pixelSize | Point | The pixel resolution being measured. |
| toGeometry | Geometry | A geometry that defines the "to" location of the measurement. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts the ImageServiceMeasureParameters instance to a JSON object. |
Property Details
<String
StringThe angular unit in which directions of line segments will be calculated.
Known values:
esriDURadians | esriDUDecimalDegreesDefault value:
esriDUDecimalDegrees<String
StringThe area unit in which areas of polygons will be calculated.
Known values:
esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres | esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters | esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares | esriSquareKilometersDefault value:
esriSquareMeters<Geometry
GeometryA geometry that defines the "from" location of the measurement.
<String
StringThe linear unit in which height, length, or perimeters will be calculated.
Known values:
esriMeters | esriKilometers | esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles | esriMillimeters | esriCentimeters | esriDecimetersDefault value:
esriMeters<MosaicRule
MosaicRuleSpecifies the mosaic rule when defining how individual images should be mosaicked. When a mosaic rule is not specified, the default mosaic rule of the image service will be used (as advertised in the root resource: defaultMosaicMethod, mosaicOperator, sortField, sortValue). The first visible image is used by measure.
<String
StringThe mensuration rule to apply to the measure operation. Set the value of this property to one of the constants from the Constants table.
<Point
PointThe pixel resolution being measured. If
pixelSize is not specified, it will default to the base resolution of the image service.<Geometry
GeometryA geometry that defines the "to" location of the measurement. The geometry type must be the same as fromGeometry.
Method Details