Class TargetCounterReference

Class representing a reference by target-counter(s).

Param: targetId

ID of the referenced element (transformed by DocumentURLTransformer to handle a reference across multiple source documents)

Param: resolved

If the reference is already resolved or not

Index

Constructors

Properties

pageCounters pageIndex resolved spineIndex targetId

Methods

equals isResolved resolve unresolve

Constructors

constructor

new TargetCounterReference(
targetId: string,
resolved: boolean,
): TargetCounterReference
Parameters
- targetId: string
- resolved: boolean
Returns TargetCounterReference
- Defined in src/vivliostyle/counters.ts:123

Properties

pageCounters

pageCounters: CounterValues = null

pageIndex

pageIndex: number = -1

resolved

resolved: boolean

spineIndex

spineIndex: number = -1

`Readonly`targetId

targetId: string

Methods

equals

equals(other: TargetCounterReference): boolean
Parameters
- other: TargetCounterReference
Returns boolean
- Defined in src/vivliostyle/counters.ts:128

isResolved

isResolved(): boolean
Returns if the reference is resolved or not.

Returns boolean
- Defined in src/vivliostyle/counters.ts:146

resolve

resolve(): void
Marks that this reference is resolved.

Returns void
- Defined in src/vivliostyle/counters.ts:153

unresolve

unresolve(): void
Marks that this reference is unresolved.

Returns void
- Defined in src/vivliostyle/counters.ts:160