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: ImageServiceMeasureTool
[ AMD Module Require | Legacy Module Require ]
require(["esri/toolbars/ImageServiceMeasureTool"], function(ImageServiceMeasureTool) { /* code goes here */ });
Description
(Added at v3.14)
A toolbar that provides support for measuring image services.
The image services must support mensuration. Mensuration is a method of applying geometric rules to find the lengths of lines, areas of surfaces, or volumes using information obtained from lines and angles. It can also include measuring the height and absolute location of a feature.
Any Image service with georeferenced raster dataset can provide distance, area, point and centroid locations. Height measurements can be obtained when a sensor model exists. Sun angle information is required to make measurements using the shadows.
An instance of this toolbar is provided to an instance of the ImageServiceMeasure widget in the measureToolbar property. The widget provides a simple user interface to the application while leveraging all the properties, methods and events of the ImageServiceMeasureToolbar.
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ImageServiceMeasureTool(params) | Creates a new instance of ImageServiceMeasureTool. |
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. |
| fillSymbol | SimpleFillSymbol | Symbol to be used when drawing a polygon or extent. |
| lineSymbol | SimpleLineSymbol | Symbol to be used when drawing a line. |
| linearUnit | String | The linear unit in which height, length, or perimeters will be calculated. |
| markerSymbol | SimpleMarkerSymbol | Symbol to be used when drawing a point. |
Methods
| Name | Return type | Summary |
|---|---|---|
| activate(operation) | None | Activates the toolbar for performing the measure operation. |
| deactivate() | None | Deactivates the toolbar. |
| getSupportedMeasureOperations() | String[] | Returns a list of measure operations supported by the image service. |
| getSupportedUnits() | String[] | Returns a list of supported linear, angular and area units. |
| hideDrawTooltip() | None | Disables the tooltip message for performing a draw. |
| setAngularUnit(unit) | None | Sets the angularUnit. |
| setAreaUnit(unit) | None | Sets the areaUnit. |
| setFillSymbol(fillSymbol) | None | Sets the fillSymbol. |
| setLineSymbol(lineSymbol) | None | Sets the lineSymbol. |
| setLinearUnit(unit) | None | Sets the linearUnit. |
| setMarkerSymbol(markerSymbol) | None | Sets the markerSymbol. |
| showDrawTooltip() | None | Enables the tooltip message for performing a draw. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| draw-end | {
geometry: < | Fires when the drawing is complete. |
| draw-start | Fires when the user starts drawing. | |
| measure-end | {
measureResult: < | Fires when the measure operation has been performed. |
| unit-change | {
measureResult: < | Fires when the unit has been changed. |
Constructor Details
Creates a new instance of ImageServiceMeasureTool.
Parameters:
< |
Required | Constructor options. See Object Specification table below for more details on the properties of this object. |
params properties: < |
Optional | The angular unit in which directions of line segments will be calculated. Possible Values: esriDURadians | esriDUDecimalDegrees (default) |
< |
Optional | The area unit in which areas of polygons will be calculated. Possible Values: esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres | esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters | esriSquareDecimeters | esriSquareMeters (default) | esriAres | esriHectares | esriSquareKilometers |
< |
Optional | Symbol to be used when drawing a polygon or extent. |
< |
Required | Image service layer the toolbar is associated with. |
< |
Optional | Symbol to be used when drawing a line. |
< |
Optional | The linear unit in which height, length, or perimeters will be calculated. Possible Values: esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles | esriMillimeters | esriCentimeters | esriDecimeters | esriMeters (default) | esriKilometers |
< |
Required | Map instance the toolbar is associated with. |
< |
Optional | Symbol to be used when drawing a point. |
Sample:
require([
"esri/toolbars/ImageServiceMeasureTool", ...
], function(ImageServiceMeasureTool, ... ) {
var imageMeasureTool = new ImageServiceMeasureTool({
map: map,
layer: new ArcGISImageServiceLayer()
});
...
});
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 | esriAcres | esriHectares | esriSquareKilometersDefault value:
esriSquareMeters<SimpleFillSymbol
SimpleFillSymbolSymbol to be used when drawing a polygon or extent.
<SimpleLineSymbol
SimpleLineSymbolSymbol to be used when drawing a line.
<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<SimpleMarkerSymbol
SimpleMarkerSymbolSymbol to be used when drawing a point.
Method Details
Activates the toolbar for performing the measure operation.
Parameters:
< |
Required | The mensuration rule to apply to the measure operation. Use getSupportedMeasureOperations() to obtain a list of possible values for this parameter. |
Returns a list of measure operations supported by the image service.
Return type:
String[]Returns a list of supported linear, angular and area units.
Return type:
String[]Sets the angularUnit.
Parameters:
< |
Required | The angular unit to set. Possible Values: esriDURadians | esriDUDecimalDegrees |
Sets the areaUnit.
Parameters:
< |
Required | Possible Values: esriSquareInches | esriSqudareFeet | esriSquareYards | esriAcres | esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters | esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares | esriSquareKilometers |
Sets the fillSymbol.
Parameters:
< |
Required | The fill symbol to set. |
Sets the lineSymbol.
Parameters:
< |
Required | The line symbol to set. |
Sets the linearUnit.
Parameters:
< |
Required | The linear unit to set. Possible Values: esriMeters | esriKilometers | esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles | esriMillimeters | esriCentimeters | esriDecimeters |
Sets the markerSymbol.
Parameters:
< |
Required | The marker symbol to set. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when the drawing is complete.
Event Object Properties:
< |
The geometry of the graphic created while performing the draw. |
Fires when the measure operation has been performed.
Event Object Properties:
< |
An object that contains the following properties:
{
error: |
Fires when the unit has been changed.
Event Object Properties:
< |
An object that contains the following properties:
{
error: |