Implementation of the support/_ArcGISRelationshipCollection!ArcGISRelationshipCollection specific to ArcGISSublayer.

Hierarchy (view full)

Constructors

Properties

_handles: Handles<unknown, ResourceHandle>

Feature source that owns this collection.

@eventTypes: CollectionEvents<Relationship>

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

declaredClass: string = "esri.core.Collection"

The declared class name. This is always "esri.core.Collection" for compatibility with Esri's API.

Accessors

  • get _collection(): Collection<Relationship>
  • The underlying collection that this class delegates to.

    Returns Collection<Relationship>

  • get _sourceLayerId(): number
  • The ID of the source layer/table.

    Returns number

  • get _sourceUrl(): string
  • The URL of the layer/table.

    Returns string

  • get destroyed(): boolean
  • Whether the collection has been destroyed.

    Returns boolean

  • set destroyed(value): void
  • Parameters

    • value: boolean

    Returns void

  • get initialized(): boolean
  • Whether the collection has been initialized.

    Returns boolean

  • set initialized(value): void
  • Set to true once the initialize function has executed.

    Parameters

    • value: boolean

    Returns void

  • get length(): number
  • The number of items in the collection.

    Returns number

  • get requestHelper(): ArcGISRequestHelper
  • The request helper that will be used to make requests. If not explicitly set, a default one will be used.

    Returns ArcGISRequestHelper

  • set requestHelper(value): void
  • Parameters

    Returns void

Methods

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns this

    • Unsupported on CollectionProxy.
  • Adds a single item to the collection.

    Parameters

    • relationship: Relationship
    • Optionalindex: number

      Zero-based index of where in the collection to add the item. If not specified, the items will be added at the end.

    Returns this

  • Adds multiple items to the collection.

    Parameters

    • items: ReadonlyArrayOrCollection<Relationship>

      An array or collection of items to add.

    • Optionalindex: number

      Zero-based index of where in the collection to add the items. If not specified, the items will be added at the end.

    Returns this

  • Returns the item at the specified index.

    Parameters

    • index: number

      Zero-based index of the item in the Collection to retrieve.

    Returns Relationship

    The item in the Collection stored at the specified index.

  • Determines 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.

    Parameters

    Returns boolean

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

    Parameters

    Returns Collection<Relationship>

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

    Parameters

    • callback: ItemTestCallback<Relationship>

      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 Relationship

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

    Parameters

    • callback: ItemTestCallback<Relationship>

      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 number

    Returns the index of the Collection item that satisfies the test function. If an item fails the test, -1 is returned.

  • Executes the input function for each item in the Collection.

    Parameters

    • callback: ItemCallback<Relationship>

      The function to call for each item in the Collection.

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyPath: string

    Returns T

    • Unsupported on CollectionProxy.
  • Parameters

    • propertyPath: string

    Returns unknown

    • Unsupported on CollectionProxy.
  • Returns the index of an element in the collection.

    Parameters

    • searchElement: Relationship

      Item to search for in the collection.

    • OptionalfromIndex: number

      Use if you don't want to search the whole collection or you don't want to search from the start.

    Returns number

  • Creates a string representation of the items in the Collection.

    Parameters

    • Optionalseparator: string

      The separator used between each item in the final string. The default is ",".

    Returns string

  • Returns the last index of an element in the collection.

    Parameters

    • searchElement: Relationship

      Item to search for in the collection.

    • OptionalfromIndex: number

      Use if you don't want to search the whole collection, or you don't want to search from the end.

    Returns number

    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.

    Type Parameters

    • U

    Parameters

    • callback: ItemMapCallback<Relationship, U>

      The function that processes each item in the Collection and returns a new value at the same index of the original item.

    Returns Collection<U>

  • Reduces all items in the collection (from left to right) into a single variable using callback.

    Type Parameters

    • U

    Parameters

    • callback: ItemReduceCallback<Relationship, U>

      The function that processes each item in the Collection and appends it to the previous item.

    • OptionalinitialValue: U

      Item to use as the first element to process in callback.

    Returns U

  • Reduces all items in the collection (from right to left) into a single variable using callback.

    Type Parameters

    • U

    Parameters

    • callback: ItemReduceCallback<Relationship, U>

      The function that processes each item in the Collection and appends it to the previous item.

    • OptionalinitialValue: U

      Item to use as the first element to process in callback.

    Returns U

  • Type Parameters

    • T

    Parameters

    • propertyPath: string
    • value: T

    Returns this

    • Unsupported on CollectionProxy.
  • Parameters

    • properties: HashMap<unknown>

    Returns this

    • Unsupported on CollectionProxy.
  • Creates a new Collection comprised of a portion of the original Collection.

    Parameters

    • Optionalbegin: number

      The index of the first item to extract.

    • Optionalend: number

      The index of the last item to extract.

    Returns Collection<Relationship>

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

    Parameters

    Returns boolean

  • Removes existing items and/or adds new items to the collection.

    Parameters

    • start: number

      Index at which to start changing the collection.

    • deleteCount: number

      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: Relationship[]

      The item or comma-separated list of items to add to the collection.

    Returns Relationship[]

    An array of the deleted items formerly part of the collection.

  • Parameters

    • path: string | string[]
    • callback: ((newValue: any, oldValue: any, propertyName: string, target: any) => void)
        • (newValue, oldValue, propertyName, target): void
        • Parameters

          • newValue: any
          • oldValue: any
          • propertyName: string
          • target: any

          Returns void

    • Optionalsync: boolean

    Returns IHandle

    • Unsupported on CollectionProxy.