topic Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range in ArcGIS JavaScript Maps SDK Questions

IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AndrewBrown1 — Thu, 11 Oct 2012 13:54:58 GMT

Hello,

I'm working on my second web mapping application, and I am implementing an identifyTask on a couple point layers that are scale-dependent. At first, the layers are disabled until the user zooms closer to the points. Eventually, the points are re-enabled because the current scale meets the scale criteria. If I turn on one of the n layers and attempt to identify an area around the point, my identifyTask will identify the layer that's turned on and the layers that are turned off. I believe this is a bug of some sort. My code is below:

identifyParams = new esri.tasks.IdentifyParameters();
            identifyParams.tolerance = 3;
            identifyParams.returnGeometry = true;
            identifyParams.layerIds = [1,2,3,4,5,6,7,9];
            identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_VISIBLE;
            identifyParams.geometry = geometry;
            identifyParams.mapExtent = map.extent;
            identifyParams.width = map.width;
            identifyParams.height = map.height;
            identifyTask.execute(identifyParams, function (identifyResults) {

If I were to output identifyResults to the console, it would contain the visible and non-visible layers. As you can see, I specified LAYER_OPTION_VISIBLE, so it should only be identifying layers that are turned on, not the ones that are enabled due to scale dependency! I'm using 3.2compact as my API.

Thanks,
Andrew

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

JohnGravois — Thu, 11 Oct 2012 21:14:59 GMT

hi andrew,

LAYER_OPTION_VISIBLE means checked on in the map document used to create the map service, whether or not they show up at a particular scale.

if you take JavaScript out of the equation and attempt to identify a feature directly in REST, you will notice that you pass in geometry to help you search, but you don't pass in any information about a particular scale.

see the following thread for more information.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AndrewBrown1 — Fri, 12 Oct 2012 12:41:26 GMT

I guess I'll just nix the scale-dependent layers then... makes my life easier. Thanks!

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AndrewBrown1 — Fri, 12 Oct 2012 13:18:29 GMT

Actually, I just thought of something. My layers are scale-dependent, but they're also initially turned off in the MXD. I can still identify the points when they're enabled but turned off in the mapping application. It shouldn't do this. See my attached screenshot. The circles represent a "selected" point. The "other" layer is turned on and it's properly selected. The other layers are off yet they're "selected" as indicated by the circles.

If I open the MXD in ArcMap and zoom to meet the layer dependency, I cannot identify the points using "Visible Layers" under my Identify tool.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

JohnGravois — Fri, 12 Oct 2012 17:35:35 GMT

i did some more testing this morning and i made a mistake yesterday in stating that the identify operation doesn't take scale into account. while a scale value is not explicitly supplied, it is necessary to pass in a map extent when identifying. in my tests, rightfully, the values returned given a specific tolerance were different depending on the extent.

identifyParams.layerIds = [1,2,3,4,5,6,7,9];

i took a look at the REST documentation and it confirms your expectation that using visible in conjunction with explicitly declared layers should only return results if a returned item is included in one of layers requested AND and would be visible in the map service at the current extent.

http://resources.arcgis.com/en/help/rest/apiref/identify.html

i put together a sample application which seems to demonstrate that this is not the case, as a layer index will be returned (even if it has a default visibility of FALSE in the map service)

http://jsfiddle.net/jagravois/nPpp9/1/

all in all, it seems that you should be able to get the results you want by not asking for a specific layer if you don't want it to be included in the result, whether you are using VISIBLE or ALL as your layerOption parameter.

i hope this information helps.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AdrianMarsden — Fri, 12 Oct 2012 19:22:47 GMT

For info, the LAYER_OPTION_VISIBLE doesn't work, it is a know bug (see post in http://forums.arcgis.com/threads/68803-BUG-.visibleLayers-returns-group-layeys?p=239911#post239911)

I had the same issue as you did today - or rather the exact opposite, ID not working when I could see the features, and it was like John says, all tied up in the map extent, although I passed it the current extent I hadn't also passed the height and width. Doing this sorted my issue.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

DouglasHall — Sat, 11 Dec 2021 07:25:01 GMT

Been dealing with this myself -- and it's different between jsapi 2.x and 3.x. Only what's showing on map will be identified on. Note the checking of subLayerIds for null, scale checking, etc

Solution is for jaspi 3.x

var referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {
* * id: 'referenceLayer'
});

var layersInScale;
if (referenceLayer.visible === true && !(referenceLayer.visibleLayers.length === 0 || referenceLayer.visibleLayers[0] === -1)) {
            layersInScale = [];
            dojo.foreach(referenceLayer.createDynamicLayerInfosFromLayerInfos(), function (v) {
                if (v.subLayerIds === null &&
                        (v.minScale === undefined || v.minScale === 0 || currentScale <= v.minScale) &&
                        (v.maxScale === undefined || v.maxScale === 0 || currentScale >= v.maxScale)) {
                    layersInScale.push(v.id);
                }
});

var identifyParams = new esri.tasks.IdentifyParameters(),
    identifyTask = new esri.tasks.IdentifyTask(referenceLayer.url);
identifyParams.geometry = geom;
identifyParams.mapExtent = map.extent;
identifyParams.tolerance = 3;
identifyParams.returnGeometry = true;
identifyParams.layerIds = aLayerIds;
//only refers to default visible layers as defined on the server
identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
identifyParams.width = map.width;
identifyParams.height = map.height;
return identifyTask.execute(identifyParams);

Bonus: Identifies on multiple services at once and return as one array using dojo.DeferredList
(using some jQuery loops just change to for or dojo.foreach)

dojo.require("dojo.DeferredList");

referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {
    id: 'referenceLayer'
});

//Operational layers
operationalLayer = new esri.layers.ArcGISDynamicMapServiceLayer(operationalMapServiceName, {
    id: 'operationalLayer'
});

function executeIdentify(geom, serviceName, aLayerIds) {
    var identifyParams = new esri.tasks.IdentifyParameters(),
        identifyTask = new esri.tasks.IdentifyTask(serviceName);
    identifyParams.geometry = geom;
    identifyParams.mapExtent = map.extent;
    identifyParams.tolerance = 3;
    identifyParams.returnGeometry = true;
    identifyParams.layerIds = aLayerIds;
    //only refers to default visible layers as defined on the server
    identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
    identifyParams.width = map.width;
    identifyParams.height = map.height;
    return identifyTask.execute(identifyParams);
}

function doIdentify(evt) {
    var geom = evt.mapPoint,
        layersInScale,
        aDeferreds = [],
        defList,
        currentScale = map.getScale(),
        layersToIdentify = [referenceLayer, operationalLayer];

    map.graphics.clear();
    identifyLayerKeyPrevious = undefined;

    $.each(layersToIdentify, function (key, value) {
        if (value.visible === true && !(value.visibleLayers.length === 0 || value.visibleLayers[0] === -1)) {
            layersInScale = [];
            $.each(value.createDynamicLayerInfosFromLayerInfos(), function (k, v) {
                if (v.subLayerIds === null &&
                        (v.minScale === undefined || v.minScale === 0 || currentScale <= v.minScale) &&
                        (v.maxScale === undefined || v.maxScale === 0 || currentScale >= v.maxScale)) {
                    layersInScale.push(v.id);
                }
            });
            if (layersInScale.length > 0) {
                aDeferreds.push(executeIdentify(evt.mapPoint, value.url, layersInScale));
            }
        }
    });

    // create a deferred list to aggregate the state for all identify queries
    defList = new dojo.DeferredList(aDeferreds);
    defList.then(function (res) {
        // "res" is 2D array of results
        // array[0] indicates success or failure
        // array[1] is the array of identity results returned
        formatIdentifyResults(res);
    });
}

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AndrewBrown1 — Sat, 11 Dec 2021 07:25:03 GMT

Thank you for your help! I'll definitely implement this into my application.

var referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {
* * id: 'referenceLayer'
});

var layersInScale;
if (referenceLayer.visible === true && !(referenceLayer.visibleLayers.length === 0 || referenceLayer.visibleLayers[0] === -1)) {
            layersInScale = [];
            dojo.foreach(referenceLayer.createDynamicLayerInfosFromLayerInfos(), function (v) {
                if (v.subLayerIds === null &&
                        (v.minScale === undefined || v.minScale === 0 || currentScale <= v.minScale) &&
                        (v.maxScale === undefined || v.maxScale === 0 || currentScale >= v.maxScale)) {
                    layersInScale.push(v.id);
                }
});

var identifyParams = new esri.tasks.IdentifyParameters(),
    identifyTask = new esri.tasks.IdentifyTask(referenceLayer.url);
identifyParams.geometry = geom;
identifyParams.mapExtent = map.extent;
identifyParams.tolerance = 3;
identifyParams.returnGeometry = true;
identifyParams.layerIds = aLayerIds;
//only refers to default visible layers as defined on the server
identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
identifyParams.width = map.width;
identifyParams.height = map.height;
return identifyTask.execute(identifyParams);

Bonus: Identifies on multiple services at once and return as one array using dojo.DeferredList
(using some jQuery loops just change to for or dojo.foreach)

dojo.require("dojo.DeferredList");

referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {
    id: 'referenceLayer'
});

//Operational layers
operationalLayer = new esri.layers.ArcGISDynamicMapServiceLayer(operationalMapServiceName, {
    id: 'operationalLayer'
});

function executeIdentify(geom, serviceName, aLayerIds) {
    var identifyParams = new esri.tasks.IdentifyParameters(),
        identifyTask = new esri.tasks.IdentifyTask(serviceName);
    identifyParams.geometry = geom;
    identifyParams.mapExtent = map.extent;
    identifyParams.tolerance = 3;
    identifyParams.returnGeometry = true;
    identifyParams.layerIds = aLayerIds;
    //only refers to default visible layers as defined on the server
    identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
    identifyParams.width = map.width;
    identifyParams.height = map.height;
    return identifyTask.execute(identifyParams);
}

function doIdentify(evt) {
    var geom = evt.mapPoint,
        layersInScale,
        aDeferreds = [],
        defList,
        currentScale = map.getScale(),
        layersToIdentify = [referenceLayer, operationalLayer];

    map.graphics.clear();
    identifyLayerKeyPrevious = undefined;

    $.each(layersToIdentify, function (key, value) {
        if (value.visible === true && !(value.visibleLayers.length === 0 || value.visibleLayers[0] === -1)) {
            layersInScale = [];
            $.each(value.createDynamicLayerInfosFromLayerInfos(), function (k, v) {
                if (v.subLayerIds === null &&
                        (v.minScale === undefined || v.minScale === 0 || currentScale <= v.minScale) &&
                        (v.maxScale === undefined || v.maxScale === 0 || currentScale >= v.maxScale)) {
                    layersInScale.push(v.id);
                }
            });
            if (layersInScale.length > 0) {
                aDeferreds.push(executeIdentify(evt.mapPoint, value.url, layersInScale));
            }
        }
    });

    // create a deferred list to aggregate the state for all identify queries
    defList = new dojo.DeferredList(aDeferreds);
    defList.then(function (res) {
        // "res" is 2D array of results
        // array[0] indicates success or failure
        // array[1] is the array of identity results returned
        formatIdentifyResults(res);
    });
}

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AndrewBrown1 — Mon, 15 Oct 2012 13:05:37 GMT

Will the LAYER_OPTION_VISIBLE bug be fixed in the next version of the API?

i did some more testing this morning and i made a mistake yesterday in stating that the identify operation doesn't take scale into account. while a scale value is not explicitly supplied, it is necessary to pass in a map extent when identifying. in my tests, rightfully, the values returned given a specific tolerance were different depending on the extent.
identifyParams.layerIds = [1,2,3,4,5,6,7,9];
i took a look at the REST documentation and it confirms your expectation that using visible in conjunction with explicitly declared layers should only return results if a returned item is included in one of layers requested AND and would be visible in the map service at the current extent.

http://resources.arcgis.com/en/help/rest/apiref/identify.html

i put together a sample application which seems to demonstrate that this is not the case, as a layer index will be returned (even if it has a default visibility of FALSE in the map service)

http://jsfiddle.net/jagravois/nPpp9/1/

all in all, it seems that you should be able to get the results you want by not asking for a specific layer if you don't want it to be included in the result, whether you are using VISIBLE or ALL as your layerOption parameter.

i hope this information helps.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

AdrianMarsden — Mon, 15 Oct 2012 13:06:48 GMT

It's been open for three years, so I wouldn't hold your breath.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

JohnGravois — Tue, 16 Oct 2012 15:15:28 GMT

Andrew,

just to clarify, the issue i documented earlier in this thread is not the same issue that Adrian is referring to, and it is not a JS API bug, but rather a problem with the REST response itself. i'd be happy to log a new NIM for this issue, but i'm not quite sure i understand the use case for formatting a request to explicitly include a layer that you don't want to be returned.

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

DouglasHall — Sat, 11 Dec 2021 07:25:06 GMT

***Just updated to add one more check and better variable naming***

Been dealing with this myself -- and it's different between jsapi 2.x and 3.x. Only what's showing on map will be identified on. Note the checking of subLayerIds for null, scale checking, after getting the visibleLayers from service.

Solution is for jaspi 3.x

function doIdentify(evt) {
    var referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {id: 'referenceLayer'});
    var aVisibleSubLayers = referenceLayer.visibleLayers,
        aLayersInScale = [],
        identifyParams = new esri.tasks.IdentifyParameters(),
        identifyTask = new esri.tasks.IdentifyTask(referenceLayer.url);

    //loop thru visible sublayers that are not group layers, then check within scale
    if (referenceLayer.visible === true && aVisibleSubLayers.length !== 0 && aVisibleSubLayers[0] !== -1) {
        dojo.forEach(referenceLayer.createDynamicLayerInfosFromLayerInfos(), function (dLayInfo) {
            if (dLayInfo.subLayerIds === null && dojo.indexOf(aVisibleSubLayers, dLayInfo.id) !== -1 &&
                    (dLayInfo.minScale === undefined || dLayInfo.minScale === 0 || map.getScale() <= dLayInfo.minScale) &&
                    (dLayInfo.maxScale === undefined || dLayInfo.maxScale === 0 || map.getScale() >= dLayInfo.maxScale)) {
                aLayersInScale.push(dLayInfo.id);
            }
        });
    }

    if (aLayersInScale.length > 0) {
        identifyParams.geometry = evt.mapPoint;
        identifyParams.mapExtent = map.extent;
        identifyParams.tolerance = 3;
        identifyParams.returnGeometry = true;
        identifyParams.layerIds = aLayersInScale;
        identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
        identifyParams.width = map.width;
        identifyParams.height = map.height;
        identifyTask.execute(identifyParams, function(idResults) { 
            doSomethingWithIdentifyResults(idResults);
        });
    }
}

Bonus: Identifies on multiple services at once and return as one array using dojo.DeferredList

dojo.require("dojo.DeferredList");

referenceLayer = new esri.layers.ArcGISDynamicMapServiceLayer(referenceMapServiceName, {id: 'referenceLayer'});

//Operational layers
operationalLayer = new esri.layers.ArcGISDynamicMapServiceLayer(operationalMapServiceName, {id: 'operationalLayer'});

function executeIdentify(geom, serviceName, aLayerIds) {
    var identifyParams = new esri.tasks.IdentifyParameters(),
        identifyTask = new esri.tasks.IdentifyTask(serviceName);
    identifyParams.geometry = geom;
    identifyParams.mapExtent = map.extent;
    identifyParams.tolerance = 3;
    identifyParams.returnGeometry = true;
    identifyParams.layerIds = aLayerIds;
    identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
    identifyParams.width = map.width;
    identifyParams.height = map.height;
    return identifyTask.execute(identifyParams);
}

function doIdentify(evt) {
    var geom = evt.mapPoint,
        aLayersInScale,
        aDeferreds = [],
        deferredList,
        currentScale = map.getScale(),
        aVisibleSubLayers,
        aAGSDynMapServicesToIdentify = [referenceLayer, operationalLayer];

    map.graphics.clear();
    identifyLayerKeyPrevious = undefined;

    //loop thru dynamic services, then thru visible sublayers that are not group layers, then check within scale
    dojo.forEach(aAGSDynMapServicesToIdentify, function (agsDynMapService) {
        aVisibleSubLayers = agsDynMapService.visibleLayers;
        if (agsDynMapService.visible === true && aVisibleSubLayers.length !== 0 && aVisibleSubLayers[0] !== -1) {
            aLayersInScale = [];
            dojo.forEach(agsDynMapService.createDynamicLayerInfosFromLayerInfos(), function (dLayInfo) {
                if (dLayInfo.subLayerIds === null && dojo.indexOf(aVisibleSubLayers, dLayInfo.id) !== -1 &&
                        (dLayInfo.minScale === undefined || dLayInfo.minScale === 0 || currentScale <= dLayInfo.minScale) &&
                        (dLayInfo.maxScale === undefined || dLayInfo.maxScale === 0 || currentScale >= dLayInfo.maxScale)) {
                    aLayersInScale.push(dLayInfo.id);
                }
            });
            if (aLayersInScale.length > 0) {
                aDeferreds.push(executeIdentify(evt.mapPoint, agsDynMapService.url, aLayersInScale));
            }
        }
    });

    // create a deferred list to aggregate the state for multiple asynchronous identify queries
    deferredList = new dojo.DeferredList(aDeferreds);
    deferredList.then(function (aIdentifyResults) {
        // "aIdentifyResults" is 2D array of results
        // array[0] boolean true or false, success or failure of individual call
        // array[1] is the array of identity results returned
        doSomethingWithIdentifyResults(aIdentifyResults);
    });
}

Re: IdentifyTask Returning Scale-Dependent Layers When Outside of Scale Range

KevinMacLeod1 — Wed, 01 May 2013 18:38:53 GMT

Thank drhall001 and others. I will test your solution. However, is this still a workaround for an existing bug?

I don't understand why "LAYER_OPTION_VISIBLE " shouldn't work. Even with scale dependencies. However on my site it's not working, all layers show in popups. Here is the scenario: We have a simple site, and it calls one rest endpoint with around 100 layers in several groups and subgroups, bringing them in as one dynamic layer. I'm using the AGS JS TOC widget, to present it. (Love that thing! )

I'm using the Identify task for popups. There are several scale categories for scale dependency I set in the MXD so certain layers would appear at one scale, more at another, and finally all, at the lowest zoom scale dependency.

LAYER_OPTION_VISIBLE does nothing. Identify just presents popups for everything. At all scales. I also tried using identifyParams.layerIds = LAYERNAME.visibleLayers ... still no luck.

Based on the API docs for LAYER_OPTION_VISIBLE ... shouldn't this just work? So is this a known API 'bug'? Or is this related to AGS JS TOC?

Thank you to everyone here! I will test the solution above soon this week or next and report back results.