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

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

Description

(Added at v3.6)
The study area is created with a simple ring buffer with a radius. To be used in favor of the studyAreaOptions property in the Infographic class.

Samples

Search for samples that use this class.

Constructors

NameSummary
new RingBuffer(params)Constructs a RingBuffer.

Properties

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

new RingBuffer(params)

Constructs a RingBuffer.
Parameters:
<Object> params Required Various optional parameters that can be used to configure this class.
params properties:
<Number[]> radii 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/RingBuffer", ... ], function(Infographic, RingBuffer, ... ){
  var infographics = new Infographic({
    ...
    studyAreaOptions: new RingBuffer({radii: [ 2 ], units: "esriMiles"})
  }, "infographics");
});
Property Details

<Number[]> radii

The radii to use to create ring buffers.

<String> units

The units of the radii. See Units for a list of valid values.