Scrolling

When paging from one set of records to the next using one of the APIs to set the first displayed item index, a transition effect can be used. The IPFGrid can take a default transition specification. Additionally, the scripting can specify the transition at the time API to set the first display item index is called:

context.SetFirstDisplayedItemIndexToNextRowOrColumn(transition, transitionTime)

context.SetFirstDisplayedItemIndexToPreviousRowOrColumn(transition, transitionTime)

context.SetFirstDisplayedItemIndexToRowOrColumn(columnNumber, transition, transitionTime)

context.SetFirstDisplayedItemIndexToNextPage(transition, transitionTime)

context.SetFirstDisplayedItemIndexToPreviouPage(transition, transitionTime)

context.SetFirstDisplayedItemIndexToPage(pageNumber, transition, transitionTime)

context.SetFirstDisplayedItemIndex(recordNumber, transition, transitionTime)

The transition works only when the change to the index results in a whole number of rows or columns (based on grid orientation type) being moved.

Parameters

  • Transition: The name of the animation to use while bringing in the next page. These transition specifiers are recognized:
    • CutIn: Ignores transitionDuration() and makes new records available immediately.
    • FadeIn
    • Slide
      • When using a horizontal orientation, the grid slides to the left or right revealing additional columns until the correct FirstDisplayedItemIndex is reached. If the new FirstDisplayedItemIndex does not fall in the top row, the Slide animation is not performed.
      • When using a vertical orientation, the grid slides up or down revealing additional rows until the correct FirstDisplayedItemIndex is reached. If the new FirstDisplayedItemIndex does not fall in the left most column, the Slide animation is not performed.
      • If data is not available, it will be fetched from the server. If data is not available on the server, it will be fetched from the data source.
      • The IPFGrid attempts to maintain a smooth scrolling effect during server round trips if supported by the browser. Otherwise, there may be a pause in the scrolling action.
      • If the end of the collection is reached, there may be blank areas on the grid in order to get the FirstDisplayedItemIndex into position.
  • TransitionDuration: (optional) The duration, in milliseconds, that the transition from one row/column to the next takes. Default value is 100 (0.1 second).