Class CounterStore

Constructors

constructor

new CounterStore(documentURLTransformer: DocumentURLTransformer): CounterStore
Parameters
- documentURLTransformer: DocumentURLTransformer
Returns CounterStore
- Defined in counters.ts:670

Properties

countersById

countersById: { [key: string]: CounterValues } = {}

currentPage

currentPage: Page = null

currentPageCounters

currentPageCounters: CounterValues = {}

currentPageCountersStack

currentPageCountersStack: CounterValues[] = []

`Readonly`documentURLTransformer

documentURLTransformer: DocumentURLTransformer

newReferencesOfCurrentPage

newReferencesOfCurrentPage: TargetCounterReference[] = []

pageCountersById

pageCountersById: { [key: string]: CounterValues } = {}

pageIndicesById

pageIndicesById: { [key: string]: { pageIndex: number; spineIndex: number } } = {}

pageTextById

pageTextById: { [key: string]: { [pseudoElement: string]: string } } = {}

previousPageCounters

previousPageCounters: CounterValues = {}

referencesToSolve

referencesToSolve: TargetCounterReference[] = []

referencesToSolveStack

referencesToSolveStack: TargetCounterReference[][] = []

resolvedReferences

resolvedReferences: { [key: string]: TargetCounterReference[] } = {}

unresolvedReferences

unresolvedReferences: { [key: string]: TargetCounterReference[] } = {}

Methods

createCounterListener

createCounterListener(baseURL: string): CounterListener
Parameters
- baseURL: string
Returns CounterListener
- Defined in counters.ts:676

createCounterResolver

createCounterResolver(
    baseURL: string,
    rootScope: LexicalScope,
    pageScope: LexicalScope,
): CounterResolver
Parameters
- baseURL: string
- rootScope: LexicalScope
- pageScope: LexicalScope
Returns CounterResolver
- Defined in counters.ts:680

createLayoutConstraint

createLayoutConstraint(pageIndex: number): Layout.LayoutConstraint
Parameters
- pageIndex: number
Returns Layout.LayoutConstraint
- Defined in counters.ts:1124

finishLastPage

finishLastPage(viewport: Viewport): void
Parameters
- viewport: Viewport
Returns void
- Defined in counters.ts:1080

finishPage

finishPage(spineIndex: number, pageIndex: number): void
Finish the current page; elements with ID are collected and saved with current page-based counter values internally.
Parameters
- spineIndex: number
  Index of the currently laid out spine item
- pageIndex: number
  Index of the currently laid out page in its spine item
Returns void
- Defined in counters.ts:832

forceSetPageCounter

forceSetPageCounter(pageNumber: number): void
Forcefully set the page page-based counter to the specified value.
Parameters
- pageNumber: number
Returns void
- Defined in counters.ts:703

getExprContentListener

getExprContentListener(): Vtree.ExprContentListener
Returns Vtree.ExprContentListener
- Defined in counters.ts:990

getUnresolvedRefsToPage

getUnresolvedRefsToPage(
    page: Page,
): {
    pageCounters: CounterValues;
    pageIndex: number;
    refs: TargetCounterReference[];
    spineIndex: number;
}[]
Returns unresolved references pointing to the specified page.
Parameters
- page: Page
Returns {
    pageCounters: CounterValues;
    pageIndex: number;
    refs: TargetCounterReference[];
    spineIndex: number;
}[]
- Defined in counters.ts:897

popPageCounters

popPageCounters(): void
Restore previously saved page-based counter values.

Returns void
- Defined in counters.ts:779

popReferencesToSolve

popReferencesToSolve(): void
Restore previously saved references to solve.

Returns void
- Defined in counters.ts:958

pushPageCounters

pushPageCounters(counters: CounterValues): void
Save current page-based counters values and set them to the values passed in. The saved counter values can be restored by popPageCounters method.
Parameters
- counters: CounterValues
Returns void
- Defined in counters.ts:771

pushReferencesToSolve

pushReferencesToSolve(refs: TargetCounterReference[]): void
Save current references to solve and set them to the values passed in. The saved references can be restored by popReferencesToSolve method.
Parameters
- refs: TargetCounterReference[]
Returns void
- Defined in counters.ts:950

registerPageCounterExpr

registerPageCounterExpr(
    name: string,
    format: (p1: number[]) => string,
    expr: Val,
): void
Parameters
- name: string
- format: (p1: number[]) => string
- expr: Val
Returns void
- Defined in counters.ts:962

registerTargetCounterExpr

registerTargetCounterExpr(
    name: string,
    format: (p1: number) => string,
    expr: Val,
    transformedId: string,
): void
Parameters
- name: string
- format: (p1: number) => string
- expr: Val
- transformedId: string
Returns void
- Defined in counters.ts:973

registerTargetTextExpr

registerTargetTextExpr(
    pseudoElement: string,
    expr: Val,
    transformedId: string,
): void
Parameters
- pseudoElement: string
- expr: Val
- transformedId: string
Returns void
- Defined in counters.ts:982

resolveReference

resolveReference(id: string): void
Resolve a reference with the specified ID.
Parameters
- id: string
Returns void
- Defined in counters.ts:786

saveReferenceOfCurrentPage

saveReferenceOfCurrentPage(id: string, resolved: boolean): void
Save a reference appeared in the current page.
Parameters
- id: string
- resolved: boolean
  If the reference is already resolved or not.
Returns void
- Defined in counters.ts:819

setCurrentPage

setCurrentPage(page: Page): void
Parameters
- page: Page
Returns void
- Defined in counters.ts:688

updatePageCounters

updatePageCounters(cascadedPageStyle: ElementStyle, context: Context): void
Update the page-based counters with 'counter-reset' and 'counter-increment' properties within the page context. Call before starting layout of the page.
Parameters
- cascadedPageStyle: ElementStyle
- context: Context
Returns void
- Defined in counters.ts:717