Hierarchy

  • StiEngine

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StiEngine(report: StiReport): StiEngine
  • Parameters

    • report: StiReport

    Returns StiEngine

Properties

allowEndOfPageProcessing

allowEndOfPageProcessing: boolean = false

anchorsArguments

anchorsArguments: Hashtable = null

atLeastOneDatabandRenderedOnPage

atLeastOneDatabandRenderedOnPage: boolean = false

bandsInProgress

bandsInProgress: StiBand[] = []

bandsOnAllPages

bandsOnAllPages: StiBandsOnAllPages = null

Contains a collection of bands which should be output on all pages.

breakable

breakable: StiBreakableHelper = null

An object helps to work with IStiBreakable interface.

columnsOnDataBand

columnsOnDataBand: StiColumnsOnDataBand = null

Used to output columns on the DataBand.

columnsOnPanel

columnsOnPanel: StiColumnsOnPanel = null

Used to output columns on the Panel.

containerForRender

containerForRender: StiContainer = null

Gets or sets a container in what rendering of bands is done.

crossFreeSpace

crossFreeSpace: number = 0

Contains a freespace in a container in what the printing is done. Used to output Cross bands only.

denyChangeThread

denyChangeThread: boolean = false

If true then it is impossible to change stream of printing.

denyClearPrintOnAllPagesIgnoreList

denyClearPrintOnAllPagesIgnoreList: boolean = false

Флаг устанавливается во время рендеринга StiBandsOnAllPages для того, чтобы датабэнды, которые выводятся на каждой странице, не обнуляли этот список

denyRenderMasterComponentsInContainer

denyRenderMasterComponentsInContainer: boolean = false

If true then the Render method of a container will not render components of the Master type. This property is used with the RenderSimpleComponents method of a page. It is used to deny master components and render simple ones.

duplilcatesLastValues

duplilcatesLastValues: Hashtable = null

emptyBands

emptyBands: StiEmptyBandsHelper = null

Used to output EmptyBands in the current container.

firstCallNewPage

firstCallNewPage: boolean = false

firstPassPointer

firstPassPointer: StiBookmark

Saved pointer from the first pass of the report rendering. This pointer is requied for rendering the table of contents component.

footersOnAllPages

footersOnAllPages: StiFootersOnAllPages = null

Cotnains a collection of Footers which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.

freeSpace

freeSpace: number = 0

Contains a freespace in a container in what the printing is done.

generateNewColumnBeforeBand

generateNewColumnBeforeBand: boolean = false

generateNewPageBeforeBand

generateNewPageBeforeBand: boolean = false

hashCheckSize

hashCheckSize: Hashtable = null

hashDataBandLastLine

hashDataBandLastLine: Hashtable = new Hashtable()

hashDataSourceReferencesCounter

hashDataSourceReferencesCounter: Hashtable = null

hashParentStyles

hashParentStyles: Hashtable = null

ignoreSkipFirst

ignoreSkipFirst: boolean = false

ignoreUnlimitedHeightForNewPage

ignoreUnlimitedHeightForNewPage: boolean = false

If true then UnlimitedHeight property is ignored when NewPage method is called.

indexOfLatestDataBand

indexOfLatestDataBand: StiIndex = null

indexOfStartList

indexOfStartList: number = 0

indexPageForPageTotal

indexPageForPageTotal: number = -1

isCrossBandsMode

isCrossBandsMode: boolean = false

This property is set to true for printing CrossBands.

isDynamicBookmarksMode

isDynamicBookmarksMode: boolean = false

If true then it is allowed to add any Bookmarks. If false then add Bookmarks of components which the IsRendered property = false (in other words it is rendered first time). This property allows adding Bookmarks for static components only once (to avoid duplication).

isFirstDataBandOnPage

isFirstDataBandOnPage: boolean = false

Returns true if the first DataBand is printed on the current page.

isLastDataBandOnPage

isLastDataBandOnPage: boolean = false

Returns true if the last DataBand is printed on the current page.

keepFirstDetailTogetherList

keepFirstDetailTogetherList: Hashtable = new Hashtable()

Contains a list of stored bands for keepFirstDetailTogether property

keepFirstDetailTogetherTablesList

keepFirstDetailTogetherTablesList: Hashtable = new Hashtable()

lastFreeSpaceOnPageAfterNewList

lastFreeSpaceOnPageAfterNewList: number = 0

lastInvokeTextProcessIndexEventArgsValue

lastInvokeTextProcessIndexEventArgsValue: any = null

lastInvokeTextProcessValueEventArgsValue

lastInvokeTextProcessValueEventArgsValue: any = null

latestProgressValue

latestProgressValue: number = 0

masterEngine

masterEngine: StiEngine = null

If an engine is slave then this reference indicates the parent report engine.

masterReport

masterReport: StiReport = null

Gets or sets a master report that is being rendered in the current moment.

newPageTime

newPageTime: number = Date.now()

offsetNewColumnY

offsetNewColumnY: number = 0

page

page: StiPage = null

Gets or sets a page in what rendering of bands is done.

pageBreakSkipFirstCollection

pageBreakSkipFirstCollection: Hashtable = new Hashtable()

Коллекция служит для определения случая пропуска генерации новой страницы или новой колонки при помощи свойства SkipFirst. Если бэнд уже пропускал один раз генерацию новой страницы или колонки, то он заносится в эту коллекцию.

pageNumbers

pageNumbers: StiPageNumberHelper = null

positionBottomY

positionBottomY: number = 0

Indicates the current position bands output on the Y axis on the bottom of a page.

positionX

positionX: number = 0

Indicates the current position bands output on the X axis.

positionY

positionY: number = 0

Indicates the current position bands output on the Y axis.

printAtBottom

printAtBottom: StiPrintAtBottom = null

Contains a collection of bands which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.

printOnAllPagesIgnoreList

printOnAllPagesIgnoreList: Hashtable = new Hashtable()

Contains the list of bands which should be passed when rendering.

renderState

renderState: StiRenderState = null

report

report: StiReport = null

Gets or sets a report that is being rendered in the current moment.

silentMode

silentMode: boolean = false

skipFirstPageBeforePrintEvent

skipFirstPageBeforePrintEvent: boolean = false

slaveEngines

slaveEngines: Hashtable<string, StiEngine> = new Hashtable()

Contains a list of Slave Engines.

specialContainerHeight

specialContainerHeight: number = 100000000000

specialContainerHeight2

specialContainerHeight2: number = 100000000000 - 100

startIndexPageForPageTotal

startIndexPageForPageTotal: number = -1

staticBands

staticBands: StiStaticBandsHelper = null

An object helps to output static bands on a page.

templateContainer

templateContainer: StiContainer = null

Gets or sets a container from a template. This page is being rendered in the current moment. If a page is output then the TemplateContainer property is equal in TemplatePage.

templatePage

templatePage: StiPage = null

Gets or sets a page from a template. This page is being rendered in the current moment.

threads

threads: StiThreads = null

This object helps to print groups of bands from containers which are placed directly on a page.

Static specialContainerHeight2

specialContainerHeight2: number = 100000000000 - 100

Accessors

hashUseParentStyles

parserConversionStore

  • get parserConversionStore(): Hashtable<string, object[] | any>
  • set parserConversionStore(value: Hashtable<string, object[] | any>): void
  • Returns Hashtable<string, object[] | any>

  • Parameters

    Returns void

Methods

NewPage

  • NewPage(ignoreKeepContainers?: boolean): void
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns void

addContainerToDestination

  • Adds a specified container into the container for output.

    Parameters

    Returns void

addFooterMarker

  • Adds a FooterMarker (special container) into the current container of output. A container-marker is used for the engine to know on what place in a container of output FooterBands for PrintOnAllPages should be replaced after their rendering is complete.

    Parameters

    Returns void

addKeepLevelAtLatestDataBand

  • addKeepLevelAtLatestDataBand(): void
  • Adds a container-marker of the beginning of grouping before the last rendered DataBand.

    Returns void

addLevel

  • addLevel(): void
  • Adds a container-marker of the beginning of grouping into the current position of output in the stream.

    Returns void

addPageToRenderedPages

  • addPageToRenderedPages(page: StiPage): void
  • Parameters

    Returns void

canGenerateNewContainer

checkBreakColumnsContainer

checkForDuplicate

  • checkForDuplicate(textName: string, value: string, tag: string): boolean
  • Parameters

    • textName: string
    • value: string
    • tag: string

    Returns boolean

clearPageBreakSkipFirst

  • clearPageBreakSkipFirst(): void
  • Returns void

finalClear

  • finalClear(): void
  • Returns void

finalClearAsync

  • finalClearAsync(): Promise<void>
  • Returns Promise<void>

finishColumns

finishContainer

finishResetPageNumberContainer

  • finishResetPageNumberContainer(containerForRender: StiContainer, isFinal: boolean): void
  • Parameters

    Returns void

getComponentByNameFromRenderedPage

getSumTagsOnPage

  • getSumTagsOnPage(page: StiPage, componentName: string): number
  • Parameters

    • page: StiPage
    • componentName: string

    Returns number

invokePageAfterPrint

  • invokePageAfterPrint(): void
  • Returns void

newColumn

  • newColumn(ignoreKeepContainers?: boolean): void
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns void

newColumnAsync

  • newColumnAsync(ignoreKeepContainers?: boolean): Promise<void>
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns Promise<void>

newDestination

  • newDestination(ignoreKeepContainers?: boolean): void
  • Parameters

    • Default value ignoreKeepContainers: boolean = false

    Returns void

newDestinationAsync

  • newDestinationAsync(ignoreKeepContainers?: boolean): Promise<void>
  • Parameters

    • Default value ignoreKeepContainers: boolean = false

    Returns Promise<void>

newList

  • newList(skipStaticBands?: boolean): void
  • Parameters

    • Default value skipStaticBands: boolean = false

    Returns void

newListAsync

  • newListAsync(skipStaticBands?: boolean): Promise<void>
  • Parameters

    • Default value skipStaticBands: boolean = false

    Returns Promise<void>

newPage

  • newPage(ignoreKeepContainers?: boolean): void
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns void

newPageAsync

  • newPageAsync(ignoreKeepContainers?: boolean): Promise<void>
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns Promise<void>

newPageAsync2

  • newPageAsync2(ignoreKeepContainers?: boolean): Promise<void>
  • Parameters

    • Default value ignoreKeepContainers: boolean = true

    Returns Promise<void>

processLastPageAfterRendering

  • processLastPageAfterRendering(): void
  • Returns void

processPageAfterRendering

  • processPageAfterRendering(page: StiPage, final: boolean): void
  • Parameters

    Returns void

removeBandFromPageBreakSkipList

  • removeBandFromPageBreakSkipList(pageBreak: IStiPageBreak): void

removeLevel

  • removeLevel(): void
  • Adds a container-marker of the end of grouping into the current position of output in the stream.

    Returns void

renderBand

  • Parameters

    • band: StiBand
    • Default value ignorePageBreaks: boolean = false
    • Default value allowRenderingEvents: boolean = false

    Returns StiComponentsCollection

renderBandAsync

  • Parameters

    • band: StiBand
    • Default value ignorePageBreaks: boolean = false
    • Default value allowRenderingEvents: boolean = false

    Returns Promise<StiComponentsCollection>

renderContainer

  • Parameters

    • container: StiContainer
    • Default value isPrintAtBottom: boolean = false
    • Default value isFooterOnAllPages: boolean = false

    Returns StiContainer

renderContainerAsync

  • renderContainerAsync(container: StiContainer, isPrintAtBottom?: boolean, isFooterOnAllPages?: boolean): Promise<StiContainer>
  • Parameters

    • container: StiContainer
    • Default value isPrintAtBottom: boolean = false
    • Default value isFooterOnAllPages: boolean = false

    Returns Promise<StiContainer>

renderEmptyBands

renderEmptyBandsAsync

renderFootersOnAllPages

  • renderFootersOnAllPages(outContainer: StiContainer, startIndex?: number, REFmarkerContainer?: any): void
  • Parameters

    • outContainer: StiContainer
    • Default value startIndex: number = this.indexOfStartList
    • Default value REFmarkerContainer: any = { ref: null }

    Returns void

renderPrintAtBottom

resetProcessingDuplicates1

  • resetProcessingDuplicates1(componentName: string): void
  • Parameters

    • componentName: string

    Returns void

resetProcessingDuplicates2

setNewPageParameters

  • setNewPageParameters(): void
  • Returns void

Generated using TypeDoc