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

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

LabelLayer | API Reference | ArcGIS API for JavaScript 3.46

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

(Added at v3.7)

, read below for additional information on the suggested method of labeling.

The LabelLayer inherits from the graphics layer and can be used to display texts and symbols on map. It is a regular layer which can be added to the map in combination with any other feature layers.

Starting with version 3.14, labeling should be handled via the featureLayer.setLabelingInfo() method. Also, the Map's showLabel constructor option should always be set when labeling since most of the labeling parameters are taken directly from the feature layer. It is also possible to set the format parameters, symbols, date, etc. using the LabelClass() as seen in the sample snippet below.

Supported way to label as of version 3.14

//the snippet below shows how you should be labeling as of version 3.14

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


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

var json = {
  "labelExpressionInfo": {"value": "{LocalTime}"},
  "useCodedValues": false,
  "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 ]);

//the snippet below shows how labeling was handled prior to version 3.14

//create instance of map
var map = new Map("map", {
  basemap: "streets-vector",
  center:[-80, 30],
  zoom: 4
});

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 labels = new LabelLayer({ id: "labels" });
  
labels.addFeatureLayer(flayer, labelRenderer, "{" + labelField + "}");

//add the label layer to the map
map.addLayer(labels);

Search for

that use this class.

esri/layers/Layer
|_esri/layers/GraphicsLayer
  |_esri/layers/LabelLayer

[ On Style Events | Connect Style Event ]

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

{
  event: <Object>
}

{
  error: <Error>
}

{
  graphic: <Graphic>
}

{
  graphic: <Graphic>
}

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

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

{
  graphic: <Graphic>
}

{
  layer: <Layer>
}

{
  opacity: <Number>
}

{
  error: <Error>
}

{
  visible: <Boolean>
}

Constructor Details

Creates a new Label layer.

Property Details

attribute of the layer's node.

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

The array of graphics that make up the layer.

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

• Setting the layer ID in the layer constructor.

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

• Setting the layer ID after a layer is initialized.

  population.id = "population";
  

• Retrieving the layer ID.

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

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

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

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

event is also fired.

Known values: true | false

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

Default value: 0

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

Default value: 0

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

Known values: 0.0 - 1.0

Default value: 1.0

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)

Renderer assigned to the GraphicsLayer. (Added at v1.4)

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

Known values: true | false

Default value: true

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

Known values: true | false

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

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

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

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

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

Known values: true | false

Visibility of the layer.

Known values: true | false

Default value: true

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

Known values: true | false

Method Details

Adds reference to the feature layer which is labeled. You may add as many feature layers as you need.

var featureLayer = new FeatureLayer(
  "http://sampleserver6.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer/0",
  {
    mode: FeatureLayer.MODE_ONDEMAND,
    outFields: ["CITY_NAME"]
  }
);

var renderer = new SimpleRenderer(symbol);

"{CITY_NAME}"

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

Clears all graphics. It is not recommended to call

on a

as the layer automatically manages fetching (from the service) and clearing graphics based on its

. Explicitly calling

to clear the graphics will interfere with the integrity of this process. For feature layers, we recommend using

to add, delete, and update features.

graphicsLayer.clear();

Disables all mouse events on the graphics layer.

Enables all mouse events on the graphics layer.

Returns reference to the feature layer which features will be labeled.

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

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

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

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

Redraws all the graphics in the layer. This method is functionally equivalent to refresh. (Added at v3.3)

Removes a graphic. It is not recommended to call

on a

as the layer automatically manages fetching (from the service) and clearing graphics based on its

. Explicitly calling

to remove the graphics will interfere with the integrity of this process. For feature layers, we recommend using

to add, delete, and update features.

Resumes layer drawing. (Added at v3.1)

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

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

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

  cityLayer.setInfoTemplate(infoTemplate);
  ...
});

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

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

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

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)

Sets the renderer for the graphics layer.

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

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

Sets the visibility of the layer to "true".

Suspends layer drawing. (Added at v3.1)

Event Details

[ On Style Events | Connect Style Event ]

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

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

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

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

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

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

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

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

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

Fires only when the layer surfaceType is

or

.

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

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

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

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

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

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

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

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

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

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

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

Fires when a layer resumes drawing. Should be used in favor of onResume. (Added at v3.5)

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 when a layer suspends drawing. Should be used in favor of onSuspend. (Added at v3.5)

Fires when a layer has finished updating its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateEnd. (Added at v3.5)

Fires when a layer begins to update its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateStart. (Added at v3.5)

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

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

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

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