ViewerConfig
Opzioni del widget visualizzatore client
ViewerConfig (namespace Doconut) descrive l'aspetto e il comportamento del visualizzatore del browser. Non influisce sulla qualità del rendering del documento; per questo usa una configurazione di formato. La classe C# e il widget JavaScript di lunga data hanno impostazioni predefinite diverse, quindi mappa i valori esplicitamente.
Due modifiche lato client in questa release falliscono silenziosamente. Le funzioni handler vengono passate come opzioni — il widget non deriva più i nomi delle funzioni globali dall'id del contenitore — e
ResPathdeve puntare al prefisso delle risorse anziché alla radice dell'applicazione. Entrambe lasciano il server funzionante perfettamente e non segnalano nulla nella console del browser. Se stai portando una pagina dalla libreria precedente, leggi Callback e Checklist dei percorsi prima di qualsiasi altra cosa.
Proprietà C#
| Tipo | Proprietà | Predefinito | Descrizione |
|---|---|---|---|
bool | ShowThumbs | true | Mostra il pannello delle miniature. |
bool | AutoLoad | false | Carica automaticamente dopo l'inizializzazione. Il flusso normale del token chiama esplicitamente View(token). |
bool | AutoFocus | true | Sposta il focus/scroll del browser sul visualizzatore durante l'inizializzazione. |
bool | AutoPageFocus | true | Mantieni visibile la miniatura corrente mentre le pagine cambiano. |
int | PageZoom | 100 | Percentuale di zoom iniziale. |
int | ZoomStep | 10 | Percentuale aggiunta o rimossa dai comandi di zoom. |
int | MaxZoom | 300 | Percentuale massima di zoom. |
bool | ShowToolTip | true | Mostra il tooltip della posizione della pagina durante lo scorrimento. |
string | ToolTipPageText | "Page " | Prefisso usato nel tooltip della pagina. |
bool | CacheEnabled | false | Mantiene una finestra mobile di immagini delle pagine nella memoria del browser. Non utilizza localStorage. |
bool | LargeDoc | false | Aggiunge gli elementi delle pagine in batch temporizzati per documenti di grandi dimensioni. |
bool | ShowHyperlinks | false | Renderizza sovrapposizioni di hyperlink quando la configurazione del server le estrae. |
bool | FixedZoom | true | Utilizza una percentuale di zoom fissa invece di un ricalcolo responsivo. |
int | FixedZoomPercent | 100 | Zoom fisso per desktop. |
int | FixedZoomPercentMobile | 75 | Zoom fisso per mobile. |
string | BasePath | "/" | Dove il visualizzatore invia le richieste di pagina. "/" è DocImage.axd alla radice del sito; altrimenti il ramo dove l'host mappa UseDoconut(), senza una / iniziale ("doconut" significa /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" precedentemente) | Cartella da cui il widget carica le proprie immagini: la cartella images sotto ResourcesPath, senza una / iniziale. |
string | FitType | "width" | "width", "height" o vuoto per nessun adattamento automatico. "page" non è accettato dal widget attuale. |
bool | RetryOn409 | false | Abilita il polling quando la produzione di pagine asincrona/distribuita risponde 202 Accepted; 409 è anche accettato per compatibilità con server più vecchi. Non necessario per il visualizzatore sincrono normale. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // nessuna '/' iniziale: il visualizzatore la aggiunge ("/doconut" diventerebbe //doconut, un altro host)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};Mappatura da C# a JavaScript
| C# | JavaScript |
|---|---|
ShowThumbs | showThumbs |
AutoLoad | autoLoad |
AutoFocus | autoFocus |
AutoPageFocus | autoPageFocus |
PageZoom | pageZoom |
ZoomStep | zoomStep |
MaxZoom | maxZoom |
ShowToolTip | showToolTip |
ToolTipPageText | toolTipPageText |
CacheEnabled | cacheEnabled |
LargeDoc | largeDoc |
ShowHyperlinks | showHyperlinks |
FixedZoom | fixedZoom |
FixedZoomPercent | fixedZoomPercent |
FixedZoomPercentMobile | fixedZoomPercentMobile |
BasePath | BasePath |
ResPath | ResPath |
FitType | FitType |
RetryOn409 | retryOn409 |
Predefiniti JavaScript
Il widget ha predefiniti più vecchi che differiscono dalla classe C#. I seguenti valori provengono dall'attuale implementazione docViewer.js.
| Opzione | Predefinito | Note |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Limiti della larghezza del pannello delle miniature. |
showThumbs | true | Visibilità iniziale delle miniature. |
autoFocus / autoPageFocus | true / false | autoPageFocus differisce dal valore predefinito C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Geometria delle miniature in pixel. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | maxZoom JavaScript differisce da C# (300). |
showToolTip / toolTipPageText | true / "Page " | Tooltip di posizione della pagina. |
format / doc / AccessToken | "" / 0 / "" | Valori di inizializzazione interni; normalmente popolati da View(token). |
debugMode | false | Diagnostica client aggiuntiva. |
FitType | "" | Nessun adattamento automatico a meno che non sia fornito. |
BasePath | "DocImage.axd" | Predefinito client storico mantenuto per compatibilità. Gli host ASP.NET Core attuali devono impostarlo esplicitamente al ramo di middleware mappato. |
ResPath | "" | Impostare esplicitamente al percorso delle immagini incorporate. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Finestra e ritardo di precaricamento delle pagine in memoria. |
autoLoad | false | È consigliato un flusso di token esplicito. |
largeDoc | true | Differisce dal valore predefinito C#. |
fixedZoom | false | Differisce dal valore predefinito C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Il valore mobile differisce da C# (75). |
showHyperlinks | true | Richiede l'estrazione lato server per produrre overlay. |
Imposta tutti i valori comportamentali importanti invece di fare affidamento su uno dei due set di predefiniti:
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>
<script>
const objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
autoFocus: true,
autoPageFocus: true,
pageZoom: 100,
zoomStep: 10,
maxZoom: 300,
FitType: 'width',
cacheEnabled: false,
largeDoc: false,
showHyperlinks: true,
fixedZoom: true,
fixedZoomPercent: 100,
fixedZoomPercentMobile: 75,
BasePath: 'doconut',
ResPath: 'doconut-res/images',
onViewerReady: function () {},
onError: function (message) { console.error('DocViewer:', message); }
});
</script>Callback
| Callback | Argomenti | Scopo |
|---|---|---|
onPageLoading | pageNum | Una richiesta di pagina sta iniziando. |
onPageLoaded | pageNum | L'immagine di una pagina ha terminato il caricamento. |
onThumbnailClicked | pageNum | L'utente ha selezionato una miniatura. |
onPageClicked | pageNum | L'utente ha selezionato una pagina. |
onDoubleClick | nessuno | Il visualizzatore ha ricevuto un doppio clic. |
onViewerBusy | nessuno | Il visualizzatore è entrato in uno stato occupato. |
onViewerReady | nessuno | Inizializzazione completata. |
onViewerError | nessuno | Il visualizzatore è entrato nello stato di errore. |
onError | message | Un'operazione ha restituito un messaggio di errore. |
onCopy | data | I dati di copia del testo sono disponibili. |
onAutoLoadStatus | pageNum | Il caricamento automatico è progredito a una pagina. |
onThumbsShown | nessuno | Il pannello delle miniature è diventato visibile. |
onAnnLoaded | nessuno | Dati di annotazione caricati. |
onAnnSaved | nessuno | Dati di annotazione salvati. |
onAnnSaveError | nessuno | Salvataggio dell'annotazione fallito. |
onAnnClosed | nessuno | Interfaccia di annotazione chiusa. |
Mantieni i callback veloci; invia la telemetria in modo asincrono e non bloccare il rendering della pagina.
Ognuno di questi è un'opzione nell'oggetto di inizializzazione. Il visualizzatore precedente cercava le funzioni globali i cui nomi derivavano dall'ID del contenitore — una pagina con <div id="div_ctlDoc"> doveva solo dichiarare function ctlDoc_OnViewerReady(). Quella ricerca è scomparsa. Passa la funzione esplicitamente:
objctlDoc = $('#div_ctlDoc').docViewer({
// ... le tue opzioni esistenti ...
onViewerBusy: ctlDoc_OnViewerBusy, // è stato trovato per nome
onViewerReady: ctlDoc_OnViewerReady, // è stato trovato per nome
onCopy: ctlDoc_Copy, // era ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // era ctlDoc_AutoLoadStatus(page)
});La vecchia ricerca era avvolta in un catch vuoto, quindi nulla veniva mai segnalato. In questa versione le funzioni semplicemente non vengono mai eseguite: il sintomo tipico è uno spinner occupato che non si ferma mai, perché il gestore che lo nascondeva era onViewerReady. Il documento dietro di esso viene renderizzato correttamente.
Non esiste un callback per il clic sui link — la gestione dei collegamenti ipertestuali è integrata e guidata da showHyperlinks.
Gruppi di metodi pubblici
| Gruppo | Metodi comuni |
|---|---|
| Ciclo di vita | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Navigazione | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Zoom e adattamento | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Orientamento | Rotate(page, angle), Flip(page, flipType) |
| Miniature | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Ricerca | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Annotazione | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Copia | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
Il file JavaScript contiene anche helper interni. Tratta solo i metodi usati dall’interfaccia di riferimento e documentati qui o nelle guide delle funzionalità come punti di integrazione stabili.
Riprova mentre una pagina distribuita è ancora in rendering
retryOn409 mantiene il suo nome storico. È destinato alla produzione asincrona di pagine e riprova la risposta di disponibilità corrente 202 Accepted così come il segnale più vecchio 409 Conflict. Quando abilitato, il widget effettua polling con questi valori predefiniti JavaScript:
| Opzione | Predefinito |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 60 |
retryMaxTotalMs | 120000 |
Lascialo disabilitato per il visualizzatore a nodo singolo normale. Abilitarlo non può trasformare un rendering sincrono non supportato in asincrono.
Abilitalo quando le pagine sono servite da storage condiviso con FirstPagePriority, dove le pagine successive rispondono legittimamente 202 Accepted fino a quando non vengono scritte. Un client che non riprova mostra tasselli rotti per le pagine ancora in rendering — vedi Distribuzioni distribuite.
Checklist del percorso
DoconutOptions.MiddlewarePathdeve descrivere il ramo che effettivamente mappi.BasePathdeve puntare a quel ramo, scritto senza una barra iniziale/('doconut', non'/doconut': il visualizzatore aggiunge la barra, e//doconut/...è una richiesta a un altro host). L’applicazione di riferimento mantiene la forma storica della richiestaDocImage.axdsu un ramoMapWhene quindi impostaBasePath: '/'.DoconutOptions.ResourcesPathè il percorso della risorsa incorporata.ResPathnormalmente punta alla sua sottocartellaimages, senza una barra iniziale —'doconut-res/images'con il prefisso predefinito. UnResPathvuoto era corretto nella libreria precedente, dove le risorse provenivano dalla radice dell’applicazione; non è corretto qui e provoca un fallimento senza errore.ExtractHyperlinksdeve essere abilitato nella configurazione del formato server prima cheshowHyperlinkspossa visualizzare qualcosa.
Questa pagina è stata utile?