interface CollectionTraversing {
    closedNeighborhood(selector?: string): CollectionReturnValue;
    components(): CollectionReturnValue[];
    neighborhood(selector?: string): CollectionReturnValue;
    openNeighborhood(selector?: string): CollectionReturnValue;
}

Hierarchy (view full)

Methods

  • Get the closed neighbourhood of the elements.

    The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. A closed neighbourhood is one that does include the original set of elements.

    Parameters

    • Optionalselector: string

      [optional] An optional selector that is used to filter the resultant collection.

    Returns CollectionReturnValue

  • Get the open neighbourhood of the elements.

    The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. An open neighbourhood is one that does not include the original set of elements. If unspecified, a neighbourhood is open by default.

    Parameters

    • Optionalselector: string

      [optional] An optional selector that is used to filter the resultant collection.

    Returns CollectionReturnValue

  • Get the open neighbourhood of the elements.

    The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. An open neighbourhood is one that does not include the original set of elements. If unspecified, a neighbourhood is open by default.

    Parameters

    • Optionalselector: string

      [optional] An optional selector that is used to filter the resultant collection.

    Returns CollectionReturnValue