> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/podglad-pdf-pdfviewer.md).

# Podgląd PDF - PdfViewer

{% hint style="info" %}
Dostępność funkcjonalności zależy od licencji i może nie być dostępna we wszystkich wdrożeniach.
{% endhint %}

Komponent umożliwia wyświetlenie dokumentu PDF bezpośrednio na formularzu. Dokument może być wskazany adresem URL (ścieżką do pliku dostępnego na środowisku lub adresem zewnętrznego zasobu) albo identyfikatorem dokumentu w źródle zewnętrznym, z którego platforma pobiera dokument po stronie serwera. Pozwala to użytkownikowi na zapoznanie się z treścią (np. regulaminem, umową lub instrukcją) bez konieczności pobierania pliku na dysk czy otwierania nowej karty w przeglądarce.

![](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-51026b7b518a157ff219cd1c7b23a1cde66e09cd%2FpdfViewer5.png?alt=media)

✅ **Kiedy stosować:**

* Wyświetlanie pojedynczego dokumentu PDF bezpośrednio na formularzu.

:x: **Kiedy nie stosować:**

* Prezentowanie listy dokumentów lub umożliwienie ich pobierania. Stosuj: [DocumentList](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/lista-dokumentow-documentlist.md).
* Udostępnienie użytkownikowi linku do dokumentu lub innego zasobu bez wyświetlania jego treści na formularzu. Stosuj: [ExternalLink](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/0-struktura-i-nawigacja/nawigacja/link-externallink.md).

## Komponent czytnika PDF

![Ilustracja 1. Przykładowy wygląd komponentu na formularzu](https://content.gitbook.com/content/2CssJT0zIo4SJQLbSZ6l/blobs/5huZzcoz1hG3JYZMcugp/18k_files/image2025-5-23_8-38-27.png)

### Właściwości komponentu

| Właściwości Eximee Designer                                                                            | Nazwa atrybutu w Źródle | Opis                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p><strong>Źródło dokumentu</strong><br>(sekcja <strong>Podstawowe właściwości</strong>)</p>           | documentSource          | <p>Określa, skąd komponent pobiera dokument: <strong>Bezpośredni URL</strong> (domyślnie) oznacza adres z pola <strong>Link do pdf</strong>, a każda kolejna opcja to źródło zewnętrzne skonfigurowane w instalacji, z którego dokument jest pobierany po identyfikatorze z pola <strong>Identyfikator dokumentu</strong>.</p><p>Przy wybranym <strong>Bezpośredni URL</strong> atrybut nie jest zapisywany w Źródle.</p><p>Pole jest widoczne tylko wtedy, gdy w instalacji skonfigurowano co najmniej jedno źródło zewnętrzne (patrz sekcja <strong>Dokument ze źródła zewnętrznego</strong>).</p>                                                                                                                                                         |
| <p><strong>Identyfikator dokumentu</strong><br>(sekcja <strong>Podstawowe właściwości</strong>)</p>    | externalDocumentId      | <p>Identyfikator dokumentu w źródle wybranym w polu <strong>Źródło dokumentu</strong>. Może zawierać odwołanie do zmiennej sesyjnej, np. <code>${documentId}</code>.</p><p>Pole jest widoczne, gdy w polu <strong>Źródło dokumentu</strong> wybrano źródło zewnętrzne.</p><p>Pusty identyfikator nie powoduje błędu: komponent nic nie wyświetla, a wniosek działa dalej.</p>                                                                                                                                                                                                                                                                                                                                                                                |
| <p><strong>Link do pdf</strong><br>(sekcja <strong>Podstawowe właściwości</strong>)</p>                | pdfUrl                  | <p>Względna ścieżka do pliku umieszczonego w folderze na środowisku, bądź też link zewnętrzny, jednakże musi on wtedy spełniać wymagania polityki CORS (odpowiednio ustawiony nagłówek Access-Control-Allow-Origin).</p><p>Domyślnie właściwość jest ustawiona na pustą.</p><p><strong>Ważne:</strong> Wprowadzenie niepoprawnego URL bądź niewprowadzenie go w ogóle powoduje błąd i uniemożliwia wypełnianie wniosku po próbie wyświetlenia pliku PDF.</p><p>Pole jest widoczne, gdy w polu <strong>Źródło dokumentu</strong> wybrano <strong>Bezpośredni URL</strong>. Po wybraniu źródła zewnętrznego pole jest ukryte, a wpisany adres zostaje w definicji komponentu i pojawia się ponownie po powrocie do opcji <strong>Bezpośredni URL</strong>.</p> |
| <p><strong>Wysokość okna dokumentu - desktop (vh)</strong><br>(sekcja <strong>Stylizacja</strong>)</p> | desktopHeight           | <p>Wysokość okna dokumentu na komputerze i tablecie w procentach wysokości okna przeglądarki (jednostka vh), od 0 do 100.</p><p>Domyślnie 0, czyli wysokość określona w szacie graficznej.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| <p><strong>Wysokość okna dokumentu - mobile (vh)</strong><br>(sekcja <strong>Stylizacja</strong>)</p>  | mobileHeight            | <p>Wysokość okna dokumentu na telefonie w procentach wysokości okna przeglądarki (jednostka vh), od 0 do 100.</p><p>Domyślnie 0, czyli wysokość określona w szacie graficznej.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

> Więcej informacji o właściwościach komponentu: [Wspólne właściwości komponentów](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/praca-z-komponentami-bazowymi/wspolne-wlasciwosci-komponentow.md)

### Dokument z adresu URL

Gdy w polu **Źródło dokumentu** jest wybrany **Bezpośredni URL** (albo pole nie jest widoczne, bo w instalacji nie skonfigurowano źródeł zewnętrznych), adres pliku PDF skonfiguruj w polu **Link do pdf** w panelu właściwości komponentu. Wartość ta może zostać wpisana bezpośrednio jako statyczny link lub przekazana dynamicznie za pomocą zmiennej.

1. Ścieżka do pliku dostępnego na środowisku

   Polega na podaniu ścieżki do statycznego zasobu umieszczonego bezpośrednio w strukturze katalogów serwera aplikacji.

   ![Ilustracja 2. Konfiguracja komponentu przy użyciu ścieżki lokalnej](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-e606274a42a7c2c9afe1f45c1056b2285fcb3477%2FpdfViewer.png?alt=media)
2. Zewnętrzny adres URL

   Polega na podaniu bezwzględnego adresu URL do pliku. Zewnętrzny serwer musi jednak zezwalać na pobieranie pliku przez przeglądarkę z poziomu aplikacji, zgodnie z polityką CORS.

   ![Ilustracja 3. Konfiguracja komponentu przy użyciu zewnętrznego adresu URL](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-5be1fb09d37bc07df07540326db191f4b3b0e466%2FpdfViewer3.png?alt=media)

{% hint style="info" %}
CORS to mechanizm bezpieczeństwa w przeglądarkach internetowych. Blokuje on pobieranie zasobów (np. plików PDF) z innej domeny niż ta, na której znajduje się formularz, chyba że serwer docelowy jawnie wyrazi na to zgodę, wysyłając odpowiedni nagłówek HTTP (`Access-Control-Allow-Origin`).
{% endhint %}

3. Zasilenie komponentu wartością zmiennej sesyjnej

   Adres pliku PDF może zostać zasilony dynamicznie wartością zmiennej sesyjnej. W polu `Link do pdf` można użyć odwołania do zmiennej (np. `${pdfUrl}`), która będzie zasilana wartością pochodzącą ze skryptu bądź usługi.

   ![Ilustracja 4. Konfiguracja komponentu przy użyciu zmiennej sesyjnej](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-8849b1aec658b56fb59541f6a75ee8391b023275%2FpdfViewer2.png?alt=media)

   ![Ilustracja 5. Zmienna sesyjna zasilona wartością ze skryptu](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-7c87458adf9b215317618b6009c805c1ca4d9c00%2FpdfViewer4.png?alt=media)

{% hint style="info" %}
W przypadku zasilenia komponentu zmienną sesyjną pamiętaj o dodaniu nasłuchiwania na tę zmienną.
{% endhint %}

{% hint style="info" %}
Należy pamiętać, że wartość zmiennej sesyjnej użytej w polu `Link do pdf` nie może być pusta — w przeciwnym razie wniosek nie będzie działał poprawnie po próbie wyświetlenia komponentu.
{% endhint %}

### Dokument ze źródła zewnętrznego

Źródło zewnętrzne to system, w którym przechowywane są dokumenty, na przykład repozytorium dokumentów organizacji. Dokument wskazujesz identyfikatorem, jaki ma w tym źródle, a platforma pobiera go po stronie serwera przez integrację ze źródłem działającą w instalacji.

Aby wyświetlić dokument ze źródła zewnętrznego:

1. Zaznacz komponent i w panelu właściwości, w sekcji **Podstawowe właściwości**, w polu **Źródło dokumentu** wybierz źródło.
2. W polu **Identyfikator dokumentu** wprowadź identyfikator dokumentu wprost albo jako odwołanie do zmiennej sesyjnej, np. `${documentId}`.
3. Jeśli identyfikator pochodzi ze zmiennej sesyjnej, w sekcji **Interakcje** w polu **Nasłuchiwania** dodaj tę zmienną. Bez nasłuchiwania komponent może zostać wyświetlony, zanim zmienna dostanie wartość, i nie odświeży się po jej nadaniu. Więcej w: [Nasłuchiwanie i czyszczenie](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/dynamicznosc-formularza/nasluchiwanie-i-czyszczenie.md).

Przykład: usługa strony generuje dokument, zapisuje go w źródle zewnętrznym i zwraca jego identyfikator. Wynik usługi zasila zmienną sesyjną `documentId`, a komponent ma ustawione:

* **Źródło dokumentu**: źródło, w którym usługa zapisała dokument,
* **Identyfikator dokumentu**: `${documentId}`,
* **Nasłuchiwania**: `documentId`.

Po wejściu na stronę komponent wyświetla wygenerowany dokument. W Źródle wniosku komponent wygląda następująco (`repozytoriumDokumentow` to przykładowa nazwa źródła):

```xml
<p1:GesPdfViewer id="GesPdfViewer1" mid="GesPdfViewer1" documentSource="repozytoriumDokumentow" externalDocumentId="${documentId}">
```

Działanie komponentu ze źródłem zewnętrznym:

* Dokument jest pobierany ze źródła przy każdym wyświetleniu i nie jest przechowywany przez platformę.
* Identyfikator dokumentu nie jest przekazywany do przeglądarki. Przeglądarka dostaje tylko odnośnik do bieżącego dokumentu komponentu, więc nie da się nim pobrać innego dokumentu ze źródła.
* Po zmianie identyfikatora, na przykład po nadaniu zmiennej sesyjnej nowej wartości, komponent wczytuje nowy dokument.
* Gdy identyfikator jest pusty, komponent nic nie wyświetla i nie pobiera dokumentu, a wniosek działa dalej. Dokument pojawia się, gdy identyfikator dostanie wartość.
* Błąd źródła, brak dokumentu w źródle albo wybór źródła, z którym instalacja nie ma integracji, przenoszą wniosek na stronę błędu, tak samo jak błędny adres URL.
* Wymagania polityki CORS nie dotyczą dokumentu ze źródła zewnętrznego, bo przeglądarka pobiera go z serwera wniosku.

{% hint style="info" %}
Listę źródeł w polu **Źródło dokumentu** określa konfiguracja Designera: klucz `eximee.console.pdf-viewer.document-sources` zawiera nazwy źródeł rozdzielone przecinkami. Środowisko może nadpisać tę listę zmienną środowiskową `EXIMEE_CONSOLE_PDF_VIEWER_DOCUMENT_SOURCES`. Gdy lista jest pusta, pola **Źródło dokumentu** i **Identyfikator dokumentu** są ukryte. Źródło działa tylko w instalacji, w której jest dostępna integracja z tym źródłem.

```properties
eximee.console.pdf-viewer.document-sources=repozytoriumDokumentow
```

{% endhint %}

### Wysokość okna dokumentu

Domyślnie okno dokumentu ma wysokość określoną w szacie graficznej. Aby ustawić inną wysokość dla jednego komponentu, w panelu właściwości, w sekcji **Stylizacja**, wprowadź wartość w polu **Wysokość okna dokumentu - desktop (vh)**, **Wysokość okna dokumentu - mobile (vh)** albo w obu.

* Wartość to procent wysokości okna przeglądarki (jednostka vh), od 0 do 100. Wartość 0 oznacza wysokość z szaty graficznej.
* Pole pokazuje 0, dopóki nie ustawisz wysokości. Wyczyszczone pole zapisuje 0.
* Wartość spoza zakresu jest odrzucana z komunikatem, a pole wraca do poprzedniej wartości.
* Wysokość ustawiona tylko dla jednego rodzaju urządzenia nie zmienia wysokości drugiego.
* Wysokość mobile jest używana, gdy wniosek otwarto na telefonie. Telefon jest rozpoznawany po przeglądarce, a komputer i tablet używają wysokości desktop. Szerokość okna przeglądarki nie zmienia tego wyboru, więc samo zwężenie okna nie przełącza komponentu na wysokość mobile. Aby sprawdzić wysokość mobile na komputerze, włącz w narzędziach deweloperskich przeglądarki emulację telefonu i przeładuj stronę wniosku.

Przykład: okno dokumentu zajmuje 60% wysokości okna przeglądarki na komputerze i 80% na telefonie.

1. W polu **Wysokość okna dokumentu - desktop (vh)** wprowadź `60`.
2. W polu **Wysokość okna dokumentu - mobile (vh)** wprowadź `80`.

W Źródle wniosku komponent wygląda następująco:

```xml
<p1:GesPdfViewer id="GesPdfViewer1" mid="GesPdfViewer1" pdfUrl="dokumenty/regulamin.pdf" desktopHeight="60" mobileHeight="80">
```

{% hint style="info" %}
Wnioski demo: demoPdfViewer
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/podglad-pdf-pdfviewer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
