Interface: AttachmentInfo<Params>
ghostly-runtime.AttachmentInfo
Metadata about an attachment.
Type parameters
| Name | Type |
|---|---|
Params | unknown |
Hierarchy
View<Params>↳
AttachmentInfo
Properties
contentType
• contentType: string
The view's type (for instance, text/html or application/pdf).
Inherited from
Defined in
ghostly-runtime/src/types.ts:73
description
• Optional description: string
An optional description of the attachment.
Defined in
ghostly-runtime/src/types.ts:99
dpi
• Optional dpi: number
The resolution be used when rendering the view. Used for viewport size calculations.
Inherited from
Defined in
ghostly-runtime/src/types.ts:79
htmlTransforms
• Optional htmlTransforms: HTMLTransform[]
An array of transformations to apply when producing HTML results. Defaults to [ 'inline', 'noscript',
'minimize' ].
Inherited from
Defined in
ghostly-runtime/src/types.ts:90
name
• name: string
The name of the attachment (including file extension).
Defined in
ghostly-runtime/src/types.ts:96
paperSize
• Optional paperSize: PaperSize
The paper size to be used when rendering documents.
Inherited from
Defined in
ghostly-runtime/src/types.ts:82
params
• Optional params: Params
Optional view params.
Inherited from
Defined in
ghostly-runtime/src/types.ts:76
viewportSize
• Optional viewportSize: ViewportSize
The size of the viewport to use, in pixels. Will be calculated from dpi and paperSize, if not provided.