Dokumentacja Orbitvu

Lista parametrów ORBITVU VIEWER

Wszystkie parametry osadzania ORBITVU VIEWER wraz z dopuszczalnymi wartościami, wartościami domyślnymi i wersją, w której zostały wprowadzone.

auto_drag_switch

Określa, czy ORBITVU VIEWER ma automatycznie przełączać się w tryb drag przy zoomie. Ustawienie no sprawia, że ORBITVU VIEWER działa w trybie rotate.

Wersja: 2.3.32+

Wartości: yes | no

Domyślnie: yes

auto_rotate_dir

Kierunek automatycznego obrotu

Wartości: left | right

Domyślnie: rotate_dir

background_color

Kolor tła

Domyślnie: 0xffffff (biały)

Przykład: 0xFFFFFF8C

Wartość ma postać 0x<hex>, gdzie <hex> to kolor w zapisie szesnastkowym.

FFFFFF = kolor biały; dwie ostatnie pozycje określają krycie koloru tła [8C = 55% krycia];

border

Obramowanie okna VIEWER-a

Wartości: yes | no

Domyślnie: yes

border_color

Kolor obramowania

Domyślnie: 0xffffff (biały)

border_frame

Określa klatkę graniczną, której nie można przekroczyć, gdy continuous jest ustawione na no. Przy continous=no i teaser=autorotate prezentacja będzie odbijać się od border_frame.

Wartości: 1 – <liczba klatek>

Wersja: 3.6.2+

branding

Tekst wyświetlany w prawym górnym rogu obszaru VIEWER-a. Powiązany z parametrem branding_url

Wartość: dowolny tekst

branding_url

Adres URL strony, na którą użytkownik zostanie przekierowany po kliknięciu przycisku brandingu (powiązany z parametrem branding)

btn_autorotate

Określa, czy przycisk automatycznego obrotu jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

btn_drag_rotate

Określa, czy przycisk drag/rotate jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

btn_fullscreen

Określa, czy przycisk fullscreen jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

btn_info

Określa, czy przycisk info jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

btn_zoom_in

Określa, czy przycisk przybliżania jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

btn_zoom_out

Określa, czy przycisk oddalania jest widoczny (yes), czy ukryty (no)

Wartości: yes | no

Domyślnie: yes

Wersja: 3.7.0+

buttons_type

Typ przycisków wyświetlanych w VIEWER-ze. Są dwa typy: przyciski desktop i przyciski mobile. Te drugie są zaprojektowane z myślą o urządzeniach mobilnych, więc nie ma wśród nich przycisków zoom in/zoom out (do zoomu służy gest pinch) ani przełącznika drag/rotate, bo przesuwać można dwoma palcami, a obracać jednym itd. Inny jest też układ przycisków mobilnych. Wartość auto spowoduje automatyczny wybór przycisków mobilnych na urządzeniach mobilnych.

Wartości: auto | desktop | mobile

Domyślnie: auto

Wersja: 3.1.1 +

config_url

Adres URL pliku config.xml

Domyślnie: <ovus_folder>/config.xml

content2

Określa, czy ma być używany plik konfiguracyjny content.xml, czy content2.xml. Jeśli nie masz bardzo starych prezentacji, zawsze ustawiaj yes.

Wartości: yes | no

Domyślnie:no

Jeśli nie masz pewności, czy ustawić yes, czy no, sprawdź katalog prezentacji — jeśli zawiera plik content2.xml, użyj yes.

continous

Ciągły obrót – przydatne przy półobrotach lub animacjach

Wartości: yes | no

Domyślnie: yes

disable_nosize

Jeśli ORBITVU VIEWER jest inicjowany bez określonej wysokości, a element go zawierający ma wysokość 0px, to domyślnie ORBITVU VIEWER przyjmie wysokość 56,25% (proporcja 16:9). Możesz wyłączyć to zachowanie, ustawiając disable_nosize na yes.

Wartości: yes | no

Domyślnie:no

doubletap_mode

Po dwukrotnym dotknięciu ORBITVU VIEWER może:

fullscreen – przełączyć się w tryb pełnoekranowy

zoom – przybliżyć/oddalić, zależnie od bieżącego poziomu zoomu

disabled – nie robić nic

Wartości: fullscreen | zoom | disabled

Domyślnie: fullscreen

dynamic_avif_webp_ext

W prezentacjach 360 stopni tworzonych w nowszych wersjach Orbitvu Station lub pobranych z Orbitvu SUN zdjęcia mogą być dostarczane w formatach AVIF i WebP. Dostępne formaty sprawdzisz, przeglądając folder ze zdjęciami ov. AVIF jest szeroko obsługiwany przez nowoczesne przeglądarki, ale część starszych przeglądarek nie potrafi wyświetlać zdjęć AVIF. W takich przypadkach, jeśli opcja dynamic_avif_webp_ext jest włączona, Orbitvu Viewer automatycznie wykryje brak obsługi AVIF i zażąda zdjęć w formacie WebP. Ta funkcja działa tylko dla prezentacji zawierających zarówno wersje AVIF, jak i WebP zdjęć.

Wartości: yes | no Domyślnie: no

external_access_init

Ten parametr jest PRZESTARZAŁY — użyj zamiast niego viewer_api_init!

Nazwa funkcji zwrotnej JavaScript, która zostanie wywołana po inicjalizacji ORBITVU VIEWER.

Do funkcji zwrotnej przekazywany jest obiekt API.

Domyślnie: nie ustawiono

Wartością tego parametru powinien być ciąg znaków, a nie sama funkcja.

W wersjach Infinity360 i FREE ORBITVU VIEWER można uzyskać programowy dostęp do jego metod. Szczegóły znajdziesz w dokumentacji API.

W VIEWER-ze w wersji 2.3.33+ używaj viewer_api_init zamiast external_access_init

first_frame

Pierwsza wyświetlana klatka

Wartości: 1 – liczba klatek

Domyślnie: 1

first_row

Pierwszy wyświetlany wiersz w prezentacji 3D

Wersja: 2.3.31+

Wartości: 1 – liczba wierszy

Domyślnie:1

force_html5

Nieobsługiwany. Ten parametr wymuszał tryb HTML5 w VIEWER-ze z czasów Flasha. Został usunięty w wersji 3.5.0 — od tamtej pory HTML5 jest jedynym trybem renderowania. Pozostawienie go w embed code nie powoduje żadnych problemów.

frame_rate

Prędkość automatycznego obrotu [klatki/s]

Domyślnie: 12

fullscreen_enabled

Pozwala wyłączyć tryb fullscreen (wartość no). Powoduje to również ukrycie przycisku fullscreen

Wartości: yes | no

Domyślnie: yes

gui_background

Kolor tła elementów GUI, takich jak przyciski czy loader.

Przykład: 0x00ff00

Wartość ma postać 0x<hex>, gdzie <hex> to kolor w zapisie szesnastkowym.

gui_foreground

Kolor pierwszego planu elementów GUI, takich jak przyciski czy loader

Przykład: 0x00ff00

Wartość ma postać 0x<hex>, gdzie <hex> to kolor w zapisie szesnastkowym.

gui_foreground_active

Kolor pierwszego planu aktywnych (np. klikanych) elementów GUI, takich jak przyciski

Przykład: 0x00ff00

height

Wysokość prezentacji

Wartości: liczba całkowita lub ‘auto’

Domyślnie: 300

Liczba całkowita jest podawana w pikselach; auto oznacza 100%

Jeśli użyto auto, a element kontenera, do którego wstawiany jest VIEWER, ma wysokość 0, to height zostanie ustawione w proporcji 16 : 9 względem szerokości VIEWER-a

hires_support

Włącza lub wyłącza obsługę wyświetlaczy o wysokiej rozdzielczości, np. Retina. Zwróć uwagę, że prezentacje w niższych rozdzielczościach mogą wyglądać na takich ekranach na mniejsze ze względu na większą gęstość pikseli.

Wersja: 3.6.4

Wartości: yes | no

Domyślnie: yes

hires_forced_zoom

Wymusza większy zoom na urządzeniach z wyświetlaczami o wysokiej rozdzielczości, np. Retina. Zdjęcia są skalowane w górę, co może powodować utratę jakości.

Wersja: 3.6.5

Wartości: yes | no

Domyślnie: no

html5_hint

VIEWER może wyświetlać małą infografikę ilustrującą możliwość obracania w jednej (360°) lub dwóch (3D) osiach. Infografika znika podczas każdej interakcji z VIEWER-em. Pojawia się ponownie z 5-sekundowym opóźnieniem./pl/viewer/embedding-with-orbitvu-sun-embed-codes

Wersja: 2.3.21+

Wartości: yes | no

Domyślnie: no

html5_initial_info

Możesz wymusić na VIEWER-ze wyświetlenie okna informacyjnego na starcie. Okno prezentuje prostą infografikę ilustrującą możliwe akcje dotykowe/myszą do sterowania VIEWER-em. Okno można pokazywać tylko na urządzeniach dotykowych (wartość touch), tylko na komputerach (wartość desktop) albo na jednych i drugich (wartość all). Zobacz przykład

Wersja: 2.3.18+

Wartości: no | desktop | touch | all

Domyślnie: no

image_folder

Adres URL folderu ze zdjęciami dla prezentacji 360 stopni

Domyślnie: <ovus_folder>/images/

lang

Język podpowiedzi (tooltipów).

Wartości: cs (czeski) | de (niemiecki) | da (duński) | en (angielski) | es (hiszpański) | fi (fiński) | fr (francuski) | fy (fryzyjski) | hu (węgierski) | it (włoski) | ja (japoński) | lt (litewski) | nl (niderlandzki) | no (norweski) | pl (polski) | pt (portugalski) | ro (rumuński) | ru (rosyjski) | se (szwedzki) | sk (słowacki) | sl (słoweński) | sr (serbski) | _ (bez podpowiedzi) | auto

Domyślnie: en

Uwagi: da i ja są dostępne od wersji 3.6.1. Starsze wydania używały dk dla duńskiego. Auto jest dostępne od wersji 3.8.0.

lazy_partial_load

partial_load rozpoczyna się po interakcji użytkownika.

Wersja: 3.8.0+

Wartości: yes | no

Jeśli opcja "teaser" jest ustawiona na autorotate, lazy_partial_load jest automatycznie wyłączany.

loader

Pokazuje lub ukrywa loader widoczny podczas inicjalizacji VIEWER-a

Wersja: 2.3.33+

Wartości: yes | no

logo_src

Link do obrazka wyświetlanego w lewym górnym rogu obszaru VIEWER-a, np. przycisku Buy. Powiązany z parametrem logo_url

logo_url

Adres URL strony, na którą użytkownik zostanie przekierowany po kliknięciu obrazka logo (określonego parametrem logo_src)

max_scale

Maksymalna możliwa skala zoomu prezentacji.

Wartości: 0 – 1

Przykład: 0.28

Domyślnie: nie ustawiono

Jak obliczyć skalę:

Jeśli maksymalny rozmiar prezentacji to 5448px x 3607px, weź większą wartość (5448) i pożądaną wartość maksymalną (np. 100px). Podziel je, aby uzyskać max_scale: 100/5448=0,0184100

Wartość 0 jest szczególna. Powoduje użycie skali początkowej (najlepiej dopasowanej do kontenera prezentacji). W efekcie prezentacja wyświetla się normalnie, ale nie można jej przybliżać.

mousewheel

Włącza (yes) lub wyłącza (no) zoom kółkiem myszy

Wartości: yes | no

Domyślnie: yes

Wersja: 2.3.24+

Istnieją metody API pozwalające przełączać ten parametr dynamicznie: enable_mousewheel i disable_mousewheel.

nosize_ratio

Pozwala ustawić własne proporcje VIEWER-a, gdy jego kontener nie ma wymiarów, a parametry "width" i "height" są ustawione na auto.

Wartości: n/n

Przykład: 4/3

Domyślnie: 16/9

Wersja: 3.8.0+

ovskin

Pokazuje identyfikację ORBITVU (w okienku info)

Wartości: yes | no

Domyślnie: no

ovus_folder

Adres URL folderu prezentacji ORBITVU (zawierającego rozpakowany plik .OVUS)

Domyślnie: folder BASE – domyślny adres URL strony HTML, który można określić znacznikiem <base>

partial_load

Po włączeniu Orbitvu VIEWER będzie gotowy na interakcję z użytkownikiem, gdy tylko załadują się 4 początkowe klatki. Pozostałe klatki doładuje w tle.

Domyślnie: no

Wersja: 3.0.30+

Wartości: yes | no

Jeśli opcja "teaser" jest ustawiona na: onerotation, onerotationslow, playonerotation lub playonerotationslow, partial_load jest automatycznie wyłączany.

preload_width

Wymusza szerokość wstępnie ładowanych zdjęć. Domyślnie początkowo ładowane zdjęcia dopasowują się do rozmiaru kontenera VIEWER-a, a przy przybliżaniu doczytywane są większe. Dzięki tej opcji możesz od razu załadować większe zdjęcia, co może poprawić jakość prezentacji np. podczas obracania po przejściu w tryb fullscreen (z małego kontenera początkowego).

Maksymalna dopuszczalna szerokość wstępnie ładowanego zdjęcia to 1024px, więc ustawienie wartości większej niż 1024 działa tak samo jak 1024.

Domyślnie: 0 Przykład: 700 Wartość maksymalna: 1024

preload_height

Wymusza wysokość wstępnie ładowanych zdjęć. Domyślnie początkowo ładowane zdjęcia dopasowują się do rozmiaru kontenera VIEWER-a, a przy przybliżaniu doczytywane są większe. Dzięki tej opcji możesz od razu załadować większe zdjęcia, co może poprawić jakość prezentacji np. podczas obracania po przejściu w tryb fullscreen (z małego kontenera początkowego).

Maksymalna dopuszczalna wysokość wstępnie ładowanego zdjęcia to 1024px, więc ustawienie wartości większej niż 1024 działa tak samo jak 1024.

Domyślnie: 0 Przykład: 700 Wartość maksymalna: 1024

report_bugs

Tryb debugowania – zgłasza problemy z uruchomieniem VIEWER-a w okienku alert, dodatkowo obok komunikatu wyświetlanego w oknie VIEWER-a.

Wartości: yes | no

Domyślnie: no

rotate_dir

Kierunek obrotu

Wartości: right | left

Domyślnie: right

single_touch_pan_y

Ustawienie yes sprawia, że pionowy gest przesuwania (jednym palcem) przewija stronę, a nie zawartość VIEWER-a

Wartości: yes | no

Domyślnie: no

Wersja: 3.9.5+

social

Określa, czy wyświetlane są przyciski social (facebook, twitter, e-mail).

Wartości: yes | no

Domyślnie: no

social_url

Adres URL strony, która zostanie opublikowana w serwisach społecznościowych

Domyślnie: na serwerze SUN jest to bezpośredni link do prezentacji

style

Styl interfejsu użytkownika (przycisków).

0 – domyślny styl okrągły

1 – styl kwadratowy

2 – styl okrągły z suwakiem obrotu

3 – styl kwadratowy z suwakiem obrotu

4 – brak przycisków

Wartości: 0 | 1 | 2 | 3 | 4

Domyślnie: 1

teaser

Aby zachęcić użytkowników końcowych do interakcji z prezentacjami 360°, możesz ustawić początkowe zachowanie VIEWER-a:

  • zoomin – prezentacja jest ładowana i lekko się przybliża po najechaniu myszą na okno VIEWER-a
  • autorotate – prezentacja jest ładowana i rozpoczyna automatyczny obrót
  • play – prezentacja nie jest ładowana, wyświetla się przycisk play, a po jego naciśnięciu prezentacja ładuje się i zaczyna automatyczny obrót
  • playonerotation – 2.3.17 – prezentacja nie jest ładowana, wyświetla się przycisk play, a po jego naciśnięciu prezentacja ładuje się i wykonuje jeden obrót
  • playonerotationslow – 2.3.17 – prezentacja nie jest ładowana, wyświetla się przycisk play, a po jego naciśnięciu prezentacja ładuje się i wykonuje jeden powolny obrót
  • static – prezentacja jest ładowana i nic więcej się nie dzieje
  • onerotation – prezentacja jest ładowana i zaraz po załadowaniu wykonuje szybki pojedynczy obrót
  • onerotationslow – prezentacja jest ładowana i zaraz po załadowaniu wykonuje pojedynczy obrót (wolniejszy niż onerotation)

Wartości: autorotate | zoomin | play | playonerotation | playonerotationslow | static | onerotation | onerotationslow

Domyślnie: static

teaserplay_overlay_color

Kolor nakładki teasera o wartości: play | playonerotation | playonerotationslow

Przykład: 0xFFFFFF8C

Wartość ma postać 0x<hex>, gdzie <hex> to kolor w zapisie szesnastkowym.

FFFFFF = kolor biały; dwie ostatnie pozycje określają krycie nakładki [8C = 55% krycia];

Domyślnie: 0x00000099 (czarny z 60% krycia)

Wersja: 3.4.0+

transition

Nieobsługiwany. Filtry przejścia między klatkami były funkcją wycofanego VIEWER-a we Flashu. Bieżące wersje ORBITVU VIEWER ignorują ten parametr; pozostawienie go w embed code nie powoduje żadnych problemów.

width

Szerokość prezentacji

Wartości: liczba całkowita lub ‘auto’

Domyślnie: 400

Liczba całkowita jest podawana w pikselach; auto oznacza 100%

wmode

Nieobsługiwany. wmode był opcją trybu okna Adobe Flash i nie ma znaczenia dla obecnego ORBITVU VIEWER. Parametr jest ignorowany; pozostawienie go w embed code nie powoduje żadnych problemów.

xml_url

Adres URL pliku content2.xml

Domyślnie: <ovus_folder>/content2.xml

W przypadku starszych prezentacji plik może nazywać się content.xml. Decyduje o tym parametr content2.

valign

Nieobsługiwany. Wyrównanie w pionie było parametrem VIEWER-a we Flashu. Obecny ORBITVU VIEWER zawsze centruje prezentację w kontenerze i ignoruje ten parametr; pozostawienie go w embed code nie powoduje żadnych problemów.

viewer_api_init

Nazwa funkcji zwrotnej JavaScript, do której zostanie przekazany obiekt API przed inicjalizacją ORBITVU VIEWER

Ta funkcja zwrotna jest wywoływana zaraz po rozpoczęciu ładowania ORBITVU VIEWER, dzięki czemu można nasłuchiwać zdarzeń ładowania (w odróżnieniu od external_access_init)

Domyślnie: nie ustawiono

Wersja: 2.3.33+

Wydanie: Infinity360, FREE

W wersjach Infinity360 i FREE ORBITVU VIEWER można uzyskać programowy dostęp do jego metod. Szczegóły znajdziesz w dokumentacji API.

W embed code wartością musi być ciąg znaków — nazwa funkcji zwrotnej. Od wersji 3.9.17 możesz też przekazać samą funkcję, wywołując ORBITVU VIEWER z poziomu JavaScript — czego potrzebujesz wewnątrz modułu. Zobacz Używanie ORBITVU VIEWER jako ES module.

viewer_base

Adres URL folderu, z którego serwowane są pliki ORBITVU VIEWER. ORBITVU VIEWER ładuje z tego folderu swój arkusz stylów viewer5.css; bez niego prezentacja wyświetla się bez stylów.

Przykład: http://yourdomain.com/orbitvu12/

Domyślnie: wyprowadzany z argumentu z folderem VIEWER-a przekazanego do inject_orbitvu

Ładowanie arkusza stylów to jedyne, co robi ten parametr. Musisz go ustawić tylko wtedy, gdy nic innego nie dostarcza viewer5.css — gdy przekazujesz pusty folder VIEWER-a do inject_orbitvu albo gdy używasz mount_viewer z bundle'a ES module, który nie przyjmuje argumentu z folderem.

vmove

Włącza ruch w pionie podczas ręcznego obracania

Wartości: yes | no

Domyślnie: yes

vmove_dir

Kierunek obrotu w pionie dla prezentacji 3D

Wartości: down | up

Domyślnie: down

Wersja: 2.3.18+

Na tej stronie