ILayout2.layout method

Performs a layout pass.

Syntax

var object = iLayout2.layout(tree, changedRange, modifiedItems, modifiedGroups);

Parameters

  • tree
    Type: Object

    A structure representing the layout tree that is returned from the ListView.

  • changedRange
    Type: Object

    An object that lists the index of the first item in the changed item range. This object has these properties:

Term Description

startIndex

The index of the first item in the change range.

 
  • modifiedItems
    Type: Object

    An object that contains the old and new indexes of the items that have been modified in the tree.

  • modifiedGroups
    Type: Object

    An object that contains the old and new indexes of the group elements that have been modified in the tree.

Return value

Type: Object

A Promise that executes after layout is complete, or an object that contains two Promise objects:

Property Description

realizedRangeComplete

A Promise that executes after the realized range is complete.

layoutComplete

A Promise that executes after layout is complete.

 

Requirements

Minimum WinJS version

WinJS 3.0

Namespace

WinJS.UI

See also

ILayout2