Serveur d'impression

FeatureLayer | Référence API | API ArcGIS pour JavaScript 3.28 – Serveur d’impression

Le 4 mai 2019 - 83 minutes de lecture

exiger(["esri/layers/FeatureLayer"], function (FeatureLayer) / * code va ici * /);

La description

(Ajouté à la v2.0)

La couche d'entités hérite de la couche graphique et peut être utilisée pour afficher les entités d'une seule couche dans un service de carte ou un service d'entités. La couche peut être une couche (spatiale) ou une table (non spatiale). Les entités d’une couche d’entités peuvent être modifiées si le est éditable méthode est vraie.

FeatureLayer utilisera par défaut les informations de dessin du serveur (requiert ArcGIS Server 10 ou une version ultérieure). Pour un exemple, voir le moteur de rendu simple dans le Informations de dessin à http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Earthquakes/EarthquakesFromLastSevenDays/MapServer/0

Rendu WebGL

À partir de la version 3.24, vous pouvez choisir de rendre FeatureLayer avec WebGL. Cela vous permet d'afficher plus de données sur la carte et de mettre à jour plus rapidement la visualisation des entités. Pour activer le rendu WebGL de FeatureLayer, collez le script suivant dans votre application avant de charger l'API ArcGIS pour JavaScript:


Une fois activé globalement pour l'application, WebGL peut être activé / désactivé à l'aide de l'API ci-dessous:

Limites connues

Les limitations suivantes des FeatureLayers rendues par WebGL peuvent être modifiées dans les versions futures. Si l'une de ces conditions n'est pas remplie, la couche bascule automatiquement de WebGL à SVG pendant la session.

  • La prise en charge est limitée aux couches créées à partir de services d'entités hébergés sur ArcGIS Online et de services d'entités d'entreprise non hébergés versions 10.6.1 ou ultérieure. Les FeatureLayers créés à partir de FeatureCollections ne sont pas pris en charge.
  • Les couches de polygones doivent prendre en charge le retour des centroïdes.
  • Le calque ne doit pas être éditable.
  • La couche ne doit pas être groupée.
  • La couche doit utiliser le mode de récupération à la demande.
  • La couche ne doit pas utiliser d'étiquettes.
  • La couche ne doit pas utiliser d'expressions Arcade contenant des opérations de géométrie.
  • Le rendu de la couche doit être de type SimpleRenderer, ClassBreaksRenderer ou UniqueValueRenderer.
  • Les variables visuelles de couleur et d'opacité doivent avoir 8 arrêts ou moins.
  • Les variables visuelles de taille gérées par les attributs doivent comporter 6 arrêts ou moins. Cela n'affecte pas les variables générées par l'échelle de la carte.
  • Les symboles de ligne ne doivent pas avoir de flèches.
  • Le symbole de sélection n'est pas pris en charge.

Notez que seul l'événement click se déclenche lorsque WebGL est activé. Tous les autres événements ne sont pas pris en charge. Les sous-classes FeatureLayer ne prennent pas en charge le rendu WebGL. Notez également que la modification des attributs, des symboles, de la géométrie et de la visibilité des entités individuelles dans un calque rendu WebGL n'aura aucun effet.

Des échantillons

Rechercher des échantillons qui utilisent cette classe.

Hiérarchie de classe

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

Sous-classes

Constructeurs

Constantes

MODE_AUTO

Déléguez en mode à la demande ou en mode instantané en fonction des caractéristiques du service. Cela ne s'applique qu'aux services d'entités hébergés.

Si le nombre total d'entités dans une couche est inférieur à maxRecordCount et si le nombre total de sommets est inférieur à 250 000, le mode Instantané est utilisé. Sinon, le mode à la demande est utilisé. Ce mode a pour but de réduire la charge côté serveur. Au lieu d'obtenir un petit nombre de fonctionnalités avec plusieurs requêtes (mode à la demande), obtenez toutes les fonctionnalités avec une seule requête. Ce mode nécessite une demande supplémentaire avant de récupérer des fonctionnalités.

MODE_ONDEMAND

En mode à la demande, la couche d'entités récupère les entités du serveur en cas de besoin. Ceci est basé sur les exigences définies dans les propriétés suivantes:

  • Propriétés de la carte telles que l'étendue spatiale actuelle et l'heure.
  • Propriétés de la couche telles que le décalage temporel et l'expression de définition.
SÉLECTION DE MODE

En mode de sélection, les fonctionnalités sont extraites du serveur uniquement lorsqu'elles sont sélectionnées. Les fonctionnalités sont disponibles sur le client uniquement lorsqu'elles sont sélectionnées. Pour utiliser les fonctionnalités sélectionnées:

  1. Appelez la méthode selectFeatures.
  2. Écoutez l'événement onSelectionComplete.
  3. Une fois que onSelectionComplete est activé, récupérez les entités sélectionnées à l'aide de la méthode getSelectedFeatures.

Lors de l'édition de couches d'entités en mode sélection, vous devez ajouter le service de carte associé au service d'entités à la carte en tant que service de carte dynamique. Si le service de carte n'est pas ajouté en tant que service de carte dynamique, les modifications ne seront pas visibles, car une fois les modifications terminées, la fonctionnalité n'est plus sélectionnée.

MODE_SNAPSHOT En mode Instantané, la couche d'entités récupère toutes les entités de la ressource de couche associée et les affiche sous forme de graphiques sur le client. Les expressions de définition et les définitions de temps sont honorées. Les entités sont récupérées une fois la couche d’entités ajoutée à la carte. Une fois que l'événement onUpdateEnd a été déclenché, vous pouvez accéder aux fonctionnalités à l'aide de la propriété graphics de la couche ou par le biais d'opérations de sélection et de requête.
POPUP_HTML_TEXT La popup affiche le contenu en HTML / TEXT.
POPUP_NONE Aucun type de popup défini.
POPUP_URL La popup affiche le contenu d'une URL.
SELECTION_ADD Ajoute des fonctionnalités au jeu de sélection actuel.
SELECTION_NEW Crée une nouvelle sélection.
SELECTION_SUBTRACT Supprime les fonctionnalités de la sélection actuelle.

Propriétés

advancedQueryCapabilities Objet Un objet contenant des métadonnées de niveau de service indiquant si la couche prend en charge ou non les requêtes utilisant des statistiques, ordre par champs, DISTINCT, pagination, requête avec distance et renvoi de requêtes avec étendue.
allowGeometryUpdates Booléen Renvoie true si la géométrie des entités de la couche peut être modifiée, false sinon.
allowUpdateWithoutValues Booléen Indique si les entités attributaires contenant des valeurs m peuvent être modifiées.
attributionDataUrl Chaîne L'URL, le cas échéant, où sont stockées les données d'attribution de la couche.
capacités Chaîne Informations sur les fonctionnalités activées pour cette couche.
nom du cours Chaîne attribut de classe du nœud de la couche.
droits d'auteur Chaîne Informations de copyright pour la couche.
titre de compétence Credential Fournit des informations d'identification pour la couche, telles que l'ID utilisateur et le jeton, si cette couche représente une ressource sécurisée avec une authentification par jeton.
dataAttributes Chaîne | Chaîne[] Liste des champs d'attribut ajoutés en tant qu'attributs de données personnalisés au nœud graphique.
defaultDefinitionExpression Chaîne Métadonnées décrivant l'expression de définition par défaut de la couche telle que définie par le service.
defaultVisibility Booléen Indique la visibilité par défaut de la couche.
la description Chaîne La description de la couche telle que définie dans le service de carte.
displayField Chaîne Nom du champ d'affichage principal de la couche.
editFieldsInfo Objet Indique les noms de champs pour les champs de l'éditeur.
éditionInfo Objet Applicable aux services de fonctionnalités hébergés sur ArcGIS Online.
des champs Champ[] Le tableau de champs dans la couche.
fullExtent Ampleur L'étendue complète de la couche.
gdbVersion Chaîne La version de la géodatabase.
geometryType Chaîne Type de géométrie des entités de la couche.
globalIdField Chaîne Le globalIdField pour la couche.
graphique Graphique[] Tableau de fonctionnalités dans la couche.
hasAllFeatures Booléen Indique si le calque affiche toutes les entités intersectant la vue actuelle.
hasAttachments Booléen Vrai si les pièces jointes sont activées sur la couche d'entités.
hasAttributionData Booléen Lorsque la valeur est true, la couche contient des données d'attribution.
htmlPopupType Chaîne Le type de popup html défini pour la couche.
identifiant Chaîne ID attribué à la couche.
infoTemplate InfoTemplate Le modèle d'informations pour la couche.
étiquetageInfo LabelClass[] Définition de l'étiquette pour cette couche, spécifiée comme un tableau de classes d'étiquettes.
layerId Nombre ID unique de la couche sur laquelle FeatureLayer a été construit.
loadError Erreur Définir si le chargement de la couche a échoué.
chargé Booléen Lorsque la couche est chargée, la valeur devient "true" et les propriétés de la couche sont accessibles.
maxAllowableOffset Nombre Décalage maximum autorisé, applicable uniquement aux couches non modifiables.
maxRecordCount Nombre Nombre maximal de résultats renvoyés par une requête.
maxScale Nombre Échelle maximale visible pour le calque.
échelle min Nombre Échelle minimale visible pour le calque.
multipatchOption Chaîne Prend en charge les services d'entités dont la source de données est une classe multipatch.

  • La valeur par défaut est xyFootprint si geometryType est esriGeometryMultiPatch.
prénom Chaîne Nom de la couche tel que défini dans le service de carte.
objectIdField Chaîne Nom du champ contenant le champ ID d'objet pour la couche.
opacité Nombre Opacité ou transparence du calque.
propertyBasedAccessControlForFeatures Objet Indique la configuration du contrôle d'accès de propriété.
intervalle de rafraîchissement Nombre Intervalle de rafraîchissement de la couche en minutes.
des relations Objet[] Chaque élément du tableau est un objet décrivant la relation de la couche avec une autre couche ou un autre tableau.
moteur de rendu Renderer Le rendu du calque.
showAttribution Booléen Lorsque la valeur est true, l'attribution de la couche est affichée sur la carte.
showLabels Booléen Détermine si les étiquettes sont affichées.
la source LayerSource Le calque dynamique ou la source de la table.
coiffant Booléen Indique si le calque est responsable du style des graphiques.
prend en chargeQueries avancées Booléen Lorsque vrai, la couche prend en charge orderByFields dans une opération de requête.
prend en chargeAttachementsParUploadId Booléen Lorsque la valeur est true, la couche prend en charge le téléchargement de pièces jointes avec l'opération REST Uploads, qui peut ensuite être utilisée dans les opérations REST Ajouter une pièce jointe ou Mettre à jour la pièce jointe.
soutientCalculer Booléen Lorsque true, la couche prend en charge la Calculer Opération REST lors de la mise à jour des fonctionnalités.
prend en charge la description du champ Booléen Si la valeur est true, la couche prend en charge une description de champ définie par l'utilisateur.
supports statistiques Booléen Lorsque la valeur est true, la couche prend en charge les fonctions statistiques dans les opérations de requête.
surfaceType Chaîne Type de surface graphique vectorielle utilisée pour dessiner des graphiques.
suspendu Booléen Lorsque true, le calque est suspendu.
des modèles FeatureTemplate[] Tableau de modèles d'entités définis dans la couche Service d'entités.
timeInfo TimeInfo Informations de temps pour la couche, telles que le champ Heure de début, le champ Heure de fin, le champ ID de piste, l'étendue de temps des couches et l'intervalle de temps d'affichage.
type Chaîne Spécifie le type de couche.
typeIdField Chaîne Le champ qui représente le champ Type ID.
les types FeatureType[] Tableau de sous-types définis dans la couche de service d'entités.
url Chaîne URL de la ressource REST ArcGIS Server qui représente un service de carte.
version Nombre La version d'ArcGIS Server où la couche est publiée.
visible Booléen Visibilité du calque.
visibleAtMapScale Booléen Lorsque la valeur est true, le calque est visible à l'échelle de la carte actuelle.
webglEnabled Booléen Indique si WebGL est activé sur la couche.

Les méthodes

addAttachment (objectId, formNode, callback ?, errback?) Différé Ajoutez une pièce jointe à la fonctionnalité spécifiée par ObjectId.
applyEdits (ajoute ?, met à jour? supprime ?, rappel ?, errback?) Différé Appliquez des modifications à la couche d'entités.
attr (nom, valeur) Couche Ajoute un nouvel attribut ou modifie la valeur d'un attribut existant sur le nœud de la couche.
clair() Aucun Efface tous les graphiques.
clearSelection () FeatureLayer Efface la sélection en cours.
deleteAttachments (objectId, attachmentIds, callback ?, errback?) Différé Supprimez une ou plusieurs pièces jointes pour la fonctionnalité spécifiée par l'objet ObjectId en entrée.
disableFeatureReduction () Aucun Désactive la réduction des fonctionnalités (par exemple la mise en cluster) sur la couche.
disableMouseEvents () Aucun Désactive tous les événements de la souris sur la couche graphique.
enableFeatureReduction () Aucun Active la réduction des fonctionnalités (par exemple la mise en cluster) sur le calque en utilisant les options définies dans setFeatureReduction ().
enableMouseEvents () Aucun Active tous les événements de souris sur la couche graphique.
getAggregateGraphics () Graphique[] Renvoie des graphiques représentant l'agrégation de plusieurs entités ponctuelles regroupées.
getAttributionData () Différé Renvoie de manière asynchrone des données personnalisées pour la couche lorsqu'elles sont disponibles.
getDefinitionExpression () Chaîne Retourne l'expression de définition actuelle.
getDomain (fieldName, options?) Domaine Retourne le domaine associé au nom de champ donné.
getEditCapabilities (options?) Objet Retourne un objet qui décrit les capacités d'édition du calque.
getEditInfo (fonctionnalité, options?) Objet Retourne un objet décrivant l'opération d'édition la plus récente effectuée sur la fonction donnée, si disponible.
getEditSummary (fonctionnalité, options?) Chaîne Retourne un résumé localisé de la dernière opération d'édition effectuée sur la fonction donnée, si disponible.
getFeatureReduction () Objet Renvoie les options utilisées pour réduire le nombre d'entités visualisées par la couche (par exemple, la mise en cluster).
getField (fieldName) Champ Renvoie le Champ étant donné le nom de champ spécifié.
getMap () Carte Renvoie la référence au contrôle de la carte auquel la couche est ajoutée.
getMaxAllowableOffset () Nombre Renvoie la valeur actuelle du maxAllowableOffset utilisé par la couche.
getNode () HTMLElement Renvoie le nœud DOM de la couche.
getOrderByFields () Chaîne[] Renvoie la liste des champs utilisés pour commander les entités par.
getSelectedFeatures () Graphique[] Obtient les fonctionnalités actuellement sélectionnées.
getSelectionSymbol () symbole Obtient le symbole de sélection actuel.
getSingleGraphics () Graphique[] Renvoie les graphiques de la couche qui ne sont pas représentés par des graphiques agrégés lorsque la réduction des fonctionnalités (telle que la mise en cluster) est activée.
getTimeDefinition () TimeExtent Obtenir la définition de l'heure actuelle appliquée à la couche d'entités.
getType (fonctionnalité) FeatureType Retourne un FeatureType décrivant le type de l'entité.
hasUpdateError () Aucun Indique si une erreur est générée après la mise à jour de la couche.
hasWebGLSurface () Booléen Indique si le calque est rendu dans WebGL.
hasXYFootprint () Booléen Résultats vrai si geometryType est esriGeometryMultipatch et multipatchOption est xyFootprint.
cacher() Aucun Définit la visibilité du calque sur "false".
isEditable () Booléen Renvoie true si FeatureLayer est modifiable.
isFeatureReductionActive () Booléen Indique si la réduction des fonctionnalités (par exemple, la mise en cluster) est active dans la vue.
isFeatureReductionEnabled () Booléen Indique si la réduction de fonctionnalité (par exemple la mise en cluster) est activée.
isVisibleAtScale (scale) Booléen Renvoie true si le calque est visible à l'échelle donnée.
queryAttachmentInfos (objectId, callback ?, errback?) Différé Demander des informations sur les pièces jointes associées aux ObjectIds spécifiés.
queryCount (requête, rappel ?, errback?) Différé Obtenez un nombre du nombre d'entités qui satisfont la requête d'entrée.
queryExtent (requête, rappel ?, errback?) Différé Obtenez l'étendue des fonctionnalités qui répondent à la requête d'entrée.
queryFeatures (requête, rappel ?, errback?) Différé Interrogez les entités de la couche d'entités.
queryIds (requête, rappel ?, errback?) Différé Requête pour ObjectIds.
queryRelatedFeatures (relQuery, callback?, errback?) Différé Interrogez des entités ou des enregistrements, provenant d'une autre couche ou d'une autre table, liés aux entités de cette couche.
redessiner () Aucun Redessine tous les graphiques de la couche graphique.
rafraîchir() Aucun Actualise les entités de la couche d’entités.
enlever (graphique) Graphique Supprime un graphique.
CV() Aucun Reprend le calque.
selectFeatures (requête, selectionMethod?, callback?, errback?) Différé Sélectionne les fonctionnalités de FeatureLayer.
setAutoGeneralize (activer) FeatureLayer Activer ou désactiver la généralisation automatique pour la couche.
setDefinitionExpression (expression) FeatureLayer Définit l'expression de définition pour FeatureLayer.
setEditable (éditable) FeatureLayer Définissez les possibilités d'édition des couches d'entités créées à partir d'une collection d'entités.
setFeatureReduction (options) Aucun Définit les options de réduction des caractéristiques sur la couche (par exemple, les options de mise en cluster).
setGDBVersion (versionName) FeatureLayer Définissez la source de données de la couche sur la version de géodatabase spécifiée.
setInfoTemplate (infoTemplate) Aucun Spécifiez ou modifiez le modèle d'informations pour une couche.
setLabelingInfo (étiquetageInfo) Aucun Définit les informations d'étiquetage sur la couche.
setMaxAllowableOffset (offset) Aucun Définit le décalage maximum autorisé utilisé lors de la généralisation des géométries.
setMaxScale (scale) Aucun Définissez l'échelle maximale pour le calque.
setMinScale (scale) Aucun Définissez l'échelle minimale pour le calque.
setOpacity (opacité) Aucun Opacité initiale ou transparence du calque.
setRefreshInterval (intervalle) Couche Modifie l'intervalle d'actualisation de la couche sur la valeur donnée (en minutes).
setRenderer (rendu) Aucun Définissez le rendu pour la couche d'entités.
setScaleRange (minScale, maxScale) Aucun Définissez la plage d'échelle pour le calque.
setSelectionSymbol (symbole) FeatureLayer Définit le symbole de sélection pour la couche d'entités.
setShowLabels (showLabels) Aucun Définit si les étiquettes doivent être affichées ou non.
setTimeDefinition (définition) FeatureLayer Définit la définition de l'heure pour la couche d'entités.
setTimeOffset (offsetValue, offsetUnits) FeatureLayer Le décalage temporel vous permet d'afficher les entités à une heure différente afin qu'elles puissent être superposées au-dessus des périodes précédentes ou futures.
setUseMapTime (mise à jour) Aucun Déterminez si la couche mettra à jour son contenu en fonction de la durée actuelle de la carte.
setVisibility (isVisible) Aucun Définit la visibilité du calque.
setWebGLEnabled (activer) Aucun Active / désactive le rendu WebGL sur le calque.
spectacle() Aucun Définit la visibilité du calque sur "true".
suspendre() Aucun Suspend le dessin de calque.
toJson () Objet Retourne une représentation d'objet facilement sérialisable de la couche.

Événements

[[[[Evénements On Style | Événement de style de connexion ]

Tous les écouteurs d'événement On Style reçoivent un seul objet d'événement. De plus, l'objet événement contient également une propriété 'cible' dont la valeur est l'objet qui a déclenché l'événement.

Événements

add-attachment-complete
  résultat: <FeatureEditResult>
Se déclenche lorsque addAttachments () est terminé.
avant-application-modifications
  ajoute: <Graphique[]>
  supprime: <Graphique[]>
  mises à jour: <Graphique[]>
Déclenché avant que les modifications ne soient appliquées à la couche d'entités.
capacités-changement Déclenché lorsque les fonctionnalités de la couche sont modifiées à l'aide de la méthode setEditable.
Cliquez sur
  événement: <Objet>
Se déclenche quand un graphique a été cliqué.
clic-dbl
  événement: <Objet>
Se déclenche lorsqu'une fonctionnalité a été double-cliquée.
delete-attachments-complete
  résultats: <Objet[]>
Se déclenche lorsque deleteAttachments est terminé.
éditions complètes
  ajoute: <FeatureEditResult[]>
  supprime: <FeatureEditResult[]>
  mises à jour: <FeatureEditResult[]>
Se déclenche une fois que applyEdits () est terminé.
Erreur
  erreur: <Erreur>
Se déclenche lorsqu'il y a un problème de récupération d'une couche.
gdb-version-change Déclenché lorsque la version de la géodatabase est modifiée.
ajouter graphique
  graphique: <Graphique>
Se déclenche lorsqu'un graphique est ajouté à GraphicsLayer.
graphique dessiner
  graphique: <Graphique>
Se déclenche lorsqu'un graphique est dessiné.
graph-node-add
  graphique: <Graphique>
  noeud: <HTMLElement>
Se déclenche lorsque le nœud DOM d'un graphique est créé et ajouté à la couche.
noeud-graphique-supprimer
  graphique: <Graphique>
  noeud: <HTMLElement>
Cet événement est déclenché lorsque le nœud DOM d'un graphique est supprimé (considérez le nœud détruit).
supprimer graphique
  graphique: <Graphique>
Se déclenche lorsqu'un graphique est supprimé du GraphicsLayer.
graphisme clair Se déclenche lorsque tous les graphiques du GraphicsLayer sont effacés.
étiquetage-info-changement Déclenché lors du marquage des informations sur la couche.
charge
  couche: <Couche>
Les incendies après les propriétés de calque pour le calque ont été renseignés avec succès.
souris vers le bas <MouseEvent> mouseEvent Se déclenche quand un bouton de la souris est enfoncé et que le curseur de la souris est sur un graphique.
faites glisser la souris <MouseEvent> mouseEvent Se déclenche lorsque la souris est déplacée jusqu'à ce que le bouton de la souris soit relâché.
déplacer la souris <MouseEvent> mouseEvent Se déclenche lorsque la souris se déplace dans un graphique du GraphicsLayer.
sortie de souris <MouseEvent> mouseEvent Se déclenche lorsque la souris quitte un graphique du GraphicsLayer.
survoler <MouseEvent> mouseEvent Se déclenche lorsque la souris entre pour la première fois dans un graphique du GraphicsLayer.
la souris <MouseEvent> mouseEvent Se déclenche quand un bouton de la souris est relâché et que le curseur de la souris est sur un graphique.
changement d'opacité
  opacité: <Nombre>
Se déclenche lorsque l'opacité du calque a été modifiée et renvoie un objet avec la valeur d'opacité.
query-attachment-infos-complete
  info: <Objet[]>
Se déclenche lorsque la méthode queryAttachmentInfos est appelée.
requête-compte-complet
  compter: <Nombre>
Se déclenche lorsque la requête pour le compte est terminée.
requête-étendue-complète
  compter: <Nombre>
  mesure: <Ampleur>
Se déclenche lorsque la méthode queryExtent est terminée.
requête-fonctionnalités-complète
  featureSet: <Jeu de fonctionnalités>
Se déclenche lorsque queryFeatures () est terminée.
query-ids-complete
  objectIds: <Nombre[]>
Se déclenche lorsque queryIds () est terminée.
limite de requête dépassée Déclenché lorsque la couche d'entités n'a pas pu dessiner toutes les entités en raison d'une limitation de maxRecordCount sur une opération de requête.
requête-related-features-complete
  relatedFeatures: <Objet>
Se déclenche lorsque queryRelatedFeatures () est terminée.
rafraîchissement-intervalle-changement Cet événement est déclenché lorsque la couche est intervalle de rafraîchissement est modifié.
rafraichissement Se déclenche juste avant l'actualisation de la couche et ne se déclenche que lorsque l'actualisation est déclenchée par la commande refreshInterval.
CV Se déclenche lorsqu'un calque reprend son dessin.
changement de gamme d'échelle Se déclenche lorsque les propriétés minScale et / ou maxScale d'une couche sont modifiées.
échelle-visibilité-changement Se déclenche lorsque la visibilité d'échelle d'un calque change.
sélection-clear Se déclenche après l'appel de clearSelection.
sélection complète
  caractéristiques: <Graphique[]>
  méthode: <Nombre>
Se déclenche lorsque selectFeatures () est terminé.
show-labels-change Déclenché lorsque les étiquettes de la couche d'entités sont modifiées.
suspendre Se déclenche lorsqu'un calque suspend le dessin.
mettre à jour Se déclenche chaque fois qu'une couche a fini de se charger ou de se mettre à jour.
fin de mise à jour
  erreur: <Erreur>
  info: <Objet>
Déclenché lorsque la couche a fini de mettre à jour son contenu.
mise à jour-début Déclenché lorsque la couche commence à mettre à jour son contenu.
changement de visibilité
  visible: <Booléen>
Se déclenche lorsque la visibilité du calque a été modifiée et renvoie un objet avec une propriété booléenne visible contenant la nouvelle valeur de visibilité du calque.

Détails du constructeur

Crée une nouvelle instance d'un objet de couche d'entités à partir de la ressource REST ArcGIS Server identifiée par l'URL d'entrée. Une fois créé, vous pouvez éventuellement définir une expression de définition ou une définition de temps.

Paramètres:

<Chaîne> url Champs obligatoires URL de la ressource REST ArcGIS Server qui représente un service de fonctionnalité. Un exemple est http://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0. Pour plus d'informations sur la construction d'une URL, voir Le répertoire de services et l'API REST.
<Objet> options Optionnel Paramètres optionnels Voir la liste des options.
options Propriétés:

<Booléen> allowUpdateWithoutMValues Optionnel Indique si les entités attributaires contenant des valeurs m peuvent être modifiées. La valeur par défaut est faux.
<Booléen> autoGeneralize Optionnel Activer ou désactiver la généralisation automatique des fonctionnalités d'un calque non modifiable en mode à la demande. Lorsque la valeur est true, la couche utilise la résolution actuelle de la carte comme maxAllowableOffset pour toutes les requêtes envoyées au serveur. La valeur par défaut est true. À partir de v2.7
<Chaîne> className Optionnel Attribut de classe à définir pour le nœud de la couche.
<Chaîne> definitionExpression Optionnel Clause Where à utiliser comme expression de définition pour la couche. Ajouté à la v3.11
<Booléen> displayOnPan Optionnel Lorsque la valeur est true, les graphiques sont affichés pendant le panoramique. Lorsque la valeur est false, les graphiques sont désactivés pendant le déplacement du panoramique. La définition de false peut améliorer les performances dans Internet Explorer. Le défaut est vrai.
<Une fonction> editSummaryCallback Optionnel Définir une fonction de rappel qui sera appelée par FeatureLayer.getEditSummary. À partir de v2.8
<Objet> caractéristiqueRéduction Optionnel Active la réduction des fonctionnalités (par exemple la mise en cluster) sur les couches de points. Voir setFeatureReduction () pour plus de détails. Voir le fonctionRéduction tableau de spécification d'objet ci-dessous pour les options pouvant être définies dans cet objet.

La prise en charge de la réduction des fonctionnalités est limitée aux scénarios suivants:

  • Données de points (provenant du service ou de FeatureCollection).
  • La carte doit avoir une référence spatiale Web Mercator ou WGS84.
  • Si la couche contient plus de 50 000 entités, seules les 50 000 premières seront mises en cluster.
  • Une FeatureLayer créée à partir d'une URL de service doit pointer vers un service prenant en charge la pagination (ArcGIS Server version 10.3.1 ou ultérieure).
  • Lorsque la modification est lancée avec le widget Editeur, la réduction des fonctionnalités est désactivée jusqu'à ce que le widget Editeur soit détruit.
  • La réduction de fonctionnalité est désactivée lorsque la couche a l'un des moteurs de rendu suivants: HeatmapRenderer,
    BlendRenderer, Rendu temporel, ou
    ScaleDependentRenderer.
<Chaîne> gdbVersion Optionnel Spécifiez la version de la géodatabase à afficher. (À partir de v2.7). Requiert le service ArcGIS Server 10.1 ou supérieur
<Chaîne> id Optionnel ID unique à attribuer à la couche. Si non assigné, esri.Carte crée un identifiant unique.
<InfoTemplate> infoTemplate Optionnel Le modèle qui définit le contenu à afficher dans la fenêtre d'informations de la carte lorsque l'utilisateur clique sur une entité. Si non spécifié, la fenêtre d'information ne sera pas affichée.
<Nombre> maxAllowableOffset Optionnel Décalage maximum autorisé, applicable uniquement aux couches non modifiables.
<Nombre> mode Optionnel Le mode de requête pour la couche d'entités. Chaque mode détermine quand et combien de fonctionnalités sont envoyées au client. Le mode par défaut consiste à interroger à la demande lorsque l'étendue, l'heure et la définition de la couche changent. Vous pouvez spécifier les valeurs suivantes:

  • FeatureLayer.MODE_SNAPSHOT: les fonctionnalités sont extraites du serveur en fonction de DefinitionExpression et TimeDefinition. Si la définition change, la couche se met à jour en interrogeant les entités depuis le serveur. Une fois que les entités ont été récupérées sur le client, leur "visibilité" sur la carte est basée sur le temps et l'étendue spatiale de la carte. Par exemple, pour une animation temporelle, vous pouvez demander toutes les fonctionnalités au serveur, puis ajuster l'étendue temporelle sur la carte pour afficher uniquement un sous-ensemble.
  • FeatureLayer.MODE_ONDEMAND: les fonctionnalités sont extraites du serveur selon les besoins.
  • FeatureLayer.MODE_SELECTION: seules les fonctionnalités sélectionnées sont disponibles sur le client. Généralement utilisé en combinaison avec un service de carte dynamique affichant les entités pouvant être sélectionnées.
  • FeatureLayer.MODE_AUTO: Les fonctionnalités sont extraites en mode à la demande ou en mode instantané, en fonction des caractéristiques du service. Applicable uniquement aux services d'entités hébergés. Voir le tableau des constantes pour plus de détails.

La valeur par défaut est MODE_ONDEMAND.

Voir le tableau des constantes pour plus de détails sur chaque mode.

<Nombre> opacité Optionnel Opacité initiale ou transparence du calque. Les valeurs vont de 0,0 à 1,0, 0,0 étant transparent à 100% et 1,0 non transparent. La valeur par défaut est 1.0. Non pris en charge dans Internet Explorer.
<Chaîne[]> orderByFields Optionnel Un ou plusieurs champs utilisés pour classer les entités – pour les requêtes ainsi que pour le rendu.

  • Spécifiquement ASC (ascendant) ou DESC (décroissant) après le nom du champ pour contrôler l'ordre. Exemple: [ "POPULATION DESC" ].
  • Lors de la visualisation d'une couche d'entités à l'aide d'un moteur de rendu avec dimensionnement basé sur les données, cette option est utile pour garantir que les entités plus petites sont dessinées par-dessus les plus grandes et ne sont pas cachées dessous.
  • S'il n'est pas spécifié, la couche d'entités choisira l'ordre comme suit:
    • La couche a un rendu avec dimensionnement basé sur les données: ordre décroissant de Renderer.sizeInfo.field.
    • La couche a un ClassBreaksRenderer avec backgroundFillSymbol: ordre décroissant de Renderer.attributeField.
    • La couche a un ClassBreaksRenderer où chaque saut a différentes tailles de symbole: ordre décroissant de Renderer.attributeField.
<Chaîne[]> les champs Optionnel Un tableau de chaînes qui correspondent aux champs à inclure dans FeatureLayer. Si non spécifié, la couche d'entités renverra le champ OBJECTID et, le cas échéant, le champ d'heure de début, le champ d'heure de fin et le champ de type id. Vous pouvez spécifier ["*"] Pour récupérer les valeurs de tous les champs de la couche, cela est utile lors de la modification des entités.
<Nombre> refreshInterval Optionnel Intervalle de rafraîchissement de la couche en minutes. Une valeur autre que zéro définit l'actualisation automatique de la couche à l'intervalle spécifié.
<Objet> resourceInfo Optionnel Spécifiez les métadonnées de la couche.
<Booléen> showAttribution Optionnel Lorsque la valeur est true, l'attribution de la couche est affichée sur la carte. La valeur par défaut est true. Ajouté à la v3.1



exiger([
  "esri/layers/FeatureLayer", ... 
], function (FeatureLayer, ...) 
  var censusBlock = new FeatureLayer (layerUrl, 
    showAttribution: false
  );
  ...
);
<Booléen> showLabels Optionnel Indique si les étiquettes doivent être affichées sur la couche.

Si un libellé est défini pour le FeatureLayer, les libellés s’affichent automatiquement si la carte showLabels est vrai.

Si vous ne souhaitez pas que l’étiquette de la couche d’entité apparaisse, vous pouvez remplacer ce comportement en définissant son showLabels propriété à false.

Indique si les étiquettes doivent être affichées. Si la valeur est true, toute FeatureLayer ajoutée à la carte sera automatiquement étiquetée en fonction de labelInfo. La valeur par défaut est false. Ajouté à la v3.11

REMARQUE: pour que les étiquettes s'affichent, tous les champs utilisés par labelInfo doivent être définis dans les champs. De plus, seul un étiquetage simple est pris en charge, par exemple NOM DE VILLE. Par exemple, les mots-clés SQL tels que "CONCAT" ne sont pas pris en charge. Pensez à utiliser la classe LabelLayer où vous pouvez spécifier le textexpression si besoin de plus de fonctionnalités.

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

Ajouté à la v3.11

<LayerSource> source Optionnel Le calque dynamique ou la source de la table. L'URL devrait se terminer par / dynamicLayer.
<Nombre> carrelage Optionnel Spécifiez la taille des mosaïques virtuelles, utilisées en mode à la demande. Le schéma de mosaïque virtuel est utilisé en mode à la demande pour utiliser efficacement la mise en cache du navigateur. La valeur par défaut est 512. Cette option est valide uniquement en mode à la demande et doit être un carré. Par exemple, la spécification d'une valeur telle que 512×256 n'est pas prise en charge.
<Nombre> largeur du carreau Optionnel Spécifiez la taille des mosaïques virtuelles, utilisées en mode à la demande. Le schéma de mosaïque virtuel est utilisé en mode à la demande pour utiliser efficacement la mise en cache du navigateur. La valeur par défaut est 512. Cette option est valide uniquement en mode à la demande et doit être un carré. Par exemple, la spécification d'une valeur telle que 512×256 n'est pas prise en charge.

exiger([
  "esri/layers/FeatureLayer", ... 
], function (FeatureLayer, ...) 
  var featureLayer = new FeatureLayer ("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Hydrography/Watershed173811/FeatureServer/1", 
    mode: FeatureLayer.MODE_ONDEMAND,
    tileWidth: 200,
    mosaïqueHauteur: 200
  );
  ...
);
<Chaîne> trackIdField Optionnel Le nom de la pisteIdField.

exiger([
  "esri/layers/FeatureLayer", ... 
], function (FeatureLayer, ...) 
  var featureLayer = new FeatureLayer (featureLayerURL, 
    mode: FeatureLayer.MODE_SELECTION,
    trackIdField: "Animal_1"
  );
  ...
);
<Booléen> useMapTime Optionnel Lorsque la valeur est true, la couche mettra à jour son contenu en fonction de la durée de la carte. Les valeurs par défaut sont true.
<Booléen> visible Optionnel Visibilité initiale du calque. Le défaut est vrai.
<Booléen> webglEnabled Optionnel Indique si la couche activera le rendu de WebGL. La valeur par défaut est vrai.
Spécifications de l'objet:

<fonctionRéduction>

<Nombre> clusterRadius Optionnel Rayon en pixels de chaque zone dans laquelle plusieurs points seront résumés et visualisés sous la forme d'un cluster unique.
<InfoTemplate> infoTemplate Optionnel L'InfoTemplate utilisé pour afficher des informations récapitulatives sur les graphiques agrégés.
<Chaîne> type Champs obligatoires La méthode de réduction (ou agrégation) pour réduire les entités affichées sur la carte. La seule valeur valide est grappe.
Échantillon:



exiger([
  "esri/InfoTemplate", "esri/layers/FeatureLayer", ... 
], fonction (InfoTemplate, FeatureLayer, ...) 
  var infoTemplate = new InfoTemplate ("$ FIELD_NAME", contenu);
  var featureLayer = new FeatureLayer ("http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Petroleum/KGS_OilGasFields_Kansas/MapServer/0", 
    mode: FeatureLayer.MODE_ONDEMAND,
    infoTemplate: infoTemplate,
    outFields: ["*"]
  );
  ...
);
Crée une nouvelle instance d'une couche d'entités à l'aide d'un objet FeatureCollection. La couche d'entités, lorsqu'elle est initialisée avec un objet de collection d'entités, présente le comportement suivant:

  • Les modifications sont appliquées sur le client non publié sur le serveur.
  • La couche d'entités génère un identifiant d'objet unique pour les nouvelles entités.
  • Ne prend pas en charge les requêtes devant être effectuées sur le serveur, par exemple les requêtes avec une clause where ou des requêtes spatiales sans extension.
  • La méthode toJson de la couche d'entités renvoie un objet avec les mêmes propriétés que la collection d'objets. L'objet renvoyé inclut toutes les entités présentes dans la couche lorsque la méthode est appelée. Cette méthode peut être utilisée pour accéder à une représentation sérialisable des fonctionnalités pouvant être enregistrées sur le serveur.
Paramètres:

<Objet> featureCollectionObject Champs obligatoires Un objet de collection d'entités. Voir les tableaux de spécifications d'objets ci-dessous pour plus de détails.
<Objet> options Optionnel Paramètres optionnels Voir la liste des options.
Spécifications de l'objet:

<featureCollectionObject>

<Objet> featureSet Champs obligatoires Une collection de fonctionnalités.
<Objet> layerDefinition Champs obligatoires La structure est identique aux informations renvoyées par REST pour une couche dans un service de carte ou d'entité. La définition de couche minimale requise pour créer un objet de collection d’entités dépend de la fonctionnalité requise, à savoir le temps, le rendu, etc.
Échantillon:



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

Détails de la propriété

Un objet contenant des métadonnées de niveau de service indiquant si la couche prend en charge ou non les requêtes utilisant des statistiques, ordre par champs, DISTINCT, pagination, requête avec distance et renvoi de requêtes avec étendue. Cet objet contient les propriétés existantes supports statistiques et prend en chargeQueries avancées qui est retourné dans le nouveau soutientOrderBy propriété. Pour la compatibilité ascendante supports statistiques et prend en chargeQueries avancées restera les propriétés de FeatureLayer.

"advancedQueryCapabilities": 
  "supportsPagination": vrai,
  "supportsQueryWithDistance": true,
  "supportsReturningQueryExtent": true,
  "supportsStatistics": true,
  "supportsOrderBy": true,
  "supportsDistinct": vrai

(Ajouté à la v3.12)

Échantillon:



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 | faux

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

Valeur par défaut: faux

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

Information about the capabilities enabled for this layer.

class attribute of the layer's node. (Added at v3.7)

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 est vrai. (Added at v2.5)

List of attribute fields added as custom data attributes to graphics node. Applicable only when layer surfaceType est "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 | faux

Sample:







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:

  
     creatorField,
     creationDateField,
     editorField,
     editDateField
  

Requires ArcGIS Server feature service version 10.1 or greater. (Added at v2.6)

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)

Object Specifications:

<editingInfo>

<Nombre> lastEditDate Champs obligatoires A read-only value that indicates the last time a layer was edited. This value gets updated every time the layer data is edited or when any of the layer properties change. The value is depicted as a Unix timestamp, e.g.

"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 update-end un événement. (Added at v3.28)

Valeur par défaut: vrai

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 | faux

When true, the layer has attribution data. The default value is false. Use the getAttributionData method to retrieve this data as JSON. (Added at v3.1)

Known values: true | faux

Valeur par défaut: faux

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.

Sample:

  • 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)

Sample:



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 

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 onLoad event is also fired.

Known values: true | faux

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)

Valeur par défaut: 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)

Valeur par défaut: 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 est vrai.
  • Applies to snapshot, ondemand, selectFeatures, and queryFeatures

Remarque: Requires ArcGIS 10.3 and above. (Added at v3.12)

Valeur par défaut: xyFootprint

Sample:



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

Valeur par défaut: 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 allowDeleteToOthers et allowUpdateToOthers. When true features can be deleted or updated by users other than the creator.

   allowUpdateToOthers,
   allowDeleteToOthers

(Added at v2.6)

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:

identifiant

Unique ID for the relationship

prénom

Name of the relationship.

relatedTableId

Unique ID of the related table or layer

Sample:



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 | faux

Valeur par défaut: vrai

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 showLabels est vrai.

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.
Added at v3.11

Known values: true | faux

Valeur par défaut: vrai

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

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

Known values: true | faux

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 | faux

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 | faux

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

Known values: true | faux

If true, the layer supports a user-defined field description. Please see the ArcGIS Online help topic, Describe attribute fields for additional information. (Added at v3.28)

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 | faux

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

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

Valeur par défaut: "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 méthode.

(Added at v3.1)

Known values: true | faux

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

Sample:



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 | faux

Valeur par défaut: vrai

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

Known values: true | faux

Indicates if WebGL is enabled on the layer. Note that this doesn't indicate that WebGL is actually being used in the rendering. Use hasWebGLSurface() to check if the layer is drawn with WebGL. (Added at v3.24)

Valeur par défaut: vrai

Method Details

Parameters:

<Nombre> objectId Champs obligatoires The ObjectId of the feature to which the attachment is added.
<HTMLFormElement> formNode Champs obligatoires HTML form that contains a file upload field pointing to the file to be added as an attachment. If you are using HTML then your form should follow this basic pattern:

If you wish to create the form data in JavaScript, then you can create a form using the following pattern:

var formData = new FormData();
formData.append("attachment", file);
<Une fonction> callback Optionnel The function to call when the method has completed. The arguments in the function are the same as the addAttachmentComplete event.
<Une fonction> errback Optionnel An error object is returned if an error occurs during task execution.
Apply edits to the feature layer. Only applicable for layers in a feature service.

REMARQUE: Date field values are always represented as numérique valeurs. This means that when updating existing features, date fields must have numeric values and not date objects.
Parameters:

<Graphic[]> adds Optionnel Array of features to add to the layer in the feature service. New features are typically created using the Draw toolbar.
<Graphic[]> updates Optionnel

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.

<Graphic[]> deletes Optionnel Array of features to delete. Must have valid ObjectId
<Une fonction> callback Optionnel This function will be called when the operation is complete. The arguments passed to this function are the same as the onEditsComplete event.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



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 nul ou indéfini. (Added at v3.7)

Parameters:

<Chaîne> name Champs obligatoires The name of the attribute.
<Chaîne> value Champs obligatoires The value of the attribute. Set this value as nul to remove the attribute.

Clears all graphics.

Sample:







graphicsLayer.clear();

Clears the current selection.

Delete one or more attachments for the feature specified by the input ObjectId. Only applicable if isEditable and hasAttachments are true.
Parameters:

<Nombre> objectId Champs obligatoires The ObjectId of the feature from which the attachment is removed.
<Nombre[]> attachmentIds Champs obligatoires The array of attachment ids to delete.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.

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)

Sample:



featureLayer.disableFeatureReduction();

Disables all mouse events on the graphics layer.

Enables feature reduction (for example clustering) on the layer using the options set in setFeatureReduction(). Only applicable to point layers. (Added at v3.22)
Sample:

  
  
  
  featureLayer.enableFeatureReduction();

Enables all mouse events on the graphics layer.

Returns graphics representing the aggregation of several point features clustered together. Only applicable when feature reduction is enabled. (Added at v3.22)
Sample:



var aggregateGraphics = featureLayer.getAggregateGraphics();

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

Returns the current definition expression.

Parameters:

<Chaîne> fieldName Champs obligatoires Name of the attribute field.
<Objet> options Optionnel Please see the options object specification table below.
Object Specifications:

<options>

<Graphic> feature Champs obligatoires The feature in which the Domain is retrieved.
NOTE: If the layer has sub-types, the domain will be calculated based on the feature type and domain defined for that type.
Returns an object that describes the edit capabilities of the layer. The returned object has the following properties:

canCreate When true, new features can be created.
canUpdate When true, existing features can be updated.
canDelete When true, features can be deleted.

(Added at v2.6)

Parameters:

<Objet> options Optionnel 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. See the object specifications table below for the structure of the options objet.
Object Specifications:

<options>

<Graphic> feature Champs obligatoires Check to see if the specified feature can be edited by the specified user.
<graphique> feature Champs obligatoires Check to see if the specified feature can be edited by the specified user.
<Chaîne> userId Champs obligatoires 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.
Sample:







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)

Parameters:

<Graphic> feature Champs obligatoires The feature to get the edit info for.
<Objet> options Optionnel See the object specifications table below for the structure of the options objet.
Object Specifications:

<options>

<Chaîne> action Champs obligatoires By default, the method returns a summary of the most recent edit performed on the feature. Use this option to override this behavior.

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




  "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. Par exemple:

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 editFieldsInfo 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)

Parameters:

<Graphic> feature Champs obligatoires The feature to get the edit summary for.
<Objet> options Optionnel See the object specifications table below for the structure of the options objet.
Object Specifications:

<options>

<Chaîne> action Champs obligatoires By default, the method returns a summary of the most recent edit performed on the feature. Use this option to override this behavior.

  • 'creation' indicates creation summary is desired.
  • 'edit' indicates edit summary is desired.
<Une fonction> callback Champs obligatoires If you want to customize or override certain components of the summary, provide a callback function using this option. Par exemple:

featureLayer.getEditSummary(feature, 
  callback: function(feature, info) 
    if (info && info.userId) 
      info.userId = "" + info.userId + "";
    
    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 setFeatureReduction() for more details. (Added at v3.22)
Sample:



featureLayer.getFeatureReduction();
Returns the Champ given the specified field name. (Added at v3.12)
Parameters:

<Chaîne> fieldName Champs obligatoires Name of the attribute field.

Returns reference to the map control the layer is added to. Résultats nul ou indéfini 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)

Sample:

 

 

 

 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 enabled. (Added at v3.22)
Sample:



var singleGraphics = featureLayer.getSingleGraphics();

Get the current time definition applied to the feature layer.

Sample:



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 FeatureType describing the feature's type.
NOTE: This is applicable if the layer containing the feature has a TypeIdField. (Added at v3.12)
Parameters:

<Graphic> feature Champs obligatoires A feature from this layer.

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)

Résultats vrai si geometryType est esriGeometryMultipatch et multipatchOption est xyFootprint. Quand vrai, 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.

(Added at v3.12)

Sample:



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 feature reduction is enabled. (Added at v3.22)
Sample:



featureLayer.isFeatureReductionActive();
Indicates if feature reduction (for example clustering) is enabled. Only applicable to point layers. See also setFeatureReduction(). (Added at v3.22)
Sample:



featureLayer.isFeatureReductionEnabled();

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

Parameters:

<Nombre> scale Champs obligatoires The scale at which to check if the layer is visible.

Query for information about attachments associated with the specified ObjectIds.

Parameters:

<Nombre> objectId Champs obligatoires The ObjectId for the feature to query for attachment information.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.

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)

Parameters:

<Question> query Champs obligatoires

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.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



require([
  "esri/tasks/query", "FeatureLayer", ... 
], function(Query, FeatureLayer, ... ) {
  var query = new Query();
  var featureLayer = new FeatureLayer( ... );
  query.where = "POP90_SQMI 

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)

Parameters:

<Question> query Champs obligatoires The query definition.
<Une fonction> callback Optionnel The function called when the method has completed.
<Une fonction> errback Optionnel The function called when error occurred.

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:

<Question> query Champs obligatoires

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.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



require([
  "esri/layers/FeatureLayer", "esri/tasks/query", ... 
], function(FeatureLayer, Query, ... ) 
  featureLayer = new FeatureLayer( ... );
  var query = new Query();
  query.objectIds =[features[features[features[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.

Parameters:

<Question> query Champs obligatoires

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.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



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.

Parameters:

<RelationshipQuery> relQuery Champs obligatoires The input query.
<Une fonction> callback Optionnel The function to call when the method has completed.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



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.

Removes a graphic.

Parameters:

<Graphic> graphic Champs obligatoires The graphic to remove.

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).

Parameters:

<Question> query Champs obligatoires

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.
<Nombre> selectionMethod Optionnel The selection method defines how the rest of the selection is combined with the existing selection. See Constants table for valid values. The default option is to create a new selection.
<Une fonction> callback Optionnel The function to call when the method has completed. The arguments in the function are the same as the onSelectionComplete event.
<Une fonction> errback Optionnel An error object is returned if an error occurs.
Sample:



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)

Parameters:

<Booléen> enable Champs obligatoires When true, auto generalize is enabled. Default value for non-editable on-demand feature layers is true.
Sample:



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.

Parameters:

<Chaîne> expression Champs obligatoires The definition expression to apply. For example, "TYPE='Park'"
Sample:



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. Utilisez le isEditable method to determine if the layer is editable.

(Added at v2.6)

Parameters:

<Booléen> editable Champs obligatoires When true, the layer will be set as editable.
Sample:







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, ou
    ScaleDependentRenderer.

(Added at v3.22)

Parameters:

<Objet> options Champs obligatoires Options for reducing (or aggregating) the features in the map. See the table below for more details.
Object Specifications:

<options>

<Nombre> clusterRadius Optionnel The radius in pixels of each area in which multiple points will be summarized and visualized as a single cluster. The default value is 80.
<InfoTemplate> infoTemplate Optionnel The InfoTemplate used to display summary information about aggregate graphics.
<Chaîne> type Champs obligatoires The reduction (or aggregation) method for reducing the features displayed in the map. The only valid type is grappe.
Sample:

  
  
  
  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)

Parameters:

<Chaîne> versionName Champs obligatoires The name of the geodatabase version to use as the layer's data source.

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

Sample:



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)

Parameters:

<LabelClass[]> labelingInfo Champs obligatoires This is the 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.
Sample:



//make sure the Map's showLabels option is set to true
  var map = new Map("map", 
    basemap: "streets",
    center:[-80, 30],
    zoom: 5,
    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.

Parameters:

<Nombre> offset Champs obligatoires The maximum allowable offset.
Sample:



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

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

Parameters:

<Nombre> scale Champs obligatoires The maximum scale at which the layer is visible.

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

Parameters:

<Nombre> scale Champs obligatoires The minimum scale at which the layer is visible.

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

Parameters:

<Nombre> opacity Champs obligatoires Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency. The default value is 1.
Sample:



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)

Parameters:

<Nombre> interval Champs obligatoires 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.

Set the renderer for the feature layer.

Parameters:

<Renderer> renderer Champs obligatoires The renderer to apply to the feature layer
Sample:



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)

Parameters:

<Nombre> minScale Champs obligatoires 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.
<Nombre> maxScale Champs obligatoires 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.
Sample:







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.

Parameters:

<symbole> symbol Champs obligatoires Symbol for the current selection. Make sure the symbol type is appropriate for the geometry type of the layer.
Sample:



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)

Parameters:

<Booléen> showLabels Champs obligatoires Set to true to show labels.

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

Parameters:

<TimeExtent> definition Champs obligatoires The new time extent used to filter the layer.
Sample:



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).

Parameters:

<Nombre> offsetValue Champs obligatoires The length of time to offset from "this" time. Specify a positive or negative whole number.
<Chaîne> offsetUnits Champs obligatoires Units in which the offset is specified. See the TimeInfo constants for valid values.

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

Parameters:

<Booléen> update Champs obligatoires When false the layer will not update its content based on the map's time extent. Default value is true.

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

Parameters:

<Booléen> isVisible Champs obligatoires Set the visibility of the layer.

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

Parameters:

<Booléen> enable Champs obligatoires Indicates whether to enable WebGL on the layer.
Sample:

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: ,

    featureSet: 

    features:

  





Détails de l'évènement

[[[[On Style Events | Connect Style Event ]

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

Event Object Properties:

<FeatureEditResult> result The result of the addAttachment operation indicating if the attachment was successfully added.

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

Event Object Properties:

<Graphic[]> adds Array of features to add to the layer in the feature service.
<Graphic[]> deletes Array of features to delete.
<Graphic[]> updates Array of features whose geometry and/or attributes have changed.

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)

Event Object Properties:

<Objet> event The returned object contains screenPoint, mapPoint, and Graphic.

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

Event Object Properties:

<Objet> event The returned object contains screenPoint, mapPoint, and graphic.
Sample:



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)

Event Object Properties:

<Objet[]> results The result objects, one for each attachment indicating if it was successfully removed.

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

Event Object Properties:

<FeatureEditResult[]> adds An array of result objects, one for each feature, indicating if it was successfully added. If the feature was added the result object will contain the unique object ID assigned to the feature.
<FeatureEditResult[]> deletes An array of result objects, one for each feature, indicating if it was successfully deleted. If the feature was deleted the result object will contain the unique object ID previously assigned to the feature.
<FeatureEditResult[]> updates An array of result objects, one for each feature, indicating if it was successfully updated. If the feature was updated the result object will contain the unique object ID assigned to the feature.

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)

Event Object Properties:

<Graphic> graphic The added graphic.
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.

(Added at v3.7)

Event Object Properties:

<Graphic> graphic Graphic being drawn. When the layer surfaceType est "svg" ou "vml", the graphic's DOM node is accessible with graphic.getNode().

Fires when a graphic's DOM node is created and added to the layer. Fires only when the layer surfaceType is "svg" ou "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 "svg" ou "vml". (Added at v3.7)

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

Event Object Properties:

<Graphic> graphic The removed graphic.

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)

Event Object Properties:

<Couche> layer The loaded layer.

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)

Event Object Properties:

<Nombre> opacity Fires when the layer opacity (transparency) changes. A number property named opacity that indicates the new opacity. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.

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

Event Object Properties:

<Objet[]> info Information about the attachments associated with the feature. Each element in this array is an object with the following properties: objectId,url,id,name,contentType,size.

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)

Event Object Properties:

<Nombre> count The number of features that satisfy the input query.

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

Event Object Properties:

<Nombre> count The count of features.
<Extent> extent The extent of features.

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

Event Object Properties:

<FeatureSet> featureSet The FeatureSet returned from the query.

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

Event Object Properties:

<Nombre[]> objectIds Array of ObjectIds returned from the query.

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)

Event Object Properties:

<Objet> relatedFeatures An object that contains feature sets. Each feature set contains features, from the target layer/table, related to the source feature. In the example below 15 and 9 are the object IDs of the features in the source layer/table.

  "15": ,
  "9":  

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 refreshInterval. (Added at v3.27)

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)

Event Object Properties:

<Graphic[]> features Features returned from the query. This does not equal the current selection, call getSelectedFeatures() to retrieve the current selection set.
<Nombre> method Selection method used in the selectFeatures method.

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)

Event Object Properties:

<Erreur> error Optional argument available when an error occurs during the update.
<Objet> info Optional object that may have a boolean queryLimitExceeded propriété. queryLimitExceeded will be true if the feature layer could not draw all features due to a maxRecordCount limitation on the query operation. As of v2.8
Fired when the layer begins to update its content. The following table describes when the event is fired in various modes.

Instantané

  • 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.

OnDemand

  • 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.

Selection

The event is not fired in selection mode.

(Added at v3.6)

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)

Event Object Properties:

<Booléen> visible Fires when the layer visibility changes. A boolean property named visible indicates whether or not the layer is visible after visibility changed.

Commentaires

Laisser un commentaire

Votre commentaire sera révisé par les administrateurs si besoin.

Informations Tutos Gameserver