MapGIS Client for JavaScript API

# items

# readonly items

# readonly length

# static isCollection(item)

参数:

示例

判断传入的对象是否是一个集合对象

const collection = new Collection([1, 2, 3])
const isCollection = Collection.isCollection(collection)

# add(item, index)

参数:

示例

添加一个元素到集合中

const collection = new Collection()
collection.add({
  key: 'value'
})

添加一个元素到集合中的指定位置

const collection = new Collection([1, 2, 3])
collection.add({
  key: 'value'
}, 1)

# addMany(items, index)

参数:

示例

添加多个元素到集合中

const collection = new Collection()
collection.addMany([1, 2, 3])

添加多个元素到集合中的指定位置

const collection = new Collection([1, 2, 3])
collection.addMany([1, 2, 3], 2)

# all()

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.all()

# at(index)

参数:

示例

返回指定下标处的元素

const collection = new Collection([1, 2, 3])
const item = collection.at(1)

# clone()

示例

克隆并返回一个新集合对象

const collection = new Collection([1, 2, 3])
const cloneObj = collection.clone()

# concat(collection)

参数:

示例

将一个数组或者集合对象链接到当前集合对象末尾

const collection = new Collection([1, 2, 3])
collection.concat([{'a': 1}, {'b': 2}])
collection.concat(new Collection([4, 5, 6]))

# createInstance(item)

参数:

# every(fn)

参数:

示例

检测数组所有元素是否都符合指定条件

const collection = new Collection([1, 2, 3])
const isNumber = collection.every(function(item) {
  return typeof item === 'number'
})

# filter(fn)

参数:

示例

通过一个过滤条件（函数提供）来过滤并返回元素

const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.filter(function(item) {
  return item > 2
})

# find(fn)

参数:

示例

返回第一个符合过滤条件（函数提供）的元素，如果没找到则返回undefined

const collection = new Collection([1, 2, 3, 4, 5])
const item = collection.find(function(item) {
  return item > 2
})

# findIndex(fn)

参数:

示例

返回第一个符合过滤条件（函数提供）的元素的下标，如果没找到则返回-1

const collection = new Collection([1, 2, 3, 4, 5])
const index = collection.findIndex(function(item) {
  return item > 1
})

# flatten(fn)

参数:

示例

扁平化一个集合对象

const collection = new Collection([{
  layers: [1, 2, 3]
},{
  items: [4, 5, 6]
}])
const flatten = collection.flatten(function(item) {
  return item.layers || item.items
})

# forEach(fn)

参数:

示例

对集合中的所有元素执行传入的函数

const collection = new Collection([1, 2, 3])
collection.forEach(function(item) {
  console.log("item:", item)
})

# getItemAt(index)

参数:

示例

获取指定下标的元素

const collection = new Collection([1, 2, 3])
const item = collection.getItemAt(1)

# includes(item)

参数:

示例

判断集合中是否包含该元素

const collection = new Collection([1, 2, 3])
const isInclude = collection.includes(2)

# indexOf(item, fromIndex)

参数:

示例

判断集合中是否包含该元素

const item = {
  'a': 1
}
const collection = new Collection([item, 2, 3])
const index = collection.indexOf(item)

判断集合中是否包含该元素-选择起始下标

const item = {
  'a': 1
}
const collection = new Collection([item, 2, 3, item])
const index = collection.indexOf(item, 1)

# join(separator)

参数:

示例

通过传入一个分隔符，将集合中的元素通过分隔符拼接成一个字符串并返回

const collection = new Collection([1, 2, 3])
const str = collection.join(',')

# lastIndexOf(item, fromIndex)

参数:

示例

从集合的最末尾开始，寻找该元素，并返回元素下标

const collection = new Collection([1, 2, 3])
const index = collection.lastIndexOf(3)

从集合的最末尾开始，寻找该元素，并返回元素下标 - 指定起始额位置

const collection = new Collection([1, 2, 3, 3, 3])
const index = collection.lastIndexOf(3, 3)

# map(fn)

参数:

示例

通过一个遍历函数来遍历该集合下的所有元素，并返回一个新集合对象

const collection = new Collection([1, 2, 3])
const newCollection = collection.map(function (item) {
  return item + 1
})

# pop()

示例

删除并返回集合的最后一个元素

const collection = new Collection([1, 2, 3])
const item = collection.pop()

# push(item)

参数:

示例

添加一个元素到集合中

const collection = new Collection([1, 2, 3])
collection.push(4)

# reduce(fn, baseValue)

参数:

示例

接收一个函数做为累加器，将集合中的每一个元素(下标从小到大的顺序)进行累加，最后返回一个对象

const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
  return reduceCarry += item
}, 0)

# reduceRight(fn, baseValue)

参数:

示例

接收一个函数做为累加器，将集合中的每一个元素(下标从大到小的顺序)进行累加，最后返回一个对象

const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
  console.log(item)
})

# remove(item)

参数:

示例

删除一个元素，仅会删除找到的第一个元素,并发送删除事件

const collection = new Collection([1, 2, 3])
collection.remove(1)

# removeAll()

示例

删除集合中的所有元素，删除完成后会发送数据变更事件

const collection = new Collection([1, 2, 3])
collection.removeAll(1)

# removeAt(index)

参数:

示例

删除指定下标的元素

const collection = new Collection([1, 2, 3])
collection.removeAt(1)

# removeMany(items)

参数:

示例

删除集合中的多个元素，删除完成后会发送数据变更事件

const collection = new Collection([1, 2, 3])
collection.removeMany([1, 2])

# reorder(item, index)

参数:

示例

将指的元素调整到集合中指的下标位置

const collection = new Collection([1, 2, 3])
collection.reorder(1, 2)

# reverse()

示例

将集合对象中的元素反转，并返回新集合对象

const collection = new Collection([1, 2, 3])
const newCollection =  collection.reverse()

# shift()

示例

删除并返回集合的第一个元素

const collection = new Collection([1, 2, 3])
const item =  collection.shift()

# slice(start, end)

参数:

示例

截取集合中从start开始到end下标的元素，并返回一个新集合对象

const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.slice(1, 3)

# some(fn)

参数:

示例

判断集合对象中的元素是否满足过滤条件

const collection = new Collection([1, 2, 3, 4, 5])
const flag = collection.some(function (item) {
  return item === 1
})

# sort(fn)

参数:

示例

通过一个排序函数来对当前的集合进行排序，之后返回一个新集合对象

const collection = new Collection([{
  'a': 2
},{
  'a': 1
},{
  'a': 3
}])
const newCollection = collection.sort(function (itemA, itemB) {
  return itemA.a - itemB.a
})

# splice(start, deleteCount, …items)

参数:

示例

向集合中删除一个元素

const collection = new Collection([1, 2, 3])
const newCollection = collection.splice(1, 1)

向集合中添加一个元素

const collection = new Collection([1, 2, 3])
collection.splice(1, 0, 1)

# toArray()

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.toArray()

# unique(key)

参数:

示例

No Arguments

const unique = new Collection([2, 1, 2, 3, 3, 4, 5, 1, 2]).unique();
console.log(unique); // [2, 1, 3, 4, 5]

Property Name

const students = new Collection([
   { name: 'Rick', grade: 'A'},
   { name: 'Mick', grade: 'B'},
   { name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique('grade'); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]

With Callback

const students = new Collection([
   { name: 'Rick', grade: 'A'},
   { name: 'Mick', grade: 'B'},
   { name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique(s => s.grade); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]

# unshift(…items)

参数:

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.unshift(1, 2)

# items

# readonly items

# readonly length

# static isCollection(item)

参数:

示例

判断传入的对象是否是一个集合对象

const collection = new Collection([1, 2, 3])
const isCollection = Collection.isCollection(collection)

# add(item, index)

参数:

示例

添加一个元素到集合中

const collection = new Collection()
collection.add({
  key: 'value'
})

添加一个元素到集合中的指定位置

const collection = new Collection([1, 2, 3])
collection.add({
  key: 'value'
}, 1)

# addMany(items, index)

参数:

示例

添加多个元素到集合中

const collection = new Collection()
collection.addMany([1, 2, 3])

添加多个元素到集合中的指定位置

const collection = new Collection([1, 2, 3])
collection.addMany([1, 2, 3], 2)

# all()

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.all()

# at(index)

参数:

示例

返回指定下标处的元素

const collection = new Collection([1, 2, 3])
const item = collection.at(1)

# clone()

示例

克隆并返回一个新集合对象

const collection = new Collection([1, 2, 3])
const cloneObj = collection.clone()

# concat(collection)

参数:

示例

将一个数组或者集合对象链接到当前集合对象末尾

const collection = new Collection([1, 2, 3])
collection.concat([{'a': 1}, {'b': 2}])
collection.concat(new Collection([4, 5, 6]))

# createInstance(item)

参数:

# every(fn)

参数:

示例

检测数组所有元素是否都符合指定条件

const collection = new Collection([1, 2, 3])
const isNumber = collection.every(function(item) {
  return typeof item === 'number'
})

# filter(fn)

参数:

示例

通过一个过滤条件（函数提供）来过滤并返回元素

const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.filter(function(item) {
  return item > 2
})

# find(fn)

参数:

示例

返回第一个符合过滤条件（函数提供）的元素，如果没找到则返回undefined

const collection = new Collection([1, 2, 3, 4, 5])
const item = collection.find(function(item) {
  return item > 2
})

# findIndex(fn)

参数:

示例

返回第一个符合过滤条件（函数提供）的元素的下标，如果没找到则返回-1

const collection = new Collection([1, 2, 3, 4, 5])
const index = collection.findIndex(function(item) {
  return item > 1
})

# flatten(fn)

参数:

示例

扁平化一个集合对象

const collection = new Collection([{
  layers: [1, 2, 3]
},{
  items: [4, 5, 6]
}])
const flatten = collection.flatten(function(item) {
  return item.layers || item.items
})

# forEach(fn)

参数:

示例

对集合中的所有元素执行传入的函数

const collection = new Collection([1, 2, 3])
collection.forEach(function(item) {
  console.log("item:", item)
})

# getItemAt(index)

参数:

示例

获取指定下标的元素

const collection = new Collection([1, 2, 3])
const item = collection.getItemAt(1)

# includes(item)

参数:

示例

判断集合中是否包含该元素

const collection = new Collection([1, 2, 3])
const isInclude = collection.includes(2)

# indexOf(item, fromIndex)

参数:

示例

判断集合中是否包含该元素

const item = {
  'a': 1
}
const collection = new Collection([item, 2, 3])
const index = collection.indexOf(item)

判断集合中是否包含该元素-选择起始下标

const item = {
  'a': 1
}
const collection = new Collection([item, 2, 3, item])
const index = collection.indexOf(item, 1)

# join(separator)

参数:

示例

通过传入一个分隔符，将集合中的元素通过分隔符拼接成一个字符串并返回

const collection = new Collection([1, 2, 3])
const str = collection.join(',')

# lastIndexOf(item, fromIndex)

参数:

示例

从集合的最末尾开始，寻找该元素，并返回元素下标

const collection = new Collection([1, 2, 3])
const index = collection.lastIndexOf(3)

从集合的最末尾开始，寻找该元素，并返回元素下标 - 指定起始额位置

const collection = new Collection([1, 2, 3, 3, 3])
const index = collection.lastIndexOf(3, 3)

# map(fn)

参数:

示例

通过一个遍历函数来遍历该集合下的所有元素，并返回一个新集合对象

const collection = new Collection([1, 2, 3])
const newCollection = collection.map(function (item) {
  return item + 1
})

# pop()

示例

删除并返回集合的最后一个元素

const collection = new Collection([1, 2, 3])
const item = collection.pop()

# push(item)

参数:

示例

添加一个元素到集合中

const collection = new Collection([1, 2, 3])
collection.push(4)

# reduce(fn, baseValue)

参数:

示例

接收一个函数做为累加器，将集合中的每一个元素(下标从小到大的顺序)进行累加，最后返回一个对象

const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
  return reduceCarry += item
}, 0)

# reduceRight(fn, baseValue)

参数:

示例

接收一个函数做为累加器，将集合中的每一个元素(下标从大到小的顺序)进行累加，最后返回一个对象

const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
  console.log(item)
})

# remove(item)

参数:

示例

删除一个元素，仅会删除找到的第一个元素,并发送删除事件

const collection = new Collection([1, 2, 3])
collection.remove(1)

# removeAll()

示例

删除集合中的所有元素，删除完成后会发送数据变更事件

const collection = new Collection([1, 2, 3])
collection.removeAll(1)

# removeAt(index)

参数:

示例

删除指定下标的元素

const collection = new Collection([1, 2, 3])
collection.removeAt(1)

# removeMany(items)

参数:

示例

删除集合中的多个元素，删除完成后会发送数据变更事件

const collection = new Collection([1, 2, 3])
collection.removeMany([1, 2])

# reorder(item, index)

参数:

示例

将指的元素调整到集合中指的下标位置

const collection = new Collection([1, 2, 3])
collection.reorder(1, 2)

# reverse()

示例

将集合对象中的元素反转，并返回新集合对象

const collection = new Collection([1, 2, 3])
const newCollection =  collection.reverse()

# shift()

示例

删除并返回集合的第一个元素

const collection = new Collection([1, 2, 3])
const item =  collection.shift()

# slice(start, end)

参数:

示例

截取集合中从start开始到end下标的元素，并返回一个新集合对象

const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.slice(1, 3)

# some(fn)

参数:

示例

判断集合对象中的元素是否满足过滤条件

const collection = new Collection([1, 2, 3, 4, 5])
const flag = collection.some(function (item) {
  return item === 1
})

# sort(fn)

参数:

示例

通过一个排序函数来对当前的集合进行排序，之后返回一个新集合对象

const collection = new Collection([{
  'a': 2
},{
  'a': 1
},{
  'a': 3
}])
const newCollection = collection.sort(function (itemA, itemB) {
  return itemA.a - itemB.a
})

# splice(start, deleteCount, …items)

参数:

示例

向集合中删除一个元素

const collection = new Collection([1, 2, 3])
const newCollection = collection.splice(1, 1)

向集合中添加一个元素

const collection = new Collection([1, 2, 3])
collection.splice(1, 0, 1)

# toArray()

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.toArray()

# unique(key)

参数:

示例

No Arguments

const unique = new Collection([2, 1, 2, 3, 3, 4, 5, 1, 2]).unique();
console.log(unique); // [2, 1, 3, 4, 5]

Property Name

const students = new Collection([
   { name: 'Rick', grade: 'A'},
   { name: 'Mick', grade: 'B'},
   { name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique('grade'); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]

With Callback

const students = new Collection([
   { name: 'Rick', grade: 'A'},
   { name: 'Mick', grade: 'B'},
   { name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique(s => s.grade); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]

# unshift(…items)

参数:

示例

返回集合对象中元素组成的数组

const collection = new Collection([1, 2, 3])
collection.unshift(1, 2)