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

require(["esri/renderers/TimeRampAger"], function(TimeRampAger) { /* code goes here */ });

Description

(Added at v2.0)
Time ramp agers display aging using a gradual change in symbology. A range of colors and symbol sizes can be specified.

Samples

Search for samples that use this class.

Class hierarchy

esri/renderers/SymbolAger
|_esri/renderers/TimeRampAger

Constructors

NameSummary
new TimeRampAger(colorRange?, sizeRange?, alphaRange?)Creates a new TimeRampAger object with the specified color and size ranges.

Methods

NameReturn typeSummary
getAgedSymbol(symbol, graphic)SymbolCalculates aging and returns the appropriate symbol.
Constructor Details

new TimeRampAger(colorRange?, sizeRange?, alphaRange?)

Creates a new TimeRampAger object with the specified color and size ranges.
Parameters:
<Color[]> colorRange Optional An array containing the minimum and maximum color values. The default is:
[ new Color([0,0,0,0.1]), new Color([0,0,255,1]) ]
New features will be close to the max value and older ones will be closer to the minimum value.
<Number[]> sizeRange Optional An array containing the minimum and maximum size in pixels. The default value is
[2,10]
Newer features will be close to the max value and older ones will be close to the min value.
<Number[]> alphaRange Optional An array containing the minimum and maximum alpha opacity values. Newer features will be close to the max value and older ones close to the min value. As of v2.8
Sample:
require([
  "esri/renderers/TimeRampAger", "esri/Color", ... 
], function(TimeRampAger, Color, ... ) {
  var ager = new TimeRampAger(
    [new Color([0, 1, 1, 0.1]), new Color([0, 255, 255, 1])], 
    [4, 12]
);
  ...
});
Method Details

getAgedSymbol(symbol, graphic)

Calculates aging and returns the appropriate symbol. See the SymbolAger class for details.
Return type: Symbol
Parameters:
<Symbol> symbol Required The symbol to age.
<Graphic> graphic Required Feature being rendered.