Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
classapi-page

fluid.find(list, fn, deflt)

Section
Column
width70%

Scans through a list of objects, terminating on and returning the first member which matches a predicate function.

Code Block
javascript
javascript
bgColorwhite
borderStylenone
fluid.find(list, fn, deflt);

File name: Fluid.js

Parameters

Span
classborderless-table

list

source

(Arrayable | Object) The list or hash of objects to be searched.

fn

(Function) A predicate function, acting on a list member. A predicate which returns any value which is not null or undefined will terminate the search. The function has the signature (object, index).

deflt

(Object) (optional) A value to be returned in the case no predicate function matches a list member. The default will be the natural value of undefined

Return Value

Span
classborderless-table

Object

the first object in the list that matches the predicate function, or deflt if nothing does

Column
width5%

Column

See Also


Example

Code Block
javascript
javascript
var findColIndex = function (item, layout) {
    return fluid.find(layout.columns,
                      function (column, colIndex) {
                          return item === column.container? colIndex : undefined;
                      });
};

The function findColIndex uses fluid.find to examine a list of columns. The anonymous function being passed as the second argument examines compares each column's container property against the desired item and returns the index of the column if foundit matches. fluid.find will apply this function to each item in the column list and return the first column that matches.