renderOffset

Topic group Related topics Example

The offset of the bottom of the band from the top of the current stream frame.

Property of

Band

Description

renderOffset is a read-only property that contains the position of the bottom of the band that was just rendered, measured from the top of the stream frame, in the report’s current metric units. It is updated just before the band’s onRender event fires.

A common use of renderOffset is to prevent a band from being split between two pages when using expandable bands—that is, bands that can vary in height. The renderOffset in checked the onRender event. If the offset is too close to the bottom, less than a predetermined minimum size, the stream source’s beginNewFrame( ) method is called to force the output to the next stream frame. For fixed height bands, the stream source’s maxRows property would used instead.