"use strict";
define(["jquery", "underscore", "backbone", "models/maps/Feature"], function (
$,
_,
Backbone,
Feature
) {
/**
* @class Features
* @classdesc A Features collection contains the relevant properties of a group of
* selected geo-spatial features from a map.
* @class Features
* @classcategory Collections/Maps
* @extends Backbone.Collection
* @since 2.18.0
* @constructor
*/
var Features = Backbone.Collection.extend(
/** @lends Features.prototype */ {
/**
* The class/model that this collection contains.
* @type {Backbone.Model}
*/
model: Feature,
/**
* Get an array of all of the unique Map Assets that are associated with this
* collection. (When a feature model is part of a layer, it will have the layer
* model (Map Asset) set as a property)
* @returns {MapAsset[]} Returns an a array of all the unique Map Assets (imagery,
* tile sets, etc.) in this collection.
*/
getMapAssets: function () {
return this.getUniqueAttrs("mapAsset");
},
/**
* Get an array of all the unique feature objects associated with this collection.
* @param {string} [type] Optionally set a type of feature to return. If set, then
* only features that have this constructor name will be returned.
* @returns {Array} Returns an array of all of the unique feature objects in the
* collection. Feature objects are the objects used by the map widget to represent
* a feature in the map. For example, in Cesium this could be a
* Cesium3DTileFeature or an Entity.
*/
getFeatureObjects: function (type) {
let featureObjects = this.getUniqueAttrs("featureObject");
if (type) {
featureObjects = featureObjects.filter(function (featureObject) {
return featureObject.constructor.name === type;
});
}
return featureObjects;
},
/**
* Get an array of unique values for some attribute that may be set on the models
* in this collection
* @param {string} attrName The name of the attr to get unique values for
* @returns {Array} Returns an array of unique values of the given attribute
*/
getUniqueAttrs: function (attrName) {
try {
let uniqueAttrs = [];
this.each(function (featureModel) {
const attr = featureModel.get(attrName);
if (attr && !uniqueAttrs.includes(attr)) {
uniqueAttrs.push(attr);
}
});
return uniqueAttrs;
} catch (error) {
console.log(
`Failed to get unique attributes for "${attrName}".`,
error
);
}
},
/**
* Checks if a given feature object is an attribute in one of the Feature models
* in this collection.
* @param {Feature|Cesium.Cesium3DTilesetFeature|Cesium.Entity} featureObject
* @returns {boolean} Returns true if the given feature object is in this
* collection, false otherwise.
* @since 2.25.0
*/
containsFeature: function (featureObject) {
if (this.models.length === 0) return false;
if (!featureObject) return false;
featureObject =
featureObject instanceof Feature
? featureObject.get("featureObject")
: featureObject;
return this.findWhere({ 'featureObject': featureObject }) ? true : false;
},
/**
* Checks if a given array of feature objects are attributes in one of the
* Feature models in this collection.
* @param {Array} featureObjects An array of feature objects to check if they are
* in this collection.
* @returns {boolean} Returns true if all of the given feature objects are in this
* collection, false otherwise.
*/
containsFeatures: function (featureObjects) {
if (!featureObjects || !featureObjects.length) return false;
return featureObjects.every((featureObject) =>
this.containsFeature(featureObject)
);
},
}
);
return Features;
});