ListView.groupDataSource property
.png)
Gets or sets the data source that contains the groups for the items in the itemDataSource.
Syntax
<div
data-win-control="WinJS.UI.ListView"
data-win-options="{ groupDataSource : value}" >
</div>
var groupDataSource = listView.groupDataSource;
listView.groupDataSource = groupDataSource;
Property value
Type: IListDataSource**
The data source that contains the groups for the items in the itemDataSource. The default value is null.
Remarks
To display group information, such as group headers and group boundaries, your ListView control's layout must be set to a GridLayout. For grouping to work at all, the ListView control's loadingBehavior property must be set to "randomaccess" (which is the default value).
Grouping requires two data sources: an IListDataSource that contains the items (the itemDataSource), and an IListDataSource that contains the groups. In the items IListDataSource, each item contains a groupKey property that links it to the group it belongs to in the group IListDataSource.
There are two ways to generate a suitable group data source from your itemDataSource:
- Use the computeDataSourceGroups function. This function returns an IListDataSource that contains group information. Set the ListView control's groupDataSource property to the value returned by the IListDataSource object's groups property.
- Use the List.createGrouped method to create a List that contains group information. Set the groupDataSource property to the value returned by the List object's groups.dataSource property.
For more info, see How to group items in a ListView.
Examples
This example uses the List.createGrouped method to create a List that contains group information ("myData.groupedItemsList").
(function () {
"use strict";
var myData = [
{ title: "Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Lavish Lemon Ice", text: "Sorbet", picture: "images/60Lemon.png" },
{ title: "Lavish Lemon Ice", text: "Sorbet", picture: "images/60Lemon.png" },
{ title: "Lavish Lemon Ice", text: "Sorbet", picture: "images/60Lemon.png" },
{ title: "Lavish Lemon Ice", text: "Sorbet", picture: "images/60Lemon.png" },
{ title: "Marvelous Mint", text: "Gelato", picture: "images/60Mint.png" },
{ title: "Marvelous Mint", text: "Gelato", picture: "images/60Mint.png" },
{ title: "Marvelous Mint", text: "Gelato", picture: "images/60Mint.png" },
{ title: "Marvelous Mint", text: "Gelato", picture: "images/60Mint.png" },
{ title: "Creamy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Creamy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Creamy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Creamy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Succulent Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Succulent Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Succulent Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Succulent Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Very Vanilla", text: "Ice Cream", picture: "images/60Vanilla.png" },
{ title: "Very Vanilla", text: "Ice Cream", picture: "images/60Vanilla.png" },
{ title: "Very Vanilla", text: "Ice Cream", picture: "images/60Vanilla.png" },
{ title: "Very Vanilla", text: "Ice Cream", picture: "images/60Vanilla.png" },
{ title: "Orangy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Orangy Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Absolutely Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Absolutely Orange", text: "Sorbet", picture: "images/60Orange.png" },
{ title: "Triple Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Triple Strawberry", text: "Sorbet", picture: "images/60Strawberry.png" },
{ title: "Double Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Double Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Double Banana Blast", text: "Low-fat frozen yogurt", picture: "images/60Banana.png" },
{ title: "Green Mint", text: "Gelato", picture: "images/60Mint.png" }
];
// Create a WinJS.Binding.List from the array.
var itemsList = new WinJS.Binding.List(myData);
// Sorts the groups
function compareGroups(leftKey, rightKey) {
return leftKey.charCodeAt(0) - rightKey.charCodeAt(0);
}
// Returns the group key that an item belongs to
function getGroupKey(dataItem) {
return dataItem.title.toUpperCase().charAt(0);
}
// Returns the title for a group
function getGroupData(dataItem) {
return {
title: dataItem.title.toUpperCase().charAt(0)
};
}
// Create the groups for the ListView from the item data and the grouping functions
var groupedItemsList = itemsList.createGrouped(getGroupKey, getGroupData, compareGroups);
WinJS.Namespace.define("myData",
{
groupedItemsList: groupedItemsList
});
})();
This example creates a header template, an item template, and a ListView for displaying the data.
<!-- The group header template -->
<div id="headerTemplate" data-win-control="WinJS.Binding.Template"
style="display: none">
<div class="simpleHeaderItem">
<h1 data-win-bind="innerText: title"></h1>
</div>
</div>
<!-- The item template -->
<div id="mediumListIconTextTemplate"
data-win-control="WinJS.Binding.Template"
style="display: none">
<div class="mediumListIconTextItem">
<img class="mediumListIconTextItem-Image" data-win-bind="src: picture"
src="#" />
<div class="mediumListIconTextItem-Detail">
<h4 data-win-bind="innerText: title"></h4>
<h6 data-win-bind="innerText: text"></h6>
</div>
</div>
</div>
<!-- The ListView -->
<div id="groupedListView"
data-win-control="WinJS.UI.ListView"
data-win-options="{itemDataSource: myData.groupedItemsList.dataSource,
itemTemplate: select('#mediumListIconTextTemplate'),
groupDataSource: myData.groupedItemsList.groups.dataSource,
groupHeaderTemplate: select('#headerTemplate'),
layout: {type: WinJS.UI.GridLayout}}">
</div>
Let's take a closer look at how the example sets the ListView control's itemDataSource and groupDataSource properties.
myData.groupedItemsListis a List, but the ListView requires an IListDataSource. To obtain an IListDataSource that contains the items, call the List object's dataSource property. The example sets the ListView control's itemDataSource property tomyData.groupedItemsList.dataSource.To obtain an IListDataSource that contains the group information, call the List object's groups property to obtain a List that contains the groups, then call that List object's dataSource property to obtain an IListDataSource. The example sets the ListView control's groupDataSource property to
myData.groupedItemsList.groups.dataSource.
<!-- The ListView -->
<div id="groupedListView"
data-win-control="WinJS.UI.ListView"
data-win-options="{itemDataSource: myData.groupedItemsList.dataSource,
itemTemplate: select('#mediumListIconTextTemplate'),
groupDataSource: myData.groupedItemsList.groups.dataSource,
groupHeaderTemplate: select('#headerTemplate'),
layout: {type: WinJS.UI.GridLayout}}">
</div>
The next example defines CSS styles for the ListView and its templates.
/* CSS for the ListView */
#groupedListView
{
width: 600px;
height: 300px;
border: solid 2px rgba(0, 0, 0, 0.13);
}
/* Template for headers */
.simpleHeaderItem
{
width: 50px;
height: 50px;
padding: 8px;
}
/* Template for items */
.mediumListIconTextItem
{
width: 282px;
height: 70px;
padding: 5px;
overflow: hidden;
display: -ms-grid;
}
.mediumListIconTextItem img.mediumListIconTextItem-Image
{
width: 60px;
height: 60px;
margin: 5px;
-ms-grid-column: 1;
}
.mediumListIconTextItem .mediumListIconTextItem-Detail
{
margin: 5px;
-ms-grid-column: 2;
}
Requirements
Minimum WinJS version |
WinJS 3.0 |
Namespace |
WinJS.UI |