Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ImageServiceMeasureParameters

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

NameDescription
OPERATION_AREA_PERIMETERCalculates 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_3DCalculates 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_TOPCalculates 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_SHADOWCalculates 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_CENTROIDCalculates the centroid of a given area. The fromGeometry parameter is of type Polygon or Extent.
OPERATION_CENTROID_3DCalculates 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_ANGLECalculates the distance and azimuth angle between two points. The fromGeometry and toGeometry parameters are of type Point.
OPERATION_DISTANCE_ANGLE_3DCalculates 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_POINTMeasures the location of a given point. The fromGeometry parameter for this operation is of type Point. The toGeometry parameter is not required.
OPERATION_POINT_3DMeasures 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_SHADOWCalculates 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

NameTypeSummary
angularUnitStringThe angular unit in which directions of line segments will be calculated.
areaUnitStringThe area unit in which areas of polygons will be calculated.
fromGeometryGeometryA geometry that defines the "from" location of the measurement.
linearUnitStringThe linear unit in which height, length, or perimeters will be calculated.
mosaicRuleMosaicRuleSpecifies the mosaic rule when defining how individual images should be mosaicked.
operationStringThe mensuration rule to apply to the measure operation.
pixelSizePointThe pixel resolution being measured.
toGeometryGeometryA geometry that defines the "to" location of the measurement.

Methods

NameReturn typeSummary
toJson()ObjectConverts the ImageServiceMeasureParameters instance to a JSON object.
Property Details

<String> angularUnit

The angular unit in which directions of line segments will be calculated.
Known values: esriDURadians | esriDUDecimalDegrees
Default value: esriDUDecimalDegrees

<String> areaUnit

The area unit in which areas of polygons will be calculated.
Known values: esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres | esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters | esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares | esriSquareKilometers
Default value: esriSquareMeters

<Geometry> fromGeometry

A geometry that defines the "from" location of the measurement.

<String> linearUnit

The linear unit in which height, length, or perimeters will be calculated.
Known values: esriMeters | esriKilometers | esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles | esriMillimeters | esriCentimeters | esriDecimeters
Default value: esriMeters

<MosaicRule> mosaicRule

Specifies 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> operation

The mensuration rule to apply to the measure operation. Set the value of this property to one of the constants from the Constants table.

<Point> pixelSize

The pixel resolution being measured. If pixelSize is not specified, it will default to the base resolution of the image service.

<Geometry> toGeometry

A geometry that defines the "to" location of the measurement. The geometry type must be the same as fromGeometry.
Method Details

toJson()

Converts the ImageServiceMeasureParameters instance to a JSON object.
Return type: Object