pdf

The pdf layer displays a PDF file.

Field Configurations

Key	Type	Description	Default Value
"additionalHeaders"	AdditionalHeaders	Additional HTTP headers to send.	null
"allowZoom"	Boolean	Allows zooming in the PDF.	"false"
"errorMessage"	String	Error message to show, if the PDF could not be loaded.	null
"font"	String	Font for error message. Default value varies depending on the OS and settings.	null
"fontColor"	Color	Fontcolor of the error message. Default value varies depending on the OS and settings.	"#000000"
"fontSize"	UnitSize	Font size of error message. Default value varies depending on the OS and settings.	null
"linkEvent"	String	Event to fire if a link is clicked.	null
"linkRegex"	String	Regex groups that match the link will be used as event parameters (Parameter names: group0, group1, ...).	null
"progressBarBackground"	Color	The background color of the progress bar when a pdf is loaded.	null
"progressBarColor"	Color	The color of the progress bar when a pdf is loaded.	null
"scrollDirection"	ScrollDirection	Defines in what direction the pages can be scrolled.	"horizontal"
"value"	String	The URL to the PDF file.	null

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Example 1: Display a PDF file.

Goal: Create a pdf layer that displays a PDF file with enabled zoom and horizontal scrolling.

To achieve this the following code can be used:

{
  "type": "pdf",
  "value": "https://fabrik19.de/wp-content/uploads/2021/07/Produktkatalog-Fabrik19-eGovernment.pdf",
  "scrollDirection": "horizontal",
  "allowZoom": true,
  "classes": [
    "fullSize"
  ]
}

The fields scrollDirection and allowZoom determine how the user can interact with the displayed PDF file.

Result:

A pdf layer with horizontal scrolling and enabled zoom has been created.