FeatureLayer

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - edu.ucdavis.cstars.client.layers.Layer
  - - edu.ucdavis.cstars.client.layers.GraphicsLayer
    - - edu.ucdavis.cstars.client.layers.FeatureLayer

```
public class FeatureLayer
extends GraphicsLayer
```
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. If the underlying layer (or table) is from a Feature Service, its features can be edited.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FeatureLayer.EditCapabilities`
`static class`	`FeatureLayer.EditFieldsInfo`
`static class`	`FeatureLayer.FeatureCollectionObject`
`static class`	`FeatureLayer.Modes`
`static class`	`FeatureLayer.Options`
`static class`	`FeatureLayer.OwnershipAccessControl`
`static class`	`FeatureLayer.Popups`
`static class`	`FeatureLayer.RelatedFeatures`
`static class`	`FeatureLayer.Relationship`
`static class`	`FeatureLayer.Selections`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAddAttachmentHandler(AddAttachmentHandler handler)` Add event handler for onAddAttachmentComplete.
`Deferred`	`addAttachment(int objectId, com.google.gwt.user.client.ui.FormPanel formNode)` Add an attachment to the feature specified by the ObjectId.
`Deferred`	`addAttachment(int objectId, com.google.gwt.user.client.ui.FormPanel formNode, AddAttachmentCallback callback)` Add an attachment to the feature specified by the ObjectId.
`void`	`addBeforeApplyEditsHandler(BeforeApplyEditsHandler handler)` Add event handler for onBeforeApplyEdits.
`void`	`addCapabilitiesChange(CapabilitiesChangeHandler handler)` Set the capabilities change handler.
`void`	`addClearSelectionHandler(ClearSelectionHandler handler)` Add event handler for onSelectionClear.
`void`	`addDeleteAttachmentsHandler(DeleteAttachmentsHandler handler)` Add event handler for onDeleteAttachmentsComplete.
`void`	`addEditsCompleteHandler(ApplyEditsHandler handler)` Add event handler for onEditsComplete.
`void`	`addQueryAttachmentInfosHandler(QueryAttachmentInfosHandler handler)` Add event handler for onQueryAttachmentInfosComplete
`void`	`addQueryCountHandler(QueryCountHandler handler)` Add event handler for onQueryCountComplete.
`void`	`addQueryFeaturesHandler(QueryFeaturesHandler handler)` Add event handler for onQueryFeaturesComplete.
`void`	`addQueryIdsHandler(QueryIdsHandler handler)` Add event handler for onQueryIdsComplete.
`void`	`addQueryRelatedFeaturesHandler(QueryRelatedFeaturesHandler handler)` Add event handler for onQueryRelatedFeaturesComplete.
`void`	`addSelectFeaturesHandler(SelectFeaturesHandler handler)` Add event handler for onSelectionComplete.
`Deferred`	`applyEdits(Graphic[] adds, Graphic[] updates, Graphic[] deletes)` Apply edits to the feature layer.
`Deferred`	`applyEdits(Graphic[] adds, Graphic[] updates, Graphic[] deletes, ApplyEditsCallback callback)` Apply edits to the feature layer.
`static boolean`	`assertLoaded()` Check that the esri.layers.featurelayer package has been loaded
`FeatureLayer`	`clearSelection()` Clears the current selection.
`static FeatureLayer`	`create(FeatureLayer.FeatureCollectionObject featureCollectionObject)` Creates a new instance of a feature layer object from the ArcGIS Server REST resource identified by the input URL.
`static FeatureLayer`	`create(FeatureLayer.FeatureCollectionObject featureCollectionObject, FeatureLayer.Options options)` Creates a new instance of a feature layer object from the ArcGIS Server REST resource identified by the input URL.
`static FeatureLayer`	`create(java.lang.String url)` Creates a new instance of a feature layer object from the ArcGIS Server REST resource identified by the input URL.
`static FeatureLayer`	`create(java.lang.String url, FeatureLayer.Options options)` Creates a new instance of a feature layer object from the ArcGIS Server REST resource identified by the input URL.
`Deferred`	`deleteAttachments(int objectId, int[] attachmentIds)` Delete one or more attachments for the feature specified by the input ObjectId.
`Deferred`	`deleteAttachments(int objectId, int[] attachmentIds, DeleteAttachmentsCallback callback)` Delete one or more attachments for the feature specified by the input ObjectId.
`java.lang.String`	`getCapabilities()` Information about the capabilities enabled for this layer.
`java.lang.String`	`getCopyright()` Copyright information for the layer.
`java.lang.String`	`getDefaultDefinitionExpression()` Metadata describing the default definition expression for the layer as defined by the service.
`java.lang.String`	`getDefinitionExpression()` Returns the current definition expression.
`java.lang.String`	`getDescription()` The description of the layer as defined in the map service.
`java.lang.String`	`getDisplayField()` The name of the layer's primary display field.
`FeatureLayer.EditCapabilities`	`getEditCapabilities()` Returns an object that describes the edit capabilities of the layer.
`FeatureLayer.EditCapabilities`	`getEditCapabilities(Graphic graphic, java.lang.String userId)` Returns an object that describes the edit capabilities of the layer.
`FeatureLayer.EditFieldsInfo`	`getEditFieldsInfo()` Indicates the field names for the editor fields.
`com.google.gwt.core.client.JsArray<Field>`	`getFields()` The array of fields in the layer.
`Extent`	`getFullExtent()` The full extent of the layer.
`java.lang.String`	`getGeometryType()` Geometry type of the features in the layer.
`java.lang.String`	`getGlobalIdField()` The globalIdField for the layer.
`int`	`getLayerId()` Unique ID of the layer that the FeatureLayer was contructed against.
`double`	`getMaxAllowableOffset()` Returns the current value of the maxAllowableOffset used by the layer.
`int`	`getMaxRecordCount()` The maximum number of results that will be returned from a query.
`float`	`getMaxScale()` Maximum visible scale for the layer.
`float`	`getMinScale()` Minimum visible scale for the layer.
`java.lang.String`	`getName()` The name of the layer as defined in the map service.
`java.lang.String`	`getObjectIdField()` The name of the field that contains the Object ID field for the layer.
`FeatureLayer.OwnershipAccessControl`	`getOwnershipBasedAccessControlForFeatures()` Indicates the ownership access control configuration.
`com.google.gwt.core.client.JsArray<FeatureLayer.Relationship>`	`getRelationships()` Each element in the array is an object that describes the layer's relationship with another layer or table.
`com.google.gwt.core.client.JsArray<Graphic>`	`getSelectedFeatures()` Gets the currently selected features.
`Symbol`	`getSelectionSymbol()` Gets the current selection symbol.
`LayerDataSource`	`getSourceAsLayerDataSource()` The dynamic layer or table source
`LayerMapSource`	`getSourceAsLayerMapSource()` The dynamic layer or table source
`com.google.gwt.core.client.JsArray<FeatureTemplate>`	`getTemplates()` An array of feature templates defined in the Feature Service layer.
`TimeExtent`	`getTimeDefinition()` Get the current time definition applied to the feature layer.
`TimeInfo`	`getTimeInfo()` Time information for the layer, such as start time field, end time field, track id field, layers time extent and the draw time interval.
`java.lang.String`	`getType()` Specifies the type of layer.
`java.lang.String`	`getTypeIdField()` The field that represents the Type ID field.
`com.google.gwt.core.client.JsArray<FeatureType>`	`getTypes()` An array of sub types defined in the Feature Service layer.
`double`	`getVersion()` The version of ArcGIS Server where the layer is published.
`boolean`	`hasAttachments()` True if attachments are enabled on the feature layer.
`java.lang.String`	`htmlPopupType()` The html popup type defined for the layer.
`boolean`	`isEditable()` Returns true if the FeatureLayer is editable.
`Deferred`	`queryAttachmentInfos(int objectId)` Query for information about attachments associated with the specified ObjectIds.
`Deferred`	`queryAttachmentInfos(int objectId, QueryAttachmentInfosCallback callback)` Query for information about attachments associated with the specified ObjectIds.
`Deferred`	`queryCount(Query query)` Get a count of the number of features that satisfy the input query.
`Deferred`	`queryCount(Query query, QueryCountCallback callback)` Get a count of the number of features that satisfy the input query.
`Deferred`	`queryFeatures(Query query)` Query features from the feature layer.
`Deferred`	`queryFeatures(Query query, QueryFeaturesCallback callback)` Query features from the feature layer.
`Deferred`	`queryIds(Query query)` Query for ObjectIds.
`Deferred`	`queryIds(Query query, QueryIdsCallback callback)` Query for ObjectIds.
`Deferred`	`queryRelatedFeatures(RelationshipQuery relQuery)` Query features or records, from another layer or table, related to features in this layer.
`Deferred`	`queryRelatedFeatures(RelationshipQuery relQuery, QueryRelatedFeaturesCallback callback)` Query features or records, from another layer or table, related to features in this layer.
`void`	`refresh()` Refreshes the features in the feature layer.
`Deferred`	`selectFeatures(Query query)` Selects features from the FeatureLayer.
`Deferred`	`selectFeatures(Query query, FeatureLayer.Selections selectionMethod)` Selects features from the FeatureLayer.
`Deferred`	`selectFeatures(Query query, FeatureLayer.Selections selectionMethod, SelectFeaturesCallback callback)` Selects features from the FeatureLayer.
`Deferred`	`selectFeatures(Query query, SelectFeaturesCallback callback)` Selects features from the FeatureLayer.
`FeatureLayer`	`setAutoGeneralize(boolean enable)` Enable or disable auto generalization for the layer.
`FeatureLayer`	`setDefinitionExpression(java.lang.String expression)` Set's the definition expression for the FeatureLayer.
`FeatureLayer`	`setEditable(boolean editable)` Set the editability of feature layers created from a feature collection.
`FeatureLayer`	`setGDBVersion(java.lang.String versionName)` Set the layer's data source to the specified geodatabase version.
`void`	`setMaxAllowableOffset(double offset)` Sets the maximum allowable offset used when generalizing geometries.
`void`	`setScaleRange(double minScale, double maxScale)` Set the scale range for the layer.
`FeatureLayer`	`setSelectionSymbol(Symbol symbol)` Set's the selection symbol for the feature layer.
`FeatureLayer`	`setTimeDefinition(TimeExtent definition)` Set's the time definition for the feature layer.
`FeatureLayer`	`setTimeOffset(int offsetValue, TimeInfo.TimeUnits offsetUnits)` Time offset allows you to display the features at a different time so they can be overlayed on top of previous or future time periods.
`void`	`setUseMapTime(boolean update)` Determine if the layer will update its content based on the map's current time extent.
`boolean`	`supportsAdvancedQueries()` When true, the layer supports orderByFields in a query operation.
`boolean`	`supportsStatistics()` When true, the layer supports statistical functions in query operations.
`com.google.gwt.core.client.JavaScriptObject`	`toJson()` Returns an easily serializable object representation of the layer.

Methods inherited from class edu.ucdavis.cstars.client.layers.GraphicsLayer
add, addClickHandler, addDblClickHandler, addGraphicAddHandler, addGraphicRemoveHandler, addGraphicsClearHandler, addMouseDownHandler, addMouseDragHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, clear, create, create, disableMouseEvents, enableMouseEvents, getGraphics, getRenderer, remove, setInfoTemplate, setOpacity, setRenderer

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer
addErrorHandler, addLoadHandler, addOpacityChangeHandler, addUpdateEndHandler, addUpdateHandler, addUpdateStartHandler, addVisibilityChangeHandler, getCredential, getId, getOpacity, getUrl, hide, isloaded, isVisible, setOpacity, setVisibility, show

Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static FeatureLayer create(java.lang.String url)
```
    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.
    
    Parameters:
    url - - URL to the ArcGIS Server REST resource that represents a feature service.
    
    Returns:
    FeatureLayer
  - create
```
public static FeatureLayer create(java.lang.String url,
                  FeatureLayer.Options options)
```
    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.
    
    Parameters:
    url - - URL to the ArcGIS Server REST resource that represents a feature service.
    options - - Optional parameters
    
    Returns:
    FeatureLayer
  - create
```
public static FeatureLayer create(FeatureLayer.FeatureCollectionObject featureCollectionObject)
```
    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.
    
    Parameters:
    featureCollectionObject - - layer information
    
    Returns:
    FeatureLayer
  - create
```
public static FeatureLayer create(FeatureLayer.FeatureCollectionObject featureCollectionObject,
                  FeatureLayer.Options options)
```
    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.
    
    Parameters:
    featureCollectionObject - - layer information
    options - - Optional parameters
    
    Returns:
    FeatureLayer
  - assertLoaded
```
public static boolean assertLoaded()
```
    Check that the esri.layers.featurelayer package has been loaded
    
    Returns:
    boolean
  - getCapabilities
```
public final java.lang.String getCapabilities()
```
    Information about the capabilities enabled for this layer.
    
    Returns:
    String
  - getCopyright
```
public final java.lang.String getCopyright()
```
    Copyright information for the layer.
    
    Returns:
    String
  - getDefaultDefinitionExpression
```
public final java.lang.String getDefaultDefinitionExpression()
```
    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 e.g., "COUNTY='San Diego'".
    
    Returns:
    String
  - getDescription
```
public final java.lang.String getDescription()
```
    The description of the layer as defined in the map service.
    
    Returns:
    String
  - getDisplayField
```
public final java.lang.String getDisplayField()
```
    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.
    
    Returns:
    String
  - getEditFieldsInfo
```
public final FeatureLayer.EditFieldsInfo getEditFieldsInfo()
```
    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. Requires ArcGIS Server feature service version 10.1 or greater. (As of v2.6)
    
    Returns:
    EditFieldsInfo
  - getFields
```
public final com.google.gwt.core.client.JsArray<Field> getFields()
```
    The array of fields in the layer.
    
    Returns:
    JsArray
  - getFullExtent
```
public final Extent getFullExtent()
```
    The full extent of the layer.
    
    Returns:
    Extent
  - getGeometryType
```
public final java.lang.String getGeometryType()
```
    Geometry type of the features in the layer. Can be one of the following: "esriGeometryPoint", "esriGeometryPolygon" or "esriGeometryPolyline".
    
    Returns:
    String
  - getGlobalIdField
```
public final java.lang.String getGlobalIdField()
```
    The globalIdField for the layer.
    
    Returns:
    String
  - hasAttachments
```
public final boolean hasAttachments()
```
    True if attachments are enabled on the feature layer. Use the queryAttachmentInfos method to determine if the 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.
    
    Returns:
    boolean
  - htmlPopupType
```
public final java.lang.String htmlPopupType()
```
    The html popup type defined for the layer. View the constants table for a list of valid values.
    
    Returns:
    String
  - getLayerId
```
public final int getLayerId()
```
    Unique ID of the layer that the FeatureLayer was contructed against.
    
    Returns:
    int
  - getMaxRecordCount
```
public final int getMaxRecordCount()
```
    The maximum number of results that will be returned from a query. Requires ArcGIS Server version 10.1 or greater. (As of v2.6)
    
    Returns:
    int
  - getMaxScale
```
public final float getMaxScale()
```
    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 that the layer does not have a maxium scale.
    
    Returns:
    float
  - getMinScale
```
public final float getMinScale()
```
    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 that the layer does not have a minimum scale.
    
    Returns:
    float
  - getName
```
public final java.lang.String getName()
```
    The name of the layer as defined in the map service.
    
    Returns:
    String
  - getObjectIdField
```
public final java.lang.String getObjectIdField()
```
    The name of the field that contains the Object ID field for the layer.
    
    Returns:
    String
  - getOwnershipBasedAccessControlForFeatures
```
public final FeatureLayer.OwnershipAccessControl getOwnershipBasedAccessControlForFeatures()
```
    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 allowDeleteToOthers and allowUpdateToOthers. When true features can be deleted or updated by users other than the creator.
    
    Returns:
    OwnershipAccessControl
  - getRelationships
```
public final com.google.gwt.core.client.JsArray<FeatureLayer.Relationship> getRelationships()
```
    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.
    
    Returns:
    JsArray
  - getSourceAsLayerMapSource
```
public final LayerMapSource getSourceAsLayerMapSource()
```
    The dynamic layer or table source
    
    Returns:
    LayerMapSource
  - getSourceAsLayerDataSource
```
public final LayerDataSource getSourceAsLayerDataSource()
```
    The dynamic layer or table source
    
    Returns:
    LayerMapSource
  - supportsAdvancedQueries
```
public final boolean supportsAdvancedQueries()
```
    When true, the layer supports orderByFields in a query operation. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)
    
    Returns:
    boolean
  - supportsStatistics
```
public final boolean supportsStatistics()
```
    When true, the layer supports statistical functions in query operations. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)
    
    Returns:
    boolean
  - getTemplates
```
public final com.google.gwt.core.client.JsArray<FeatureTemplate> getTemplates()
```
    An array of feature templates defined in the Feature Service layer. Only applicable for ArcGIS Server Feature Service layers.
    
    Returns:
    JsArray
  - getTimeInfo
```
public final TimeInfo getTimeInfo()
```
    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.
    
    Returns:
    TimeInfo
  - getType
```
public final java.lang.String getType()
```
    Specifies the type of layer. Can be "Feature Layer" or "Table".
    
    Returns:
    String
  - getTypeIdField
```
public final java.lang.String getTypeIdField()
```
    The field that represents the Type ID field. Only applicable for ArcGIS Server Feature Service layers.
    
    Returns:
    String
  - getTypes
```
public final com.google.gwt.core.client.JsArray<FeatureType> getTypes()
```
    An array of sub types defined in the Feature Service layer. Only applicable for ArcGIS Server Feature Service layers.
    
    Returns:
    JsArray
  - getVersion
```
public final double getVersion()
```
    The version of ArcGIS Server where the layer is published.
    
    Returns:
    float
  - addAttachment
```
public final Deferred addAttachment(int objectId,
                     com.google.gwt.user.client.ui.FormPanel formNode,
                     AddAttachmentCallback callback)
```
    Add an attachment to the feature specified by the ObjectId. Only applicable if isEditable and hasAttachments are true.
    
    Parameters:
    objectId - - The ObjectId of the feature to which the attachment is added.
    formNode - - GWT FormPanel that contains a file upload field pointing to the file to be added as an attachment.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - addAttachment
```
public final Deferred addAttachment(int objectId,
                     com.google.gwt.user.client.ui.FormPanel formNode)
```
    Add an attachment to the feature specified by the ObjectId. Only applicable if isEditable and hasAttachments are true.
    
    Parameters:
    objectId - - The ObjectId of the feature to which the attachment is added.
    formNode - - GWT FormPanel that contains a file upload field pointing to the file to be added as an attachment.
    
    Returns:
    Deferred
  - applyEdits
```
public final Deferred applyEdits(Graphic[] adds,
                  Graphic[] updates,
                  Graphic[] deletes,
                  ApplyEditsCallback callback)
```
    Apply edits to the feature layer. Only applicable for layers in a feature service.
    
    Parameters:
    adds - - Array of features to add to the layer in the feature service. New features are typically created using the Draw toolbar.
    updates - - 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.
    deletes - - Array of features to delete. Must have valid ObjectId
    callback - - This function will be called when the operation is complete.
    
    Returns:
    Deferred
  - applyEdits
```
public final Deferred applyEdits(Graphic[] adds,
                  Graphic[] updates,
                  Graphic[] deletes)
```
    Apply edits to the feature layer. Only applicable for layers in a feature service.
    
    Parameters:
    adds - - Array of features to add to the layer in the feature service. New features are typically created using the Draw toolbar.
    updates - - 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.
    deletes - - Array of features to delete. Must have valid ObjectId
    
    Returns:
    Deferred
  - clearSelection
```
public final FeatureLayer clearSelection()
```
    Clears the current selection.
    
    Returns:
    FeatureLayer
  - deleteAttachments
```
public final Deferred deleteAttachments(int objectId,
                         int[] attachmentIds,
                         DeleteAttachmentsCallback callback)
```
    Delete one or more attachments for the feature specified by the input ObjectId. Only applicable if isEditable and hasAttachments are true.
    
    Parameters:
    objectId - - The ObjectId of the feature from which the attachment is removed.
    attachmentIds - - The array of attachment ids to delete.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - deleteAttachments
```
public final Deferred deleteAttachments(int objectId,
                         int[] attachmentIds)
```
    Delete one or more attachments for the feature specified by the input ObjectId. Only applicable if isEditable and hasAttachments are true.
    
    Parameters:
    objectId - - The ObjectId of the feature from which the attachment is removed.
    attachmentIds - - The array of attachment ids to delete.
    
    Returns:
    Deferred
  - getDefinitionExpression
```
public final java.lang.String getDefinitionExpression()
```
    Returns the current definition expression.
    
    Returns:
    String
  - getEditCapabilities
```
public final FeatureLayer.EditCapabilities getEditCapabilities()
```
    Returns an object that describes the edit capabilities of the layer.
    
    Returns:
    EditCapabilities
  - getEditCapabilities
```
public final FeatureLayer.EditCapabilities getEditCapabilities(Graphic graphic,
                                                java.lang.String userId)
```
    Returns an object that describes the edit capabilities of the layer. If the layer supports ownership based access control, use the options to determine if the specified user can edit features. Ownership based access control requires ArcGIS Server services version 10.1 or greater.
    
    Parameters:
    graphic - - Check to see if the specified feature can be edited by the specified user.
    userId - - The name of the currently logged in user. If the application uses the IdentityManager the IdentityManager supplies the layer with the userId so this parameter is not required.
    
    Returns:
    EditCapabilities
  - getMaxAllowableOffset
```
public final double getMaxAllowableOffset()
```
    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. (As of v2.7)
    
    Returns:
  - getSelectedFeatures
```
public final com.google.gwt.core.client.JsArray<Graphic> getSelectedFeatures()
```
    Gets the currently selected features.
    
    Returns:
    JsArray
  - getSelectionSymbol
```
public final Symbol getSelectionSymbol()
```
    Gets the current selection symbol.
    
    Returns:
    Symbol
  - getTimeDefinition
```
public final TimeExtent getTimeDefinition()
```
    Get the current time definition applied to the feature layer.
    
    Returns:
    TimeExtent
  - isEditable
```
public final boolean isEditable()
```
    Returns true if the FeatureLayer is editable. If the layer is editable the following operations can be performed. - Add new features. - Modify the geometry and attributes of existing features. - Delete features.
    
    Returns:
    boolean
  - queryAttachmentInfos
```
public final Deferred queryAttachmentInfos(int objectId,
                            QueryAttachmentInfosCallback callback)
```
    Query for information about attachments associated with the specified ObjectIds.
    
    Parameters:
    objectId - - The ObjectId for the feature to query for attachment information.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - queryAttachmentInfos
```
public final Deferred queryAttachmentInfos(int objectId)
```
    Query for information about attachments associated with the specified ObjectIds.
    
    Parameters:
    objectId - - The ObjectId for the feature to query for attachment information.
    
    Returns:
    Deferred
  - queryCount
```
public final Deferred queryCount(Query query,
                  QueryCountCallback callback)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - queryCount
```
public final Deferred queryCount(Query query)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    
    Returns:
    Deferred
  - queryFeatures
```
public final Deferred queryFeatures(Query query,
                     QueryFeaturesCallback callback)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - queryFeatures
```
public final Deferred queryFeatures(Query query)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    
    Returns:
    Deferred
  - queryIds
```
public final Deferred queryIds(Query query,
                QueryIdsCallback callback)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - queryIds
```
public final Deferred queryIds(Query query)
```
    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.
    
    Parameters:
    query - - 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 overriden 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.
    
    Returns:
    Deferred
  - queryRelatedFeatures
```
public final Deferred queryRelatedFeatures(RelationshipQuery relQuery,
                            QueryRelatedFeaturesCallback callback)
```
    Query features or records, from another layer or table, related to features in this layer.
    
    Parameters:
    relQuery - - The input query.
    callback - - The function to call when the method has completed.
    
    Returns:
    Deferred
  - queryRelatedFeatures
```
public final Deferred queryRelatedFeatures(RelationshipQuery relQuery)
```
    Query features or records, from another layer or table, related to features in this layer.
    
    Parameters:
    relQuery - - The input query.
    
    Returns:
    Deferred
  - refresh
```
public final void refresh()
```
    Refreshes the features in the feature layer. The feature layer requeries all the features in the service, except the selected features, and updates itself.
  - selectFeatures
```
public final Deferred selectFeatures(Query query,
                      SelectFeaturesCallback callback)
```
    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).
    
    Parameters:
    query - - 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 overriden 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.
    callback - - The function to call when the method has completed.
    
    Returns:
    - Deferred
  - selectFeatures
```
public final Deferred selectFeatures(Query query)
```
    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).
    
    Parameters:
    query - - 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 overriden 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.
    
    Returns:
    - Deferred
  - selectFeatures
```
public final Deferred selectFeatures(Query query,
                      FeatureLayer.Selections selectionMethod,
                      SelectFeaturesCallback callback)
```
    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).
    
    Parameters:
    query - - 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 overriden 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.
    selectionMethod - - The selection method defines how the restul of the selection is combined with the existing selection. The default option is to create a new selection.
    callback - - The function to call when the method has completed.
    
    Returns:
    - Deferred
  - selectFeatures
```
public final Deferred selectFeatures(Query query,
                      FeatureLayer.Selections selectionMethod)
```
    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).
    
    Parameters:
    query - - 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 overriden 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.
    callback - - The function to call when the method has completed.
    
    Returns:
    - Deferred
  - setAutoGeneralize
```
public final FeatureLayer setAutoGeneralize(boolean enable)
```
    Enable or disable auto generalization for the layer. Note that auto generalization is only applicable to non-editable feature layers in on-demand mode. (As of v2.7)
    
    Parameters:
    enable - - When true, auto generalize is enabled. Default value for non-editable on-demand feature layers is true
    
    Returns:
    FeatureLayer
  - setDefinitionExpression
```
public final FeatureLayer setDefinitionExpression(java.lang.String expression)
```
    Set's 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.
    
    Parameters:
    expression - - example: "STATE_NAME = 'South Carolina'"
    
    Returns:
    String
  - setEditable
```
public final FeatureLayer setEditable(boolean editable)
```
    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. (As of v2.6)
    
    Parameters:
    editable - - When true, the layer will be set as editable.
    
    Returns:
    FeatureLayer
  - setGDBVersion
```
public final FeatureLayer setGDBVersion(java.lang.String versionName)
```
    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. (As of v2.7)
    
    Parameters:
    versionName - - The name of the geodatabase version to use as the layer's data source.
    
    Returns:
    FeatureLayer
  - setMaxAllowableOffset
```
public final void setMaxAllowableOffset(double offset)
```
    Sets the maximum allowable offset used when generalizing geometries.
  - setScaleRange
```
public final void setScaleRange(double minScale,
                 double maxScale)
```
    Set the scale range for the layer. If minScale and maxScale are set to 0 then the layer will be visible at all scales. (As of v2.5)
    
    Parameters:
    minScale - - The minimum scale for the layer. If the map is zoomed out beyond the specified scale the layer will not be visible. A value of 0 means the layer does not have a minimum scale.
    maxScale - - The maximum scale for the layer. If the map is zoomed out beyond the specified scale the layer will not be visible. A value of 0 means the layer does not have a maximum scale.
  - setSelectionSymbol
```
public final FeatureLayer setSelectionSymbol(Symbol symbol)
```
    Set's the selection symbol for the feature layer. If no symbol is specified, features are drawn using the layer's renderer.
    
    Parameters:
    symbol - - Symbol for the current selection. Make sure the symbol type is appropriate for the geometry type of the layer.
    
    Returns:
    FeatureLayer
  - setTimeDefinition
```
public final FeatureLayer setTimeDefinition(TimeExtent definition)
```
    Set's 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 defintion 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
    
    Parameters:
    definition - - The new time extent used to filter the layer.
    
    Returns:
    FeatureLayer
  - setTimeOffset
```
public final FeatureLayer setTimeOffset(int offsetValue,
                         TimeInfo.TimeUnits offsetUnits)
```
    Time offset allows you to display the features at a different time so they can be overlayed 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).
    
    Parameters:
    offsetValue - - The length of time to offset from "this" time. Specify a positive or negative whole number.
    offsetUnits - - Units in wich the offset is specified.
    
    Returns:
    FeatureLayer
  - setUseMapTime
```
public final void setUseMapTime(boolean update)
```
    Determine if the layer will update its content based on the map's current time extent. Default value is true.
    
    Parameters:
    update - - When false the layer will not update its content based on the map's time extent. Default value is true.
  - toJson
```
public final com.google.gwt.core.client.JavaScriptObject toJson()
```
    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.
    
    Returns:
    JavaScriptObject
  - addAddAttachmentHandler
```
public final void addAddAttachmentHandler(AddAttachmentHandler handler)
```
    Add event handler for onAddAttachmentComplete.
    
    Parameters:
    handler - - Fires when addAttachments() is complete.
  - addBeforeApplyEditsHandler
```
public final void addBeforeApplyEditsHandler(BeforeApplyEditsHandler handler)
```
    Add event handler for onBeforeApplyEdits.
    
    Parameters:
    handler - - Fired before edits are applied to the feature layer.
  - addCapabilitiesChange
```
public final void addCapabilitiesChange(CapabilitiesChangeHandler handler)
```
    Set the capabilities change handler.
    
    Parameters:
    handler - - Fired when the capabilities of the layer are modified using the setEditable method. (As of v2.6)
  - addDeleteAttachmentsHandler
```
public final void addDeleteAttachmentsHandler(DeleteAttachmentsHandler handler)
```
    Add event handler for onDeleteAttachmentsComplete.
    
    Parameters:
    handler - - Fires when deleteAttachments is complete.
  - addEditsCompleteHandler
```
public final void addEditsCompleteHandler(ApplyEditsHandler handler)
```
    Add event handler for onEditsComplete.
    
    Parameters:
    handler - - Fires after applyEdits() has been called.
  - addQueryAttachmentInfosHandler
```
public final void addQueryAttachmentInfosHandler(QueryAttachmentInfosHandler handler)
```
    Add event handler for onQueryAttachmentInfosComplete
    
    Parameters:
    handler - - Fires when queryAttachmentInfos() is complete.
  - addQueryCountHandler
```
public final void addQueryCountHandler(QueryCountHandler handler)
```
    Add event handler for onQueryCountComplete. This event is only available for layers published using ArcGIS Server 10 SP1 or later.
    
    Parameters:
    handler - - Fires when the query for the count is complete.
  - addQueryFeaturesHandler
```
public final void addQueryFeaturesHandler(QueryFeaturesHandler handler)
```
    Add event handler for onQueryFeaturesComplete.
    
    Parameters:
    handler - - Fires when queryFeatures() is complete.
  - addQueryIdsHandler
```
public final void addQueryIdsHandler(QueryIdsHandler handler)
```
    Add event handler for onQueryIdsComplete.
    
    Parameters:
    handler - - Fires when queryIds() is complete.
  - addQueryRelatedFeaturesHandler
```
public final void addQueryRelatedFeaturesHandler(QueryRelatedFeaturesHandler handler)
```
    Add event handler for onQueryRelatedFeaturesComplete.
    
    Parameters:
    handler - - Fires when queryRelatedFeatures() is complete.
  - addClearSelectionHandler
```
public final void addClearSelectionHandler(ClearSelectionHandler handler)
```
    Add event handler for onSelectionClear. OnSelectionComplete always fires unless there is an error returned by the server.
    
    Parameters:
    handler - - Fires when selectFeatures() has completed.
  - addSelectFeaturesHandler
```
public final void addSelectFeaturesHandler(SelectFeaturesHandler handler)
```
    Add event handler for onSelectionComplete. OnSelectionComplete always fires unless there is an error returned by the server.
    
    Parameters:
    handler - - Fires when selectFeatures() has completed.

Class FeatureLayer

Nested Class Summary

Method Summary

Methods inherited from class edu.ucdavis.cstars.client.layers.GraphicsLayer

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

Methods inherited from class java.lang.Object

Method Detail

create

create

create

create

assertLoaded

getCapabilities

getCopyright

getDefaultDefinitionExpression

getDescription

getDisplayField

getEditFieldsInfo

getFields

getFullExtent

getGeometryType

getGlobalIdField

hasAttachments

htmlPopupType

getLayerId

getMaxRecordCount

getMaxScale

getMinScale

getName

getObjectIdField

getOwnershipBasedAccessControlForFeatures

getRelationships

getSourceAsLayerMapSource

getSourceAsLayerDataSource

supportsAdvancedQueries

supportsStatistics

getTemplates

getTimeInfo

getType

getTypeIdField

getTypes

getVersion

addAttachment

addAttachment

applyEdits

applyEdits

clearSelection

deleteAttachments

deleteAttachments

getDefinitionExpression

getEditCapabilities

getEditCapabilities

getMaxAllowableOffset

getSelectedFeatures

getSelectionSymbol

getTimeDefinition

isEditable

queryAttachmentInfos

queryAttachmentInfos

queryCount

queryCount

queryFeatures

queryFeatures

queryIds

queryIds

queryRelatedFeatures

queryRelatedFeatures

refresh

selectFeatures

selectFeatures

selectFeatures

selectFeatures

setAutoGeneralize

setDefinitionExpression

setEditable

setGDBVersion

setMaxAllowableOffset

setScaleRange

setSelectionSymbol