VMPrint API Reference - v1.0.0
GitHub
Examples
Preparing search index...
@vmprint/engine
SimulationReportReader
Type Alias SimulationReportReader
type
SimulationReportReader
=
{
actorCount
:
number
;
generatedBoxCount
:
number
;
pageCount
:
number
;
profile
:
LayoutProfileMetrics
|
undefined
;
progression
:
SimulationProgressionSummary
|
undefined
;
report
:
SimulationReport
|
null
|
undefined
;
splitTransitionCount
:
number
;
get
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
,
)
:
SimulationArtifactMap
[
K
]
|
undefined
;
has
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
)
:
boolean
;
require
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
,
)
:
NonNullable
<
SimulationArtifactMap
[
K
]
>
;
}
Index
Properties
actor
Count
generated
Box
Count
page
Count
profile
progression
report
split
Transition
Count
Methods
get
has
require
Properties
Readonly
actor
Count
actorCount
:
number
Readonly
generated
Box
Count
generatedBoxCount
:
number
Readonly
page
Count
pageCount
:
number
Readonly
profile
profile
:
LayoutProfileMetrics
|
undefined
Readonly
progression
progression
:
SimulationProgressionSummary
|
undefined
Readonly
report
report
:
SimulationReport
|
null
|
undefined
Readonly
split
Transition
Count
splitTransitionCount
:
number
Methods
get
get
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
,
)
:
SimulationArtifactMap
[
K
]
|
undefined
Type Parameters
K
extends
keyof
SimulationArtifactMap
Parameters
key
:
K
Returns
SimulationArtifactMap
[
K
]
|
undefined
has
has
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
)
:
boolean
Type Parameters
K
extends
keyof
SimulationArtifactMap
Parameters
key
:
K
Returns
boolean
require
require
<
K
extends
keyof
SimulationArtifactMap
>
(
key
:
K
,
)
:
NonNullable
<
SimulationArtifactMap
[
K
]
>
Type Parameters
K
extends
keyof
SimulationArtifactMap
Parameters
key
:
K
Returns
NonNullable
<
SimulationArtifactMap
[
K
]
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
actor
Count
generated
Box
Count
page
Count
profile
progression
report
split
Transition
Count
Methods
get
has
require
GitHub
Examples
VMPrint API Reference - v1.0.0
Loading...