Class StiBandsOnAllPages

Hierarchy

  • StiBandsOnAllPages

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

engine

engine: StiEngine = null

Accessors

denyRendering

  • get denyRendering(): boolean
  • set denyRendering(value: boolean): void

  • If the property is true then bands rendering on all pages is blocked. The property is used to output headers, with the height higher than one page, on all pages.

    Returns boolean

  • If the property is true then bands rendering on all pages is blocked. The property is used to output headers, with the height higher than one page, on all pages.

    Parameters

    • value: boolean

    Returns void

Methods

add

  • Starts monitoring of this band for rendering OnAllPages.

    Parameters

    Returns void

getBandsList

isBandInBandsList

  • isBandInBandsList(band: StiBand): boolean

  • Parameters

    Returns boolean

remove

  • Ends monitoring of this band for rendering OnAllPages. All bands which are dependent on the specified DataBand are removed.

    Parameters

    Returns void

render

  • render(): void

  • Returns void

renderAsync

  • renderAsync(): Promise<void>

  • Outputs bands, which were previously added to the collection of bands, which are output on all pages, on a new page.

    Returns Promise<void>

Generated using TypeDoc