pspdfkit/com.pspdfkit.configuration.rendering/PageRenderConfiguration

PageRenderConfiguration

open class PageRenderConfiguration

Advanced configuration for page rendering.

Types

Link copied to clipboard
open class Builder
Builder to create a PageRenderConfiguration instance

Properties

Link copied to clipboard
@NonNull
val excludedAnnotations: List<Integer>
Sets the list of annotations (by object numbers) to be excluded from rendering.
Link copied to clipboard
@NonNull
val excludedAnnotationTypes: List<AnnotationType>
Sets the list of annotations (by type) to be excluded from rendering.
Link copied to clipboard
@Nullable
@ColorInt
val formHighlightColor: Integer
Form highlight color, used for highlighting editable form elements.
Link copied to clipboard
@Nullable
@ColorInt
val formItemHighlightColor: Integer
Color of selected items in list boxes and similar.
Link copied to clipboard
@Nullable
@ColorInt
val formRequiredFieldBorderColor: Integer
Color of the border around required form fields.
Link copied to clipboard
val invertColors: Boolean
Invert paper colors if true.
Link copied to clipboard
val paperColor: Int
Background "paper" color of the document.
Link copied to clipboard
val redactionAnnotationPreviewEnabled: Boolean
Redaction annotation preview mode, false by default.
Link copied to clipboard
val regionFullPageHeight: Int
Full height of a page when rendering a region in pixels (view coordinates).
Link copied to clipboard
val regionFullPageWidth: Int
Full width of a page when rendering a region in pixels (view coordinates).
Link copied to clipboard
val regionX: Int
X position of left-top point for rendered region in pixels (view coordinates).
Link copied to clipboard
val regionY: Int
Y position of left-top point for rendered region in pixels (view coordinates).
Link copied to clipboard
val renderedDrawables: List<PdfDrawable>
PdfDrawables to be rendered on a page.
Link copied to clipboard
val renderRegion: Boolean
Determines if rendering only a region of page
Link copied to clipboard
val reuseBitmap: Bitmap
Bitmap to reuse as a rendering target
Link copied to clipboard
val showSignHereOverlay: Boolean
Whether the sign here overlay should be shown.
Link copied to clipboard
@Nullable
@ColorInt
val signHereOverlayBackgroundColor: Integer
Color of the background behind the sign here arrow.
Link copied to clipboard
val toGrayscale: Boolean
Turn paper colors to black and white.
Link copied to clipboard
val useCache: Boolean
Use PSPDFKit memory cache