A RetroSearch Logo

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

Search Query:

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

Layer | API Reference | ArcGIS API for JavaScript 3.46

require(["esri/layers/layer"], function(Layer) { /* code goes here */ });
Description Samples

Search for

samples

that use this class.

Subclasses Constructors Data Attributes data-hidden "" (empty string) Added to the layer's node when it is hidden. data-suspended "" (empty string) Added to the layer's node when the layer is suspended. data-updating "" (empty string) Added to the layer's node when the layer is updating its content. Properties Methods Events

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

Events error
{
  error: <Error>
}
Fires when there is a problem retrieving a layer. load
{
  layer: <Layer>
}
Fires after layer properties for the layer are successfully populated. opacity-change
{
  opacity: <Number>
}
Fires when the layer opacity has been changed, and returns an object with the opacity value. refresh-interval-change This event is fired when the layer's refreshInterval is modified. resume Fires when a layer resumes drawing. scale-range-change Fires when a layer's minScale and/or maxScale is changed. scale-visibility-change Fires when a layer's scale visibility changes. suspend Fires when a layer suspends drawing. update Fires any time a layer has finished loading or updating itself. update-end
{
  error: <Error>
}
Fires when a layer has finished updating its content. update-start Fires when a layer begins to update its content. visibility-change
{
  visible: <Boolean>
}
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.

Constructor Details

Creates a new Layer object.

Parameters: <Object> options Optional Optional parameters. See options list. options properties: <String> className Optional Class attribute to set for the layer's node. <Number> refreshInterval Optional Refresh interval of the layer in minutes. Non-zero value sets up automatic layer refresh at the specified interval. <Boolean> showAttribution Optional When true, the layer's attribution is displayed on the map. The default value is true. Added at v3.1
require([
  "esri/layers/ArcGISDynamicMapServiceLayer", ... 
], function(ArcGISDynamicMapServiceLayer, ... ) {
  var census = new ArcGISDynamicMapServiceLayer(layerUrl, {
    "showAttribution": false,
    "opacity": 0.5
  });
  ...
});

Property Details

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

class

attribute of the layer's node.

(Added at v3.7)

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

When true, the layer has attribution data. Use the

getAttributionData

method to retrieve this data as JSON.

(Added at v3.1)

Known values: true | false

Default value: false

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:

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

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

Known values: true | false

Default value: true

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

(Added at v3.1)

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

Parameters: <String> name Required The name of the attribute. <String> value Required The value of the attribute. Set this value as null to remove the attribute.

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

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)

Parameters: <Number> scale Required The scale at which to check if the layer is visible.

Resumes layer drawing. (Added at v3.1)

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

Parameters: <Number> scale Required The maximum scale at which the layer is visible.

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

Parameters: <Number> scale Required The minimum scale at which the layer is visible.

Sets the opacity of the layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.

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

layer.setOpacity(0.5);

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: <Number> interval Required 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 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)

Parameters: <Number> minScale Required The minimum scale at which the layer is visible. <Number> maxScale Required The maximum scale at which the layer is visible.

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

Parameters: <Boolean> isVisible Required Set the visibility of the layer.

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 there is a problem retrieving a layer. Should be used in favor of onError. (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)

Event Object Properties: <Layer> layer The loaded layer.

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: <Number> 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.

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)

Event Object Properties: <Error> error Optional argument. The error object is available when an error occurs during the update.

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)

Event Object Properties: <Boolean> visible Fires when the layer visibility changes. A boolean property named visible indicates whether or not the layer is visible after visibility changed.

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