Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/en/javascript/jsapi/featurelayer-amd.html below:

FeatureLayer | API Reference | ArcGIS API for JavaScript 3.46

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

(Added at v2.0)

The feature layer inherits from the graphics layer and can be used to display features from a single layer in either a Map Service or Feature Service. The layer can be either a (spatial) layer or (non-spatial) table. The features in a feature layer can be edited if the

method is true.

The FeatureLayer will, by default, use the drawing information from the server (requires ArcGIS Server 10 or above). For an example, see the simple renderer in the Drawing Info at https://www.example.com/argis/rest/services/Earthquakes/EarthquakesFromLastSevenDays/MapServer/0

Starting at version 3.24, you can opt in to render FeatureLayer with WebGL. This allows you to display more data in the map and update the visualization of features more rapidly. To enable WebGL rendering of FeatureLayer, paste the following script in your application prior to loading the ArcGIS API for JavaScript:

<script>
  var dojoConfig = {
    has: {
      "esri-featurelayer-webgl": 1
    }
  };
</script>

Once enabled globally for the app, WebGL can be toggled on/off using the API below:

• webglEnabled - A constructor option and property.
• setWebglEnabled() - A method for toggling WebGL on/off for the layer.
• hasWebGLSurface() - A method for checking whether a layer is rendered with WebGL.

The following are current limitations of WebGL-rendered FeatureLayers subject to change in future releases. If any of these conditions are not met, then the layer will automatically switch from WebGL to SVG during the session.

• Support is limited to layers created from feature services hosted on ArcGIS Online and non-hosted enterprise feature services versions 10.6.1 or later. FeatureLayers created from FeatureCollections are not supported.
• Polygon layers must support returning centroids.
• The layer must not be editable.
• The layer must not be clustered.
• The layer must use on-demand fetch mode.
• The layer must not use labels.
• The layer must not use Arcade expressions containing geometry operations.
• The layer's renderer must be of type SimpleRenderer, ClassBreaksRenderer, or UniqueValueRenderer.
• Color and opacity visual variables must have 8 stops or less.
• Attribute-driven size visual variables must have 6 stops or less. This does not affect variables driven by map scale.
• Line symbols must not have arrow markers.
• Selection symbol is not supported.

Note that only the click event will fire when WebGL is enabled. All other events are not supported. FeatureLayer subclasses do not support WebGL rendering. Also note that modifying attributes, symbol, geometry and visibility of individual features in a WebGL-rendered layer will NOT have any effect.

Search for

that use this class.

esri/layers/Layer
|_esri/layers/GraphicsLayer
  |_esri/layers/FeatureLayer

Delegate to either on-demand or snapshot mode depending on the characteristics of the service. This is only applicable to hosted feature services.

If the total number of features in a layer are less than maxRecordCount and total vertexes is less than 250,000, snapshot mode is used. Otherwise, on-demand mode is used. The purpose behind this mode is to reduce server-side load. Instead of getting a small number of features with several requests (on-demand mode), get all features with a single request. This mode requires an additional request to complete before retrieving any features.

In on-demand mode, the feature layer retrieves features from the server when needed. This is based on the requirements defined in the following properties:

• Map properties such as the current spatial extent and time extent.
• Layer properties such as time offset and definition expression.

In selection mode, features are retrieved from the server only when they are selected. Features are available on the client only while they are selected. To work with selected features:

1. Call the selectFeatures method.
2. Listen for the onSelectionComplete event.
3. Once onSelectionComplete fires, retrieve the selected features using the getSelectedFeatures method.

When editing feature layers in selection mode, you will need to add the map service associated with the feature service to the map as a dynamic map service. If you do not have the map service added as a dynamic map service then the changes will not be visible because once the edits are complete the feature is no longer selected.

• Default is xyFootprint if geometryType is esriGeometryMultiPatch.

[ On Style Events | Connect Style Event ]

All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.

{
  result: <FeatureEditResult>
}

{
  adds: <Graphic[]>,
  deletes: <Graphic[]>,
  updates: <Graphic[]>
}

{
  event: <Object>
}

{
  event: <Object>
}

{
  results: <Object[]>
}

{
  adds: <FeatureEditResult[]>,
  deletes: <FeatureEditResult[]>,
  updates: <FeatureEditResult[]>
}

{
  error: <Error>
}

{
  graphic: <Graphic>
}

{
  graphic: <Graphic>
}

{
  graphic: <Graphic>,
  node: <HTMLElement>
}

{
  graphic: <Graphic>,
  node: <HTMLElement>
}

{
  graphic: <Graphic>
}

{
  layer: <Layer>
}

{
  opacity: <Number>
}

{
  info: <Object[]>
}

{
  count: <Number>
}

{
  count: <Number>,
  extent: <Extent>
}

{
  featureSet: <FeatureSet>
}

{
  objectIds: <Number[]>
}

{
  relatedFeatures: <Object>
}

{
  features: <Graphic[]>,
  method: <Number>
}

{
  error: <Error>,
  info: <Object>
}

{
  visible: <Boolean>
}

Constructor Details

Creates a new instance of a feature layer object from the ArcGIS Server REST resource identified by the input URL. Once created you can optionally set a definition expression or time definition.

Support for feature reduction is limited to the following scenarios:

• Point data(from service or FeatureCollection).
• The map must have a spatial reference of Web Mercator or WGS84.
• If the layer contains more than 50,000 features, then only the first 50,000 will be clustered.
• A FeatureLayer created from a service URL must point to a service that supports pagination (ArcGIS Server version 10.3.1 or higher).
• When editing is initiated with the Editor widget, then feature reduction is disabled until the Editor widget is destroyed.
• Feature reduction is disabled when the layer has one of the following renderers: HeatmapRenderer, BlendRenderer, TemporalRenderer, or ScaleDependentRenderer.

• FeatureLayer.MODE_SNAPSHOT: features are fetched from the server based on DefinitionExpression and TimeDefinition. If the definition changes, the layer updates itself by querying features back from the server. Once the features are fetched to the client, their "visibility" on the map is based on the time and spatial extents of the map. For example, for a time animation, you can request all features from server, then adjust time extent on Map to only show a subset.
• FeatureLayer.MODE_ONDEMAND: features are fetched from the server as needed.
• FeatureLayer.MODE_SELECTION: only selected features are availabe on the client. Typically used in combination with a dynamic map service showing features that can be selected.
• FeatureLayer.MODE_AUTO: features are fetched with either on-demand or snapshot mode depending on the characteristics of the service. Only applicable to hosted feature services. See the constants table for details.

See the constants table for additional details on each mode.

• Specfiy ASC (ascending) or DESC (descending) after the field name to control the order. Example: [ "POPULATION DESC" ].
• When visualizing a feature layer using a renderer with data-based sizing, this option is useful to make sure smaller features are drawn on top of larger ones and not hidden underneath.
• If not specified, feature layer will choose the order as follows:
• Layer has a renderer with data-based sizing: descending order of Renderer.sizeInfo.field.
• Layer has a ClassBreaksRenderer with backgroundFillSymbol: descending order of Renderer.attributeField.
• Layer has a ClassBreaksRenderer where each break has varying symbol sizes: descending order of Renderer.attributeField.

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  var censusBlock = new FeatureLayer(layerUrl, {
    showAttribution :false
  });
  ...
});

If you do not wish to have your feature layer label, you can override this behavior by setting its showLabels property to false. Indicate whether to display labels. If true, any FeatureLayer added to the map will automatically label based on labelingInfo. Default is false. Added at v3.11 NOTE: In order for the labels to display, all fields used by the labelingInfo should be set in outFields. In addition, only simple labeling is supported, for example {CITY_NAME}. For example, SQL keywords such as "CONCAT" are not supported. Consider using the LabelLayer class where you can specify the textExpression if needing more functionality.

  var map = new Map("map", {showLabels : true });
  ...
  var fl1 = new FeatureLayer(url, {showLabels: true, outFields: ["*"]});
  var fl2 = new FeatureLayer(url2, {showLabels: false, outFields: ["*"]});
  map.addLayers([fls, fl2]);

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  var featureLayer = new FeatureLayer("https://www.example.com/arcgis/rest/services/Hydrography/Watershed173811/FeatureServer/1", {
    mode: FeatureLayer.MODE_ONDEMAND,
    tileWidth: 200,
    tileHeight: 200
  });
  ...
});

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  var featureLayer = new FeatureLayer(featureLayerURL, {
    mode: FeatureLayer.MODE_SELECTION,
    trackIdField: "Animal_1"
  });
  ...
});

<featureReduction>

require([
  "esri/InfoTemplate", "esri/layers/FeatureLayer", ... 
], function(InfoTemplate, FeatureLayer, ... ) {
  var infoTemplate = new InfoTemplate("${FIELD_NAME}", content);
  var featureLayer = new FeatureLayer("https://www.example.com/ArcGIS/rest/services/Petroleum/KGS_OilGasFields_Kansas/MapServer/0",{
    mode: FeatureLayer.MODE_ONDEMAND,
    infoTemplate: infoTemplate,
    outFields: ["*"]
  });
  ...
});

Creates a new instance of a feature layer using a FeatureCollection object. The feature layer, when initialized with a feature collection object has the following behavior:

• Edits are applied on the client not posted to the server.
• The feature layer generates a unique object id for new features.
• Does not support queries that need to be performed on the server, for example queries with a where clause or non-extent based spatial queries.
• The feature layer toJson method returns an object with the same properties as the feature collection. The returned object includes all the features that are in the layer when the method is called. This method can be used to access a serializable representation of the features that can be saved on the server.

<featureCollectionObject>

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  var layerDefinition = {
    "geometryType": "esriGeometryPolygon",
    "fields": [{
      "name": "BUFF_DIST",
      "type": "esriFieldTypeInteger",
      "alias": "Buffer Distance"
    }]
  } 
  var featureCollection = {
    layerDefinition: layerDefinition,
    featureSet: null
  };
  var featureLayer = new FeatureLayer(featureCollection, {
    showLabels: true
  });
  ...
});

Property Details

An object that contains service level metadata about whether or not the layer supports queries using statistics, order by fields,

, pagination, query with distance, and returning queries with extents. This object contains the existing properties

and

which is returned in the new

property. For backward compatibility

and

will remain properties of FeatureLayer.

"advancedQueryCapabilities" : {
  "supportsPagination" : true, 
  "supportsQueryWithDistance" : true, 
  "supportsReturningQueryExtent" : true, 
  "supportsStatistics" : true, 
  "supportsOrderBy" : true, 
  "supportsDistinct" : true,
  "supportsQueryWithCacheHint" : true
}

var wildfireResponsePointsFeatureLayer = new FeatureLayer(url, featureLayerOptions);
map.addLayer(wildfireResponsePointsFeatureLayer);

wildfireResponsePointsFeatureLayer.on("load", function featureLayerLoaded(event){
  console.log("advancedQueryCapabilities"),   wildfireResponsePointsFeatureLayer.advancedQueryCapabilities);
  /* Object {supportsStatistics: true, supportsOrderBy: true, supportsDistinct: true} */
});

Returns true if the geometry of the features in the layer can be edited, false otherwise. In ArcGIS Server version 10.1, this option can be configured when publishing the service. For earlier versions, this is always true. (Added at v2.8)

Known values: true | false

Indicates whether attribute features containing m-values can be edited. (Added at v3.21)

Default value: false

The URL, when available, where the layer's attribution data is stored. (Added at v3.1)

Information about the capabilities enabled for this layer.

attribute of the layer's node.

Copyright information for the layer.

Provides credential information for the layer such as userid and token if the layer represents a resource that is secured with token-based authentication. This value is available after the layer has been loaded i.e. layer.loaded is true. (Added at v2.5)

List of attribute fields added as custom data attributes to graphics node. Applicable only when layer surfaceType is "svg". (Added at v3.7)

Metadata describing the default definition expression for the layer as defined by the service. The default definition expression limits the features available for display and query. You cannot override this value but you define additional filters on the default expression using the setDefinitionExpression method. For example, if the default definition expression is set to display data where "STATE_NAME = 'California'" you could use setDefinitionExpression to only display a subset of the features in California, for example using "COUNTY='San Diego'".

Indicates the default visibility for the layer. (Added at v3.0)

Known values: true | false

var isVisible = layer.defaultVisibility;

The description of the layer as defined in the map service.

The name of the layer's primary display field. The value of this property matches the name of one of the fields of the layer.

Indicates the field names for the editor fields. If ownership based access control is not enabled for the feature service the value will be null. The object has the following properties:

  {
    <String> creatorField,
    <String> creationDateField,
    <String> editorField,
    <String> editDateField
  }

Applicable to ArcGIS Online hosted feature services. If present, this object specifies information about editing. See the object specifications table below for the structure of the editingInfo object. (Added at v3.28)

<editingInfo>

"editingInfo" : {
  "lastEditDate" : 1536363634886
}

The array of fields in the layer.

The full extent of the layer.

The geodatabase version. Only applicable if the layer's data source is registered as versioned in SDE. Only valid with ArcGIS Server services version 10.1 or greater. (Added at v2.7)

Geometry type of the features in the layer. Can be one of the following: "esriGeometryPoint", "esriGeometryPolygon" or "esriGeometryPolyline".

The globalIdField for the layer.

Array of features in the layer.

Indicates whether the layer displays all features intersecting the current view. Typically, this method should be called after the layer emits the

event.

Default value: true

True if attachments are enabled on the feature layer. Use the queryAttachmentInfos method to determine if the feature has attachments. If the layer is editable (isEditable) and supports attachments the following operations can be performed.

• Add attachments to features.
• Delete existing attachments.

Known values: true | false

When true, the layer has attribution data. The default value is false. Use the

method to retrieve this data as JSON.

Known values: true | false

Default value: false

The html popup type defined for the layer. View the constants table for a list of valid values.

ID assigned to the layer. If not assigned, esri.Map assigns value. By default, the ID of the layer is "layer" followed by a number. The ID can be user defined only in the layer constructor.

• Setting the layer ID in the layer constructor.

  require([
    "esri/layers/ArcGISDynamicMapServiceLayer", ... 
  ], function(ArcGISDynamicMapServiceLayer, ... ) {
    var population = new ArcGISDynamicMapServiceLayer("http://myserver/arcgis/rest/population/MapServer/Layers", {id:"population"});
    ...
  });
  

• Setting the layer ID after a layer is initialized.

  population.id = "population";
  

• Retrieving the layer ID.

  function getMapLayers() {
    for (var j=0, jl=map.layerIds.length; j<jl; j++) {
      var currentLayer = map.getLayer(map.layerIds[j]);
      alert("id: " + currentLayer.id);
    }
  }
  

The info template for the layer. (Added at v3.9)

Label definition for this layer, specified as an array of label classes. Use this property to specify any changes to the structure of the label. For example, label expression, placement, and size can be modified and passed to this property. (Added at v3.10)

labelingInfo: [{
  "labelExpression": "", //deprecated, labelExpressionInfo property should be used in its place
  "labelExpressionInfo": {
   {"value": "City Of {CITY_NAME} has population {POPULATION}"}
  },
  "useCodedValues":  //parameters used when attribute field has domain values,
  "labelPlacement": "above-right",
  "symbol": {...}, //TextSymbol used for labeling
  "minScale": 0, //specified scale range where labels are visible
  "maxScale": 5000,
  //fieldInfos structure describes attribute field formatting
  "fieldInfos": [
    { fieldName: "created_date", format: { dateFormat: "shortDate"} }, //date/time formatting 
    { fieldName: "last_edited_date", format: { dateFormat: "longDate"} },  //date/time formatting
    { fieldName: "eventtype", format: { places: 6, digitSeparator: true } } //numeric formatting
  ],
  "where": "POP_RANK > 2 AND POP_RANK < 4" //where clause applied on labels
}]

Unique ID of the layer that the FeatureLayer was constructed against.

Set if the layer failed to load. (Added at v3.9)

When the layer is loaded, the value becomes "true", and layer properties can be accessed. The

event is also fired.

Known values: true | false

The maximum allowable offset, only applicable for layers that are not editable. (Added at v2.7)

The maximum number of results that will be returned from a query. Requires ArcGIS Server version 10.1 or greater. (Added at v2.6)

Maximum visible scale for the layer. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. (Added at v3.1)

Default value: 0

Minimum visible scale for the layer. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a visible scale. (Added at v3.1)

Default value: 0

Supports feature services whose data source is a multipatch featureclass.

• Default is xyFootprint if geometryType is esriGeometryMultiPatch. Otherwise, undefined.
• User can override this property with a different choice in the future when FS supports it.
• Queries made through the FeatureLayer will include multipatchOption parameter if returnGeometry is true.
• Applies to snapshot, ondemand, selectFeatures, and queryFeatures

: Requires ArcGIS 10.3 and above.

Default value: xyFootprint

var infoTemplate = new InfoTemplate("Attributes", "${*}");

var url = "http://servername.fqdn.suffix/arcgis/rest/services/Hosted/pasadena/FeatureServer/0";
var featureLayerOptions = {
  id: "cities",
  mode: FeatureLayer.MODE_AUTO,
  outFields: ["*"],
  infoTemplate: infoTemplate
};
var citiesFeatureLayer = new FeatureLayer(url, featureLayerOptions);

map.addLayer(citiesFeatureLayer);

The name of the layer as defined in the map service.

The name of the field that contains the Object ID field for the layer.

Opacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.

Known values: 0.0 - 1.0

Default value: 1.0

Indicates the ownership access control configuration. If ownership based access control is not enabled for the feature service the value will be null. If ownership based access control is not enabled for the feature service the value will be null. This object has two properties

and

. When true features can be deleted or updated by users other than the creator.

{
  <Boolean> allowUpdateToOthers,
  <Boolean> allowDeleteToOthers
}

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. (Added at v3.7)

Each element in the array is an object that describes the layer's relationship with another layer or table. Use the queryRelatedFeatures method to retrieve features or records related to a feature in this layer. The object has the following properties:

var relationships = wellFeatureLayer.relationships;
dojo.forEach(relationships,function(relationship){
  console.log("name: " + relationship.name);
  console.log("id: " + relationship.id);
  console.log("relationship id: "   + relationship.relatedTableId);
});

The renderer for the layer.

When true, the layer's attribution is displayed on the map. (Added at v3.1)

Known values: true | false

Default value: true

Determines if labels are displayed. When false, labels for the layer are not displayed.

If the FeatureLayer has labeling defined on it, labels will automatically display if the Map's

is true.

If you do not wish to have your feature layer label, you can override this behavior by setting its showLabels property to false. NOTE: In order for the labels to display, all fields used by the labelingInfo should be set in outFields. In addition, only simple labeling is supported, for example {CITY_NAME}. For example, SQL keywords such as "CONCAT" are not supported. Consider using the LabelLayer class where you can specify the textExpression if needing more functionality.

Known values: true | false

Default value: true

The dynamic layer or table source. (Added at v2.7)

Indicates whether the layer is responsible for styling graphics. When true, styling is based on graphics symbol or the layer's renderer. When false, graphics styling is disabled. Applicable only when layer surfaceType is "svg". (Added at v3.7)

Known values: true | false

When true, the layer supports orderByFields in a query operation. Requires ArcGIS Server service version 10.1 or greater (Added at v2.6)

Known values: true | false

When true, the layer supports uploading attachments with Uploads REST operation, which then can be used in the Add Attachment or Update Attachment REST operations. Requires ArcGIS Online hosted feature service. (Added at v3.11)

Known values: true | false

When true, the layer supports the Calculate REST operation when updating features. Requires ArcGIS Online hosted feature service. (Added at v3.11)

Known values: true | false

If true, the layer supports a user-defined field description. Please see the ArcGIS Online help topic,

for additional information.

When true, the layer supports statistical functions in query operations. Requires ArcGIS Server service version 10.1 or greater (Added at v2.6)

Known values: true | false

Type of vector graphics surface used to draw graphics. (Added at v3.7)

Known values: "svg" | "canvas-2d" | "vml"

Default value: "svg" on all browsers - except IE8 or earlier where "vml" is used to draw graphics.

When true, the layer is suspended. A layer is considered to be suspended when one of the following is true:

• The layer is hidden.
• The layer is not visible at the current map scale.
• The layer is explicitly suspended by calling the Layer.suspend method.

Known values: true | false

An array of feature templates defined in the Feature Service layer. Only applicable for ArcGIS Server Feature Service layers.

require([
  "esri/layers/FeatureLayer", "dojo/_base/array", ... 
], function(FeatureLayer, array, ... ) {
  var layer = new FeatureLayer( ... );
  var templates = layer.templates;
  array.forEach(templates,function(template){
    console.log(template.description);
    console.log(template.name);
  });
  ...
});

Time information for the layer, such as start time field, end time field, track id field, layers time extent and the draw time interval. Only applicable if the layer is time aware.

Specifies the type of layer. Can be "Feature Layer" or "Table".

The field that represents the Type ID field. Only applicable for ArcGIS Server Feature Service layers.

An array of sub types defined in the Feature Service layer. Only applicable for ArcGIS Server Feature Service layers.

The version of ArcGIS Server where the layer is published. Examples are 9.3, 9.31, 10. (Added at v2.1)

Visibility of the layer.

Known values: true | false

Default value: true

When true, the layer is visible at the current map scale. (Added at v3.1)

Known values: true | false

Indicates if WebGL is enabled on the layer. Note that this doesn't indicate that WebGL is actually being used in the rendering. Use

to check if the layer is drawn with WebGL.

Default value: true

Method Details

<form id="form1">
  <input type="file" id="fileinput" name="attachment" onchange="doSomething()" />
</form>

var formData = new FormData();
formData.append("attachment", file);

Apply edits to the feature layer. Applicable for layers created from a FeatureService or a FeatureCollection.

Date field values are always represented as

values. This means that when updating existing features, date fields must have numeric values and not date objects.

Array of features whose geometry and/or attributes have changed. Features must have a valid OBJECTID. The geometry of features is typically modified using the Edit toolbar. Attributes are modified using the Attribute Inspector.

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  var firePerimeterFL = new FeatureLayer( ... );
  var targetGraphic = firePerimeterFL.getSelectedFeatures()[0].setGeometry(reshapedGeometry);
  firePerimeterFL.applyEdits(null, [targetGraphic], null);
  ...
});

Adds a new attribute or changes the value of an existing attribute on the layer's node. Removes the attribute if the value is null or undefined. (Added at v3.7)

Clears the current selection.

Delete one or more attachments for the feature specified by the input ObjectId. Only applicable if

and

are true.

Disables feature reduction (for example clustering) on the layer. This is useful for certain workflows, such as editing, where feature reduction can hinder the desired user experience. Only applicable to point layers. (Added at v3.22)

featureLayer.disableFeatureReduction();

Disables all mouse events on the graphics layer.

Enables feature reduction (for example clustering) on the layer using the options set in

. Only applicable to point layers.

  featureLayer.enableFeatureReduction();

Enables all mouse events on the graphics layer.

Returns graphics representing the aggregation of several point features clustered together. Only applicable when

is

.

var aggregateGraphics = featureLayer.getAggregateGraphics();

Asynchrously returns custom data for the layer when available. (Added at v3.1)

Returns the current definition expression.

<options>

Returns an object that describes the edit capabilities of the layer. The returned object has the following properties:

<options>

var capabilities = featureLayer.getEditCapabilities();

if(capabilities.canUpdate){

  console.log("This layer can be updated");

}

Returns an object describing the most recent edit operation performed on the given feature, if available. (Added at v2.8)

<options>

• 'creation' indicates creation summary is desired.
• 'edit' indicates edit summary is desired.

{
  "action"        : "creation", // or "edit"
  "userId"        : "Mike",
  "minutes"       :  15,
  "hours"         :  5,
  "weekDay"       : "Tuesday",
  "formattedDate" : "1/1/2012",
  "formattedTime" : "9:30 AM",
  "displayPattern": "Minutes", // or "Seconds", "Minute", "Hour", "Hours", "WeekDay", "Full"
  "timeValue"     :  1330167842310
}

Returns a localized summary of the last edit operation performed on the given feature, if available. For example:

Edited by Bjorn seconds ago
Edited by Bjorn a minute ago
Edited by Bjorn 15 minutes ago
Edited by Bjorn an hour ago
Edited by Bjorn 5 hours ago
Edited by Bjorn on Tuesday at 1:30 PM
Edited by Bjorn on 4/27/2014 at 11:30 AM

The word "Edited" will be replaced by "Created" if the author has disabled editorField attribute but enabled creatorField attribute. The user component and date-time component may or may not be available depending on your layer's edit tracking settings (see

property of this layer for more information). An empty string will be returned if:

• the layer is not initialized or
• if the layer's edit tracking settings have been turned off or
• if the feature does not have edit tracking fields in its attributes.
(Added at v2.8)

<options>

• 'creation' indicates creation summary is desired.
• 'edit' indicates edit summary is desired.

featureLayer.getEditSummary(feature, {
  callback: function(feature, info) {
    if (info && info.userId) {
      info.userId = "<a href='http://users.my.org/profile/" + info.userId     + "'>" + info.userId + "</a>";
    }
    return info;
  }
});

Returns the options used to reduce the number of features visualized by the layer (for example clustering). This is only applicable to point layers. See

for more details.

featureLayer.getFeatureReduction();

Returns the

given the specified field name.

Returns reference to the map control the layer is added to. Returns null or undefined if it is not added to a map. (Added at v3.7)

Returns the current value of the maxAllowableOffset used by the layer. For non-editable layers in on-demand mode if autoGeneralize is enabled the maxAllowableOffset is set to the current map resolution. (Added at v2.7)

 var currentOffset = featureLayer.getMaxAllowableOffset();

Returns the layer's DOM node. (Added at v3.7)

Returns the list of fields used to order features by. For queries as well as rendering. (Added at v3.8)

Gets the currently selected features.

Gets the current selection symbol.

Returns graphics from the layer that are not represented by aggregate graphics when feature reduction (such as clustering) is

.

var singleGraphics = featureLayer.getSingleGraphics();

Get the current time definition applied to the feature layer.

require([
  "esri/map", "esri/layers/FeatureLayer", "esri/layers/TimeInfo", ... 
], function(Map, FeatureLayer, TimeInfo, ... ) {
  var timeSlider = new TimeSlider( ... );
  var featureLayer = new FeatureLayer();
  timeSlider.createTimeStopsByTimeInterval(featureLayer.getTimeDefinition(), 
    1, TimeInfo.UNIT_HOURS);
  ...
});

Returns a

describing the feature's type.

Indicates whether an error is thrown after the layer updates. (Added at v3.24)

Indicates if the layer is rendered in WebGL. (Added at v3.24)

Returns

if

is

and

is

. When

, the FeatureLayer will behave as if it were a polygon.

• Auto generalization will be enabled by default.
• Auto mode will treat the layer like a polygon layer.

citiesFeatureLayer.on("load", function featureLayerLoaded(event){
  var hasXYFootprint = citiesFeatureLayer.hasXYFootprint();
  console.log("Contains xyfootprints:", hasXYFootprint);
});

Sets the visibility of the layer to "false". The layer is not removed, but it is hidden from view.

Returns true if the FeatureLayer is editable. If the layer is editable, one or more of the following operations can be performed depending on the permissions set on the service.

• Add new features.
• Modify the geometry and attributes of existing features.
• Delete features.

To see which of the above editing actions may be performed on the layer, execute getEditCapabilities() on the layer after verifying that isEditable() returns true.

Indicates if feature reduction (for example clustering) is active in the view. Feature reduction is active at all scales. At any given scale, if there are features that do not fall within a cluster, they are displayed as individual features. This method is only applicable to point layers when

is

.

featureLayer.isFeatureReductionActive();

Indicates if feature reduction (for example clustering) is enabled. Only applicable to point layers. See also

.

featureLayer.isFeatureReductionEnabled();

Returns true if the layer is visible at the given scale. (Added at v3.1)

Query for information about attachments associated with the specified ObjectIds.

Get a count of the number of features that satisfy the input query. Valid only for layers published using ArcGIS Server 10 SP1 or greater. Layers published with earlier versions of ArcGIS Server return an error to the error callback. (Added at v2.1)

The input query. The query object has the following restrictions to avoid conflicts between layer and map properties.

• outFields specified by the query object are overridden by the outFields specified in the FeatureLayer constructor.
• The returnGeometry value specified by the query object is ignored and true is used.
• The outSpatialReference set by the query object is ignored and the map's spatial reference is used.

require([
  "esri/tasks/query", "FeatureLayer", ... 
], function(Query, FeatureLayer, ... ) {
  var query = new Query();
  var featureLayer = new FeatureLayer( ... );
  query.where = "POP90_SQMI < 100";
  featureLayer.queryCount(query, function(count) {
    console.log(count + " features satisfied the input query");
  }, function(error) {
    console.log(error);
  });      
  ...
});

Get the extent of features that satisfy the input query. The count of features that satisfy the input query is returned as well. This is valid only for hosted feature services on arcgis.com and for ArcGIS Server 10.3.1 and later. (Added at v3.9)

Query features from the feature layer. Layer definition and time definition are honored. Whenever possible the feature layer will perform the query on the client.

The input query. The query object has the following restrictions to avoid conflicts between layer and map properties.

• outFields specified by the query object are overridden by the outFields specified in the FeatureLayer constructor.
• The returnGeometry value specified by the query object is ignored and true is used. As of version 3.5 the returnGeometry value is honored.
• The outSpatialReference set by the query object is ignored and the map's spatial reference is used.

require([
  "esri/layers/FeatureLayer", "esri/tasks/query", ... 
], function(FeatureLayer, Query, ... ) {
  featureLayer = new FeatureLayer( ... );
  var query = new Query();
  query.objectIds = [features[0].attributes.OBJECTID];
  query.outFields = [ "*" ];
  // Query for the features with the given object ID
  featureLayer.queryFeatures(query, function(featureSet) {
  });
  ...
});

Query for ObjectIds. There is no limit on the number of ObjectIds that are returned from the server. Like queryFeatures this operation will perform queries on the client (browser) whenever possible. Valid only for layers published using ArcGIS Server 10 SP1 or greater.

The input query. The query object has the following restrictions to avoid conflicts between layer and map properties.

• outFields specified by the query object are overridden by the outFields specified in the FeatureLayer constructor.
• The returnGeometry value specified by the query object is ignored and true is used.
• The outSpatialReference set by the query object is ignored and the map's spatial reference is used.

require([
  "esri/layers/FeatureLayer", "esri/tasks/query", ... 
], function(FeatureLayer, Query, ... ) {
  var featureLayer = new FeatureLayer( ... );
  // create a query to fetch object IDs for all records
  var query = new Query();
  query.where = "1=1";
  
  featureLayer.queryIds(query, function(objectIds) {
    //do something with the objectIds here
  });
  ...
});

Query features or records, from another layer or table, related to features in this layer.

require([
  "esri/layers/FeatureLayer", "esri/tasks/RelationshipQuery", "dojo/_base/connect", ... 
], function(FeatureLayer, RelationshipQuery, connect, ... ) {
  var featureLayer = new FeatureLayer( ... );
  var relatedQuery = new RelationshipQuery();
  relatedQuery.outFields = ["AGREE_WITH_INCIDENT"];
  relatedQuery.relationshipId = 1;
  
  //query for the features related to the "clicked" feature
  connect.connect(featureLayer, "onClick", function(evt) {
    graphicAttributes = evt.graphic.attributes;
    relatedQuery.objectIds = [graphicAttributes.OBJECTID];
    featureLayer.queryRelatedFeatures(relatedQuery,relatedRecords);
  }
  ...
});

Redraws all the graphics in the graphics layer. Unlike refresh(), redraw does not re-query features from the server. (Added at v3.3)

Refreshes the features in the feature layer. The feature layer requeries all the features in the service, except the selected features, and updates itself.

Resumes layer drawing. (Added at v3.1)

Selects features from the FeatureLayer. Layer properties like layer definition and time definition are honored. The selection method defines how query results are passed to the selection. The feature layer will highlight the current selection if a selection symbol has been defined. Whenever possible, the feature layer will perform the query operation on the client (browser).

The input query. The query object has the following restrictions to avoid conflicts between layer and map properties.

• outFields specified by the query object are overridden by the outFields specified in the FeatureLayer constructor.
• The returnGeometry value specified by the query object is ignored and true is used.
• The outSpatialReference set by the query object is ignored and the map's spatial reference is used.

require([
  "esri/tasks/query", "esri/layers/FeatureLayer", ... 
], function(Query, FeatureLayer, ... ) {
  var query = new Query();
  var featureLayer = new FeatureLayer( ... );
  query.geometry = feature.geometry;
  featureLayer.selectFeatures(query,FeatureLayer.SELECTION_NEW);
  ...
});

Enable or disable auto generalization for the layer. Note that auto generalization is only applicable to non-editable feature layers in on-demand mode. (Added at v2.7)

featureLayer.setAutoGeneralize(false);

Sets the definition expression for the FeatureLayer. Only the features that match the definition expression are displayed. A definition expression limits the features available for display and queries by applying constraints to the layer's attribute fields. Setting a definition expression is useful when the dataset is large and you don't want to bring everything to the client for analysis. This method is typically called before adding the layer to the map. If the method is called after the layer is added to the map the layer will refresh itself to reflect the new definition expression.

This definition expression is combined with the layer's default definition expression which results in a further restriction of the layer.

featureLayer.setDefinitionExpression("STATE_NAME = 'South Carolina'");

Set the editability of feature layers created from a feature collection. This method is only valid for feature layers created from feature collections.

When the feature layer's editability is updated the onCapabilitiesChange event is fired. Use the isEditable method to determine if the layer is editable.

featureLayer.setEditable(true);

Sets feature reduction options on the layer (for example clustering options). When set, features in the layer will aggregate, thus changing the visualization. This will not change the renderer of the layer. See the valid parameters in the table below.

Support for feature reduction is limited to the following scenarios:

• Point data in FeatureLayer (from service or FeatureCollection) and CSVLayer.
• The map must have a spatial reference of Web Mercator or WGS84.
• If the layer contains more than 50,000 features, then only the first 50,000 will be clustered.
• A FeatureLayer created from a service URL must point to a service that supports pagination (ArcGIS Server version 10.3.1 or higher).
• When editing is initiated with the Editor widget, then feature reduction is disabled until the Editor widget is destroyed.
• Feature reduction is disabled when the layer has one of the following renderers: HeatmapRenderer, BlendRenderer, TemporalRenderer, or ScaleDependentRenderer.

<options>

  featureLayer.setFeatureReduction({
    type: "cluster",
    clusterRadius: 60
  });

Set the layer's data source to the specified geodatabase version. If the versionName is null then the data source will be the published map's default version. Only applicable if the layer's data source is registered as versioned in SDE. Only valid with ArcGIS Server services version 10.1 or greater. (Added at v2.7)

Specify or change the info template for a layer. (Added at v2.2)

require([
  "esri/InfoTemplate", ... 
], function(InfoTemplate, ... ) {
    var template = new InfoTemplate();

    template.setTitle("${qAddress}");

    template.setContent(getTextContent);

    featureLayer.setInfoTemplate(template);
  ...
});

Sets labeling info on the layer. Input value is an array of LabelClass objects. (Added at v3.10)

//make sure the Map's showLabels option is set to true
  var map = new Map("map", {
    basemap: "streets-vector",
    center:[-80, 30],
    zoom: 4,
    showLabels : true
  });
 
//create featurelayer
  var flayer = new FeatureLayer(url, {
    outFields: ["*"] //make sure field to label is specified here in outFields
  });


//create a text symbol and renderer to define the style of labels
   var labelSymbol = new TextSymbol(); 
   var labelRenderer = new SimpleRenderer(labelSymbol);


var json = {
  "labelExpressionInfo": {"value": "{LocalTime}"},
  "useCodedValues": false,
  "labelPlacement":"above-right",
  "fieldInfos": [{fieldName: "LocalTime",format: { "dateFormat": "shortDate"}}]
  };

//create instance of LabelClass
  var lc = new LabelClass(json);
  lc.symbol = labelSymbol; // symbol also can be set in LabelClass' json
  flayer.setLabelingInfo([ lc ]);

Sets the maximum allowable offset used when generalizing geometries. The offset is in the units of the spatialReference. This is ignored when working with editable layers.

require([
  "esri/layers/FeatureLayer", ... 
], function(FeatureLayer, ... ) {
  featureLayer = new FeatureLayer(featureLayerUrl, {
    maxAllowableOffset: 1000
  });
  ...
});

Set the maximum scale for the layer. (Added at v3.1)

Set the minimum scale for the layer. (Added at v3.1)

Initial opacity or transparency of layer. Not supported in Internet Explorer.

featureLayer.setOpacity(.50);

Changes the layer's refresh interval to the given value (in minutes). Non-zero value sets up automatic layer refresh at the specified interval. Value of 0 stops auto refresh. (Added at v3.7)

Set the renderer for the feature layer.

require([
  "esri/symbols/SimpleFillSymbol", "esri/Color", "esri/renderers/SimpleRenderer", ... 
], function(SimpleFillSymbol, Color, SimpleRenderer, ... ) {
  var symbol = new SimpleFillSymbol().setColor(new Color([255,0,0,0.5]));

  var renderer = new SimpleRenderer(symbol);

  featureLayer.setRenderer(renderer);
  ...
});

Set the scale range for the layer. If minScale and maxScale are set to 0 then the layer will be visible at all scales. (Added at v2.5)

featureLayer.setScaleRange(591657528,147914381);

Sets the selection symbol for the feature layer. If no symbol is specified, features are drawn using the layer's renderer.

require([
  "esri/layers/FeatureLayer", "esri/symbols/SimpleFillSymbol", "esri/Color", ... 
], function(FeatureLayer, SimpleFillSymbol, Color, ... ) {
  var featureLayer = new FeatureLayer( ... );
  var selectionSymbol = new SimpleFillSymbol().setColor(new Color([255,255,0,0.5]));
  featureLayer.setSelectionSymbol(selectionSymbol);
  ...
});

Sets whether to display labels or not. Set to false to turn off labeling. (Added at v3.11)

Sets the time definition for the feature layer. A time definition temporarily filters the features in the layer to match the specified time extent. Only applicable for time-aware layers. Only supported when the feature layer is in snapshot mode.

In addition to time definition, time-aware layers also support the time extent set on the map. Time-aware layers automatically update when the map's time extent is changed, similar to how layers react when the map's spatial reference is modified. If a layer's time definition is set to display features between 1970 and 1975 and the map has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975

require([
  "esri/TimeExtent", "esri/layers/FeatureLayer", ... 
], function(TimeExtent, FeatureLayer, ... ) {
  var defn = new TimeExtent();
  var featureLayer( ... );
  defn.startTime = new Date("November 30,2009 6:00:00")
  defn.endTime = new Date("November 30, 2009 8:00:00");
  featureLayer.setTimeDefinition(defn);
  ...
});

Time offset allows you to display the features at a different time so they can be overlaid on top of previous or future time periods. For example, to visualize the growth pattern of two wild fires that happened in two different years, one of the layers can be given an offset that will cause it to appear as if the fire started at the same time as the other fire. Note that the offset does not change the temporal component of the data itself and has no effect if the layer is not time aware.

Example: If a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972 (for display purposes only, query and selection are not affected by offset).

Determine if the layer will update its content based on the map's current time extent. Default value is true. (Added at v2.2)

Sets the visibility of the layer. When true, the layer is visible.

Toggles WebGL rendering on/off on the layer. (Added at v3.24)

layer.setWebGLEnabled(true);

Sets the visibility of the layer to "true".

Suspends layer drawing. (Added at v3.1)

Returns an easily serializable object representation of the layer. Regardless of the layer's mode of operation, only features currently available on the client are included.

{

  layerDefinition: <Object>,

    featureSet: {

    features:<Object[]>

  }

}

Event Details

[ On Style Events | Connect Style Event ]

Fires when addAttachments() is complete. Should be used in favor of onAddAttachmentComplete. (Added at v3.5)

Fired before edits are applied to the feature layer. Should be used in favor of onBeforeApplyEdits. (Added at v3.5)

Fired when the capabilities of the layer are modified using the setEditable method. Should be used in favor of onCapabilitiesChange. (Added at v3.5)

Fires when a graphic has been clicked. Should be used in favor of onClick. (Added at v3.5)

Fires when a feature has been double clicked. (Added at v3.6)

require([
  "dojo/_base/connect", "esri/toolbars/Edit", ... 
], function(connect, Edit, ... ) {
  var editToolbar = new Edit( ... );
  connect.connect(firePerimeterFL, "onDblClick", function(evt) {
    editToolbar.activate(Edit.EDIT_VERTICES , evt.graphic);
  });
  ...
});

Fires when deleteAttachments is complete. Should be used in favor of onDeleteAttachmentsComplete. (Added at v3.5)

Fires after applyEdits() is complete. Should be used in favor of onEditsComplete. (Added at v3.5)

Fires when there is a problem retrieving a layer. Should be used in favor of onError. (Added at v3.5)

Fired when the geodatabase version is switched. (Added at v3.5)

Fires when a graphic is added to the GraphicsLayer. Should be used in favor of onGraphicAdd. (Added at v3.5)

Fires when a graphic is drawn. A graphic is drawn or redrawn when:

• When it is added to the layer.
• When Geometry or Symbol is modified.
• When it enters the viewport and intersects the map extent.
• When the layer is redrawn.

Fires when a graphic's DOM node is created and added to the layer. Fires only when the layer surfaceType is "svg" or "vml". (Added at v3.7)

This event is fired when a graphic's DOM node is removed (consider the node destroyed). The DOM node of a graphic is removed when:

• Graphic is removed from the layer.
• Graphic exits the viewport on map navigation.
• When a symbol change cannot be applied to the Graphic without replacing the current node with a new one. For example: when a marker symbol is changed from SimpleMarkerSymbol to PictureMarkerSymbol, onGraphicNodeRemove will be fired for the node that is being replaced (SVG Circle) and onGraphicNodeAdd will be fired for the new node (SVG Image).

Fires only when the layer surfaceType is

or

.

Fires when a graphic is removed from the GraphicsLayer. Should be used in favor of onGraphicRemove. (Added at v3.5)

Fires when all graphics in the GraphicsLayer are cleared. Should be used in favor of onGraphicsClear. (Added at v3.5)

Fired when labeling info on the layer changes. (Added at v3.10)

Fires after layer properties for the layer are successfully populated. This event must be successful before the layer can be added to the map. Should be used in favor of onLoad. (Added at v3.5)

Fires when a mouse button is pressed down and the mouse cursor is on a graphic. Should be used in favor of onMouseDown. (Added at v3.5)

Fires while the mouse is being dragged until the mouse button is released. Should be used in favor of onMouseDrag. (Added at v3.5)

Fires as the mouse moves through a graphic on the GraphicsLayer. Should be used in favor of onMouseMove. (Added at v3.5)

Fires as the mouse exits a graphic on the GraphicsLayer. Should be used in favor of onMouseOut. (Added at v3.5)

Fires when the mouse first enters into a graphic on the GraphicsLayer. Should be used in favor of onMouseOver. (Added at v3.5)

Fires when a mouse button is released and the mouse cursor is on a graphic. Should be used in favor of onMouseUp. (Added at v3.5)

Fires when the layer opacity has been changed, and returns an object with the opacity value. Should be used in favor of onOpacityChange. (Added at v3.5)

Fires when queryAttachmentInfos method is called. Should be used in favor of onQueryAttachmentInfosComplete. (Added at v3.5)

Fires when the query for the count is complete. This event is only available for layers published using ArcGIS Server 10 SP1 or later. Should be used in favor of onQueryCountComplete. (Added at v3.5)

Fires when queryExtent method has completed. (Added at v3.9)

Fires when queryFeatures() is complete. Should be used in favor of onQueryFeaturesComplete. (Added at v3.5)

Fires when queryIds() is complete. Should be used in favor of onQueryIdsComplete. (Added at v3.5)

Fired when the feature layer could not draw all the features due to a maxRecordCount limitation on a query operation. Should be used in favor of onQueryLimitExceeded. (Added at v3.5)

Fires when queryRelatedFeatures() is complete. Should be used in favor of onQueryRelatedFeaturesComplete. (Added at v3.5)

{
  "15": <FeatureSet1>,
  "9":  <FeatureSet2>
}

This event is fired when the layer's refreshInterval is modified. (Added at v3.7)

Fires right before the actual refresh kicks in for the layer, and only fires when the refresh is triggered by the

.

Fires when a layer resumes drawing. (Added at v3.6)

Fires when a layer's minScale and/or maxScale is changed. Should be used in favor of onScaleRangeChange. (Added at v3.5)

Fires when a layer's scale visibility changes. The scale visibility changes when a layer is initially visible and becomes invisible because the map scale does not intersect the layer's scale range or vice versa. Should be used in favor of onScaleVisibilityChange. (Added at v3.5)

Fires after clearSelection has been called. Should be used in favor of onSelectionClear. (Added at v3.5)

Fires when selectFeatures() completes. Should be used in favor of onSelectionComplete. (Added at v3.5)

Fired when the feature layer's labels are changed. Should be used in favor of onShowLabelsChange. (Added at v3.11)

Fires when a layer suspends drawing. (Added at v3.6)

Fired when the layer has finished updating its content. This event is always preceded by update-start. Should be used in favor of onUpdateEnd. (Added at v3.5)

Fired when the layer begins to update its content. The following table describes when the event is fired in various modes.

• When the layer is added to the map.
• When layer properties such as definition expression, time definition or time offset are modified.
• When the map's time extent changes.
• When the layer is refreshed.

• When the layer is added to the map.
• When the map's spatial extent or time extent changes.
• When layer properties such as definition expression or time offset are modified.
• When the layer is refreshed.

Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. Should be used in favor of onVisibilityChange. (Added at v3.5)

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4