Reusable Accessible Mapping Platform

API Docs for: 5.0.0
Show:

BufferTool Class

Uses
Extends BaseTool
Defined in: src\js\RAMP\Tools\bufferTool.js:7
Module: Tools

BufferTool.

Adds a buffer around the a selected area. The user will be able to specify the distance in the bottom right corner, then draw a polygon on the map.

Methods

_hideLoadingImg

() private

Inherited from Map: src\js\RAMP\Modules\map.js:127

Hides the loading image.

_initEventHandlers

(
  • map
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:368

Creates event handlers for the map control: click, mouse-over, load, extent change, and update events.

Parameters:

  • map Object

    A ESRI map object

_initListeners

(
  • map
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:215

Subscribe to external events (published using topic.publish) and react accordingly

Parameters:

_initRepublishers

(
  • map
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:184

Republishes map events to the outside using topic.publish

Parameters:

_initScale

(
  • event
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:154

Initialize Map Scale

Parameters:

_showLoadingImg

() private

Inherited from Map: src\js\RAMP\Modules\map.js:117

Shows the loading image.

_updateScale

(
  • event
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:137

Update Map Scale when zoom level changes

Parameters:

_wrapFileCallInPromise

(
  • readMethod
)
Function private

Inherited from Util: src\js\RAMP\Utils\util.js:33

Helper function for wrapping File API calls in Promise objects. Used for building a series of helpers which call different file read methods.

Parameters:

  • readMethod String

    a string indicating the FileReader method to call

Returns:

Function:

a function which accepts a {File} object and returns a Promise

activate

() private

Inherited from BaseTool but overwritten in src\js\RAMP\Tools\bufferTool.js:153

Activates the Tool. This method is passed to the initToggle method and is triggered by the BaseTool logic.

AddStaticLayer

(
  • layer_type
  • layer_url
  • layer_op
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:566

Add a static, non-interactive Layer to the map

Parameters:

  • layer_type String

    A value which controls how the layer is going to be added to the map

  • layer_url String

    A URL pointing to a valid map service endpoint

  • layer_op Number

    A value between 0.0 and 1.0 which determines the transparency of the layer

applyExtentDefaulting

() private

Inherited from Map: src\js\RAMP\Modules\map.js:826

Apply extent defaulting prior to URL overrides.

checkBoundary

(
  • e
  • maxExtent
)
Esri/geometry/Extent

Inherited from Map: src\js\RAMP\Modules\map.js:858

Given an ESRI Extent Object, returns a new ESRI Extent Object that contains the extent adjusted according to this map's maximum extent

NOTE: this method is currently unused!

Parameters:

  • e Esri/geometry/Extent

    the extent Object

  • maxExtent Esri/geometry/Extent

    the maximum extent

Returns:

Esri/geometry/Extent:

An adjusted extent, if the target extent is outside the boundary

clearMap

() private

Defined in src\js\RAMP\Tools\bufferTool.js:176

Clears the map. This method is passed to the initToggle method as the defaultAction to be triggered by the BaseTool logic when the float-default-button is clicked.

computeBuffer

(
  • evtObj
)
private

Defined in src\js\RAMP\Tools\bufferTool.js:59

Compute the buffer of a specified polygon.

Parameters:

  • evtObj Object

    an object representing the draw-end event.

deactivate

() private

Inherited from BaseTool but overwritten in src\js\RAMP\Tools\bufferTool.js:165

Deactivates the Tool. This method is passed to the initToggle method and is triggered by the BaseTool logic.

displayOutput

() private

Inherited from BaseTool but overwritten in src\js\RAMP\Tools\bufferTool.js:187

Displays the tool's output by calling BaseTool's displayOutput function.

displayTemplateOutput

(
  • templateData
  • [templateName]
)
chainable

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:305

Generates output to be injected into the tool's float given a template's name and data object.

Parameters:

  • templateData Object

    data to be put inside the specified template

  • [templateName] String optional

    template name to be completed with provided data; if not supplied, "toolOutputTemplate" property of the options object will be used

Returns:

this tool

enhanceLayer

(
  • layer
  • config
  • userLayer
)

Inherited from Map: src\js\RAMP\Modules\map.js:1025

Adds custom ramp properties to layer. Adds handlers to loading events.

Parameters:

  • layer Object

    layer to be prepped

  • config Object

    config object for the layer

  • userLayer Boolean

    optional. indicates if layer was added by a user. default value is false

finishExtentProjection

(
  • projectedMaxExtent
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:550

process the projected maximum extent, then alert app to continue loading the map. used as an asynchronous gate for the projection.

Parameters:

  • projectedMaxExtent Array

    an array containing the maximum extent object in the map's projection

getBoundingBoxMapping

() Object

Inherited from Map: src\js\RAMP\Modules\map.js:804

Returns the mapping of feature layer ids to assocciated bounding box layers.

Returns:

Object:

A dictionary of String, Esri/layers/GraphicsLayer pairs.

getFeatureLayer

(
  • featureId
)
Esri/layers/FeatureLayer private

Inherited from Map: src\js\RAMP\Modules\map.js:814

Return the feature layer corresponding to the given id.

Parameters:

  • featureId String

    the id of the feature layer

Returns:

Esri/layers/FeatureLayer:

feature layer

getVisibleFeatureLayers

() Array

Inherited from Map: src\js\RAMP\Modules\map.js:764

Returns a list of feature layers that are currently visible on the map.

Returns:

Array:

an array of Esri/layers/FeatureLayer objects

init

() chainable

Defined in src\js\RAMP\Tools\bufferTool.js:202

Initialize the buffer tool

initToggle

(
  • selector
  • d
  • [options]
)
chainable

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:173

Initializes the tool and sets up popup to handle activating/deactivating of the tool. Tools should call this function on init, unless they employ a different workflow and then need to handle all function activation/deactivation/working themselves.

Parameters:

  • selector JObject

    a target selector that serves as a toggle for the tool

  • d JObject

    a Deferred object to be resolved after tool initiates

  • [options] Object optional

    Additional options

    • [target] JObject optional

      Target where the tool's float should be appended to

    • [outputFloatTemplate] String optional

      Template name to generate the float container with

    • [outputFloatData] Object optional

      Data payload to be passed to the template engine when generate the float container

    • [workingLabelTemplate] String optional

      Template name to generate the busy label

    • [workingLabelData] Object optional

      Data payload to be passed to the template engine when generate the busy label

    • [activate] Function optional

      an activate function to be called when the toggle is clicked

    • [deactivate] Function optional

      a deactivate function to be called when the toggle is clicked

    • [defaultAction] Function optional

      Function to be executed when the float-default-button is clicked

Returns:

this tool

localProjectExtent

(
  • extent
  • sr
)
Esri/Extent private

Inherited from Map but overwritten in src\js\RAMP\Modules\map.js:420

Will project an extent to a desired spatial reference, using client side projection library. Avoids the need for Esri Geometry Service

Parameters:

Returns:

Esri/Extent:

extent in the desired projection

makeFeatureLayer

(
  • layerConfig
  • userLayer
)
Esri/layers/FeatureLayer

Inherited from Map: src\js\RAMP\Modules\map.js:915

Create a new FeatureLayer object based on the config input

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Esri/layers/FeatureLayer:

feature layer object (unloaded)

makeStaticLayer

(
  • layerConfig
  • userLayer
)
Object private

Inherited from Map: src\js\RAMP\Modules\map.js:969

Return the static layer corresponding to the given url.

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Object:

layer object of the appropriate type

makeWmsLayer

(
  • layerConfig
  • userLayer
)
Esri/layers/WMSLayer

Inherited from Map: src\js\RAMP\Modules\map.js:939

Return the feature layer corresponding to the given url.

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Esri/layers/WMSLayer:

WMS layer

newPopup

(
  • popupAttr
)
private

Inherited from PopupManager: src\js\RAMP\Utils\popupManager.js:515

Create a new PopupBase object from the settings provided.

Parameters:

Returns:

popup

outputBuffer

(
  • bufferedGeometries
)
private

Defined in src\js\RAMP\Tools\bufferTool.js:104

Display the buffered polygon on the map.

Parameters:

  • bufferedGeometries Object

    result of the geoprocessor.

prepLayer

(
  • layer
  • config
  • userLayer
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:657

Sets up loading event handlers and initializes the .ramp object of a layer Circular reference errors prevent us from calling LayerLoader directly from this module

Parameters:

  • layer Object

    layer to be prepped

  • config Object

    config object for the layer

  • userLayer Boolean

    optional. indicates if layer was added by a user. default value is false

projectConfigExtents

()

Inherited from Map: src\js\RAMP\Modules\map.js:845

initiate the projection of the config extents to basemap extents

projectExtent

(
  • extent
  • sr
  • callWhenDone
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:476

project an extent to a new spatial reference, if required when projection is finished, call another function and pass the result to it.

Parameters:

projectFullExtent

(
  • projectedDefaultExtent
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:518

process the projected default extent, begin projection of full extent. used as an asynchronous gate for the projection.

Parameters:

  • projectedDefaultExtent Array

    an array containing the default extent object in the map's projection

projectMaxExtent

(
  • projectedFullExtent
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:534

process the projected full extent, begin projection of maximum extent. used as an asynchronous gate for the projection.

Parameters:

  • projectedFullExtent Array

    an array containing the full extent object in the map's projection

republish

(
  • name
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:194

Republish map events using topic.publish

Parameters:

setBoundingBoxVisibility

(
  • layerId
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:609

Sets the visibility of the bounding box that belongs to the layer with the given layerId. Note: the layerId needs to be the ID of the featurelayer, not the ID of the actual bounding box layer.

Parameters:

  • layerId String

    the id of the layer whose bounding box visibility should be set

ui.init

() private

Defined in src\js\RAMP\Tools\bufferTool.js:134

Initiates additional UI components of the Tool.

working

(
  • state
)
chainable

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:345

Sets the tool into a specified state; if the tool is working, a working label is placed beside the cursor and injected into the tool output float.

Parameters:

  • state Boolean

    indicates the state of the tool: working, idle

Returns:

This tool

zoomToLayerScale

(
  • layerId
)

Inherited from Map: src\js\RAMP\Modules\map.js:707

For a specified layer, zooms to the closest level that has some visible data.

Parameters:

  • layerId String

    a layer id to zoom to.

Properties

baseLayer

Esri/layers/ArcGISTiledMapServiceLayer private

Inherited from Map: src\js\RAMP\Modules\map.js:1078

The basemap layer

boundingBoxMapping

Object private

Inherited from Map: src\js\RAMP\Modules\map.js:92

Maps the id of a graphic layer to the GraphicsLayer Object that represents its extent bounding box. A dictionary of String, Esri/layers/GraphicsLayer pairs.

event

Object

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:130

Event names published by the BaseTool

Default: null

Example:

 {
     ACTIVATE: "basetool-activate",
     DEACTIVATE: "basetool-deactivate"
 }

featureLayers

Array private

Inherited from Map: src\js\RAMP\Modules\map.js:76

An Array of Esri/layers/FeatureLayer objects.

featureLayerStartIndex

Integer private

Inherited from Map: src\js\RAMP\Modules\map.js:101

The map not only contains feature layers, but also other layers such as the basemap layer, highlight layer, bounding box layer, etc. This variable is used to store the starting index of the feature layers in the map.

fullExtent

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1113

Used for full extent in nav widget

getMap

Object

Inherited from Map: src\js\RAMP\Modules\map.js:751

Return the map control object

getMaxExtent

Object

Inherited from Map: src\js\RAMP\Modules\map.js:742

The maximum extent of the map control is allowed to go to

handle

JObject

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:62

Handle (popup handle) that triggers opening/closing of the tool.

Default: null

InitExtent

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1104

The initial extent of the map

maxExtent

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1122

The maximum extent of the map

name

String

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:164

Name of the tool so AdvancedToolbar can distinguish between them.

Default: BaseTool

node

JObject

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:72

Node (button) the handle is attached too.

Default: null

options

Object private

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:52

Stored options passed to the BaseTool.

Default: null

outputFloat

JObject

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:81

Node representing the tool output float container.

Default: templates/tools_template.json:base_tool_float

Example:

 <div class='advanced-output-section-container'>
     <div class='advanced-output-section'>
         <section class='float-content'></section>
         <button class='button button-none float-default-button' >
             <i class='fa fa-trash-o'></i><span class='on-right'>{%= o.clearMapButton %}</span>
         </button>
         <div class='clear'></div>
     </div>
 </div>

template

Object

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:120

Stringified and parsed templates

Default: templates/tools_template.json

tooltip

JObject

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:110

Tooltip node that appears by the mouse cursor when tools is activated.

Default: $("#mainMap.map > .tooltip")

url

String private

Inherited from Map: src\js\RAMP\Modules\map.js:1069

The URL of the first layer of the basemap that is on by default.

wmsLayers

Array private

Inherited from Map: src\js\RAMP\Modules\map.js:84

An Array of Esri/layer/WMSLayer objects.

workingLabel

String

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:100

Template string representing working label shown when the tool is in busy state.

Default: templates/tools_template.json:working_label

Example:

 <span class='tool-tooltip'><i class='fa fa-cog fa-spin'></i>{%= o.workingLabel %}</span>

Events

ACTIVATE

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:143

Published whenever a Tool is activated.

Event Payload:

DEACTIVATE

Inherited from BaseTool: src\js\RAMP\Tools\baseTool.js:152

Published whenever a Tool is deactivated.

Event Payload: