Class CellSpanningLayout

Represents a layout for the ListView in which items are arranged in a grid and items can span multiple grid cells.

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(options?: any): CellSpanningLayout

Creates a new CellSpanningLayout.

constructor

Parameters

  • options?: any optional

    An object that contains one or more property/value pairs to apply to the new CellSpanningLayout. Each property of the options object corresponds to one of the object's properties or events. Event names must begin with "on".

Returns

CellSpanningLayout

Properties

public groupHeaderPosition: HeaderPosition

Gets or sets the position of group headers relative to their items.

public groupInfo: Function

Gets or sets a function that enables cell-spanning and establishes base cell dimensions.

public itemInfo: Function

Gets or sets a function that returns the width and height of an item, as well as whether it should appear in a new column. Setting this function improves performance because the ListView can allocate space for an item without having to measure it first.

public maximumRowsOrColumns: number

Gets or set the maximum number of rows or columns, depending on the orientation, to display before content begins to wrap.

public numberOfItemsPerItemsBlock: any

This API supports the Windows Library for JavaScript infrastructure and is not intended to be used directly from your code.

public orientation: Orientation

Gets the orientation of the CellSpanningLayout. For a CellSpanningLayout, this property always returns Orientation.horizontal.

Methods

public dragLeave()

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

public dragOver()

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

public executeAnimations()

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

public getAdjacent(currentItem: any, pressedKey: Key): any

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

Parameters

  • currentItem: any

    An object that describes the current item. It has these properties: index, type.

  • pressedKey: Key

    The key that was pressed.

Returns

any

An object that describes the next item that should receive focus. It has these properties: index, type.

public hitTest(x: number, y: number)

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

Parameters

  • x: number

    The x-coordinate, or the horizontal position on the screen.

  • y: number

    The y-coordinate, or the vertical position on the screen.

public initialize(site: ILayoutSite2, groupsEnabled: boolean)

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

Parameters

  • site: ILayoutSite2

    The rendering site for the layout.

  • groupsEnabled: boolean

    Set to true if this layout supports groups; set to false if it does not.

public itemsFromRange(firstPixel: number, lastPixel: number)

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

Parameters

  • firstPixel: number

    The first pixel the range of items falls between.

  • lastPixel: number

    The last pixel the range of items falls between.

public layout(tree: ILayoutSite2, changedRange: any, modifiedItems: any, modifiedGroups: any)

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

Parameters

  • tree: ILayoutSite2
  • changedRange: any
  • modifiedItems: any
  • modifiedGroups: any

public setupAnimations()

This API supports the WinJS infrastructure and is not intended to be used directly from your code.

public uninitialize()

This API supports the WinJS infrastructure and is not intended to be used directly from your code.