Class adf.MapPoly
Extends
adf.MapToolItem.
Defined in: MapToolItem.js.
Constructor Attributes | Constructor Name and Description |
---|---|
adf.MapPoly(id, toolName, action, isMarker, isPolygon)
Creates a new toolitem to draw a polyline or polygon shape on the map control
|
Field Attributes | Field Name and Description |
---|---|
The adf.action associated with the ToolItem
|
|
The id of the ToolItem
|
|
Whether tool item is a marker (drawn as graphic on screen) or tool (sends coordinates/request to server)
|
|
Is the shape drawn a polygon
|
|
The name of the ToolItem
|
- Fields borrowed from class adf.MapToolItem:
- blockMapPan, blockMapZoom, control
- Fields borrowed from class adf.ToolItem:
- clientPostBack, defaultImage, defaultStyle, disabledImage, disabledStyle, element, hoverImage, hoverStyle, isActive, isCommand, isDisabled, selectedImage, selectedStyle, showLoading, toolTip
Method Attributes | Method Name and Description |
---|---|
activate()
activates the toolitem
|
|
continuousAction(point)
This method gets called continuously as the adf.DrawPolyShapeAction is adding a point on every click
It stores the corresponding Map coordinates for this point
see more adf.DrawPolyShapeAction#activate on how this is getting called.
|
|
postAction(points)
This method is called when the adf.DrawPolyShapeAction is completed.
|
- Methods borrowed from class adf.MapToolItem:
- deactivate
Class Detail
adf.MapPoly(id, toolName, action, isMarker, isPolygon)
Creates a new toolitem to draw a polyline or polygon shape on the map control
- Parameters:
- {String} id
- the id of the tool
- {String} toolName
- the name of the tool
- {adf.Action} action
- the adf.Action bound to this tool
- {Boolean} isMarker
- when set to true, this tools drawing action will leave its graphics on the adf.graphics.Element, otherwise it removes when the action is deactivated.
- {String} isPolygon
- Whether the shape to be drawn by this toolitem is polygon
Field Detail
{adf.Action}
action
The adf.action associated with the ToolItem
- Default Value:
- adf.DrawPolylineAction
{String}
id
The id of the ToolItem
{Boolean}
isMarker
Whether tool item is a marker (drawn as graphic on screen) or tool (sends coordinates/request to server)
{Boolean}
isPolygon
Is the shape drawn a polygon
{String}
name
The name of the ToolItem
Method Detail
activate()
activates the toolitem
continuousAction(point)
This method gets called continuously as the adf.DrawPolyShapeAction is adding a point on every click
It stores the corresponding Map coordinates for this point
see more adf.DrawPolyShapeAction#activate on how this is getting called.
- Parameters:
- {adf.Point} point
- the point added to the existing polyshape geometry
postAction(points)
This method is called when the adf.DrawPolyShapeAction is completed.
see more adf.DrawPolyShapeAction#activate on how this is getting called.
Based on the adf.MapPoly#isMarker value, either draws polyshape on map control
or sends the coordinates of the polyshape to be drawn to the server
It sends both screen coordinates and map coordinates for the polyshape drawn by the action
The adf.ToolItem#clientPostBack determines this request to the server will be AJAX (partial) or full postback
- Parameters:
- {Array} points
- The Array of points representing the polyshape geometry drawn by this toolitem