OptionalsublayersProperty: stringProtected Readonly_handlesProtected Readonly_parentThe SublayerExtension that owns this collection.
The declared class name. This is always "esri.core.Collection" for
compatibility with Esri's API.
Protected_collectionThe underlying collection that this class delegates to.
Protected_layerThe layer extension that the collection of sublayers is associated with.
Whether the collection has been destroyed.
Whether the collection has been initialized.
Set to true once the initialize function has executed.
Returns a collection of the initialized items.
The number of items in the collection.
Protected_getProtected_itemReturns whether an item in the collection is considered initialized.
The item being checked for initialization.
Protected_onInvoked whenever a sublayer extension is added.
The new sublayer extension.
Protected_onInvoked whenever a sublayer extension is removed.
The sublayer extension that was removed.
Protected_setAdds a single item to the collection.
Optionalindex: numberZero-based index of where in the collection to add the item. If not specified, the items will be added at the end.
Adds multiple items to the collection.
An array or collection of items to add.
Optionalindex: numberZero-based index of where in the collection to add the items. If not specified, the items will be added at the end.
Returns the item at the specified index.
Zero-based index of the item in the Collection to retrieve.
The item in the Collection stored at the specified index.
Creates a deep clone of the Collection. To create a shallow clone of the collection, use slice().
Creates a new Collection containing the items in the original Collection joined with the items in the input array or Collection.
The array or Collection to append to the existing Collection.
OptionalthisArg: anyDetermines whether all items in the Collection pass a test defined by callback. Each item in the Collection is passed into the callback until one returns a value of false.
The function to call for each item in the Collection.
Filters the Collection's items based on a test defined by the callback function. Each item is passed into the callback function, which returns true if the item passes the test and false if it does not.
The function that defines a test for determining whether to return the item in a new Collection.
Returns an item in the Collection if that item passes a test as defined in the callback function. Each item is passed into the callback function, which returns true if the item passes the test and false if it does not.
The testing function that will assess each item in the Collection. Returns true if an item passes the test and false if it fails.
Get the sublayer extension for a given id.
The id of the sublayer extension.
The sublayer extension.
Get the corresponding sublayer extension for a given sublayer id.
The id of the sublayer.
The corresponding sublayer extension.
Returns the index of an item in the Collection if that item passes a test as defined in the callback function. Each item is passed into the callback function, which returns true if the item passes the test and false if it does not.
The testing function that will assess each item in the Collection. Returns true if an item passes the test and false if it fails.
Returns the index of the Collection item that satisfies the test function. If an item fails the test, -1 is returned.
Flattens a hierarchical Collection containing at least one child collection. Each item in the collection is passed into the callback function, which should check for child collections specified by the developer. A flat collection of all items (parent and children) is returned.
A function that will assess each item in the Collection.
Executes the input function for each item in the Collection.
The function to call for each item in the Collection.
Gets the corresponding sublayer extension for a given sublayer.
A sublayer.
The corresponding sublayer extension.
Returns the item at the specified index.
Zero-based index of the item in the Collection to retrieve.
The item in the Collection stored at the specified index.
Tests if an item is present in the Collection.
The item to search for in the collection.
Returns the index of an element in the collection.
Item to search for in the collection.
OptionalfromIndex: numberUse if you don't want to search the whole collection or you don't want to search from the start.
Returns the last index of an element in the collection.
Item to search for in the collection.
OptionalfromIndex: numberUse if you don't want to search the whole collection, or you don't want to search from the end.
The location of the last match found in the collection, or -1 if there is no match.
Passes each Collection item into the callback function and returns a new array of the returned values.
The function that processes each item in the Collection and returns a new value at the same index of the original item.
ProtectednotifyRegisters an event handler on the instance. Call this method to hook an event with a listener.
The function to call when the event fires.
Returns an event handler with a remove() method that should be called to stop listening for the event(s).
| Property | Type | Description |
|---|---|---|
| remove | Function | When called, removes the listener from the event. |
Removes the last item from the collection and returns it.
Adds an item to the end of the collection.
The item to add.
Reduces all items in the collection (from left to right) into a single variable using callback.
The function that processes each item in the Collection and appends it to the previous item.
OptionalinitialValue: UItem to use as the first element to process in callback.
Reduces all items in the collection (from right to left) into a single variable using callback.
The function that processes each item in the Collection and appends it to the previous item.
OptionalinitialValue: UItem to use as the first element to process in callback.
Removes an item from the collection.
The item to remove.
Removes all items from the collection.
Removes an item from the collection at a specified index.
The index of the element to remove.
Removes each item in the input array. If an item is present multiple times in the collection, only the first occurrence is removed.
The items to remove.
Moves an item in the Collection to a specified index. The change event is fired after an item is moved in the Collection.
The index to move the item to.
Removes the first item from the collection (at index 0), and returns it. The remaining items of the collection are then shifted down one index from their previous location.
Creates a new Collection comprised of a portion of the original Collection.
Optionalbegin: numberThe index of the first item to extract.
Optionalend: numberThe index of the last item to extract.
Determines whether an item in the Collection passes a test defined by callback. Each item in the Collection is passed into the callback until one returns a value of true.
The function that defines the test for each Collection item.
Sorts the Collection in place.
OptionalcompareFunction: ((a: SublayerExtension<SublayerExtensionProperties>, b: SublayerExtension<SublayerExtensionProperties>) => number)The function that defines a comparison of two items in the collection.
Removes existing items and/or adds new items to the collection.
Index at which to start changing the collection.
Indicates the number of collection items to remove. If 0 is used then no elements are removed and at least one new item should be added in the items parameter.
Rest...items: SublayerExtension<SublayerExtensionProperties>[]The item or comma-separated list of items to add to the collection.
An array of the deleted items formerly part of the collection.
Returns a new array object containing the Collection's items.
Adds an item to the beginning of the collection.
The item to add.
Optionalsync: boolean
A collection of sublayer extensions belonging to a SublayerExtension.