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

require(["esri/tasks/geoenrichment/DriveBuffer"], function(DriveBuffer) { /* code goes here */ });

Description

(Added at v3.6)
The study area is created with a drive time or drive distance buffer. To be used in favor of the studyAreaOptions property in the Infographic class.

Samples

Search for samples that use this class.

Constructors

NameSummary
new DriveBuffer(params)Constructs a DriveBuffer.

Properties

NameTypeSummary
radiusNumber[]The radii to use to create ring buffers.
unitsStringThe units of the radii.
Constructor Details

new DriveBuffer(params)

Constructs a DriveBuffer.
Parameters:
<Object> params Required Various optional parameters that can be used to configure this class.
params properties:
<Number[]> radius Required The radii to use to create ring buffers
<String> units Required The units of the radii.
Sample:
require(["esri/dijit/geoenrichment/Infographic", "esri/tasks/geoenrichment/DriveBuffer", ... ], function(Infographic, DriveBuffer, ... ){
  var infographics = new Infographic({
    ...
    studyAreaOptions: new DriveBuffer({radii: [ 2 ], units: "esriMiles"})
  }, "infographics");
});
Property Details

<Number[]> radius

The radii to use to create ring buffers.

<String> units

The units of the radii. Supported options are DriveUnits values and Esri unit strings like "esriDriveTimeUnitsMinutes".