VMPrint API Reference - v1.0.0
GitHub
Examples
Preparing search index...
@vmprint/preview
PreviewSession
Type Alias PreviewSession
type
PreviewSession
=
{
destroy
()
:
void
;
exportPdf
()
:
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
;
exportSvgPage
(
pageIndex
:
number
,
options
?:
SvgExportOptions
,
)
:
Promise
<
string
>
;
exportSvgPages
(
options
?:
SvgExportOptions
)
:
Promise
<
string
[]
>
;
getPageCount
()
:
number
;
getPageSize
()
:
{
height
:
number
;
width
:
number
}
;
isDestroyed
()
:
boolean
;
renderPageToCanvas
(
pageIndex
:
number
,
target
:
CanvasTarget
,
options
?:
RenderPageToCanvasOptions
,
)
:
Promise
<
void
>
;
updateDocument
(
nextDocumentInput
:
unknown
)
:
Promise
<
void
>
;
}
Index
Methods
destroy
export
Pdf
export
Svg
Page
export
Svg
Pages
get
Page
Count
get
Page
Size
is
Destroyed
render
Page
To
Canvas
update
Document
Methods
destroy
destroy
()
:
void
Returns
void
export
Pdf
exportPdf
()
:
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
Returns
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
export
Svg
Page
exportSvgPage
(
pageIndex
:
number
,
options
?:
SvgExportOptions
)
:
Promise
<
string
>
Parameters
pageIndex
:
number
Optional
options
:
SvgExportOptions
Returns
Promise
<
string
>
export
Svg
Pages
exportSvgPages
(
options
?:
SvgExportOptions
)
:
Promise
<
string
[]
>
Parameters
Optional
options
:
SvgExportOptions
Returns
Promise
<
string
[]
>
get
Page
Count
getPageCount
()
:
number
Returns
number
get
Page
Size
getPageSize
()
:
{
height
:
number
;
width
:
number
}
Returns
{
height
:
number
;
width
:
number
}
is
Destroyed
isDestroyed
()
:
boolean
Returns
boolean
render
Page
To
Canvas
renderPageToCanvas
(
pageIndex
:
number
,
target
:
CanvasTarget
,
options
?:
RenderPageToCanvasOptions
,
)
:
Promise
<
void
>
Parameters
pageIndex
:
number
target
:
CanvasTarget
Optional
options
:
RenderPageToCanvasOptions
Returns
Promise
<
void
>
update
Document
updateDocument
(
nextDocumentInput
:
unknown
)
:
Promise
<
void
>
Parameters
nextDocumentInput
:
unknown
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
destroy
export
Pdf
export
Svg
Page
export
Svg
Pages
get
Page
Count
get
Page
Size
is
Destroyed
render
Page
To
Canvas
update
Document
GitHub
Examples
VMPrint API Reference - v1.0.0
Loading...