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; usa una configurazione di formato per quello. La classe C# e il widget JavaScript di lunga data hanno impostazioni predefinite diverse, quindi mappa i valori esplicitamente.

Due a cambiamenti 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 ResPath deve puntare al prefisso delle risorse anziché alla radice dell'applicazione. Entrambi 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#

TipoProprietàPredefinitoDescrizione
boolShowThumbstrueMostra il pannello delle miniature.
boolAutoLoadfalseCarica automaticamente dopo l'inizializzazione. Il flusso normale dei token chiama esplicitamente View(token).
boolAutoFocustrueSposta il focus/scroll del browser sul visualizzatore durante l'inizializzazione.
boolAutoPageFocustrueMantieni la miniatura corrente visibile mentre le pagine cambiano.
intPageZoom100Percentuale di zoom iniziale.
intZoomStep10Percentuale aggiunta o rimossa dai comandi di zoom.
intMaxZoom300Percentuale massima di zoom.
boolShowToolTiptrueMostra il tooltip della posizione della pagina durante lo scorrimento.
stringToolTipPageText"Page "Prefisso usato nel tooltip della pagina.
boolCacheEnabledfalseMantieni una finestra mobile di immagini di pagina nella memoria del browser. Non utilizza localStorage.
boolLargeDocfalseAggiungi gli elementi di pagina in batch temporizzati per documenti di grandi dimensioni.
boolShowHyperlinksfalseRenderizza le sovrapposizioni dei collegamenti ipertestuali quando la configurazione del server le ha estratte.
boolFixedZoomtrueUsa una percentuale di zoom fissa invece di un ricalcolo responsivo.
intFixedZoomPercent100Zoom fisso per desktop.
intFixedZoomPercentMobile75Zoom fisso per mobile.
stringBasePath"/"Dove il visualizzatore invia le richieste di pagina. "/" è DocImage.axd alla radice del sito; altrimenti il ramo dove l'host mappa UseDoconut(), senza un / iniziale ("doconut" significa /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" prima)Cartella da cui il widget carica le proprie immagini: la cartella images sotto ResourcesPath, senza un / iniziale.
stringFitType"width""width", "height", o vuoto per nessun adattamento automatico. "page" non è accettato dal widget corrente.
boolRetryOn409falseAbilita 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.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // nessun '/' iniziale: il visualizzatore lo aggiunge ("/doconut" diventerebbe //doconut, un altro host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Mappatura C# a JavaScript

Non passare un ViewerConfig serializzato direttamente a docViewer(...). La maggior parte delle chiavi del widget sono camelCase, mentre tre chiavi di percorso/adattamento consolidate sono PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

Predefiniti JavaScript

Il widget ha predefiniti più vecchi che differiscono dalla classe C#. I seguenti valori provengono dall'implementazione corrente di docViewer.js.

OpzionePredefinitoNote
leftMinWidth / leftMaxWidth220 / 800Limiti della larghezza del riquadro delle miniature.
showThumbstrueVisibilità iniziale delle miniature.
autoFocus / autoPageFocustrue / falseautoPageFocus differisce dal valore predefinito C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometria delle miniature in pixel.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom differisce da C# (300).
showToolTip / toolTipPageTexttrue / "Page "Tooltip di posizione della pagina.
format / doc / AccessToken"" / 0 / ""Valori di inizializzazione interni; normalmente popolati da View(token).
debugModefalseDiagnostica client aggiuntiva.
FitType""Nessun adattamento automatico a meno che non sia fornito.
BasePath"DocImage.axd"Predefinito storico del client mantenuto per compatibilità. Gli host ASP.NET Core attuali devono impostarlo esplicitamente sul ramo di middleware mappato.
ResPath""Impostare esplicitamente sul percorso delle immagini incorporate.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Finestra e ritardo di pre‑caricamento delle pagine in memoria.
autoLoadfalseÈ consigliato un flusso di token esplicito.
largeDoctrueDifferisce dal valore predefinito C#.
fixedZoomfalseDifferisce dal valore predefinito C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Il valore mobile differisce da C# (75).
showHyperlinkstrueRichiede l'estrazione lato server per produrre overlay.

Imposta tutti i valori importanti per il comportamento invece di fare affidamento su uno dei due set di valori predefiniti:

html
<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

CallbackArgomentiScopo
onPageLoadingpageNumUna richiesta di pagina sta iniziando.
onPageLoadedpageNumUn'immagine di pagina ha terminato il caricamento.
onThumbnailClickedpageNumL'utente ha selezionato una miniatura.
onPageClickedpageNumL'utente ha selezionato una pagina.
onDoubleClicknoneIl visualizzatore ha ricevuto un doppio clic.
onViewerBusynoneIl visualizzatore è entrato in uno stato occupato.
onViewerReadynoneInizializzazione completata.
onViewerErrornoneIl visualizzatore è entrato nello stato di errore.
onErrormessageUn'operazione ha restituito un messaggio di errore.
onCopydataI dati di copia del testo sono disponibili.
onAutoLoadStatuspageNumIl caricamento automatico è progredito a una pagina.
onThumbsShownnoneIl pannello delle miniature è diventato visibile.
onAnnLoadednoneDati di annotazione caricati.
onAnnSavednoneDati di annotazione salvati.
onAnnSaveErrornoneSalvataggio dell'annotazione fallito.
onAnnClosednoneInterfaccia di annotazione chiusa.

Mantieni i callback veloci; invia telemetria in modo asincrono e non bloccare il rendering della pagina.

Ognuno di questi è un'opzione sull'oggetto init. Il visualizzatore precedente cercava funzioni globali i cui nomi derivava dall'ID del contenitore — una pagina con <div id="div_ctlDoc"> doveva solo dichiarare function ctlDoc_OnViewerReady(). Quella ricerca è scomparsa. Passa la funzione esplicitamente:

javascript
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)
});

Il vecchio lookup era avvolto in un catch vuoto, quindi nulla veniva mai segnalato. In questa release le funzioni semplicemente non vengono mai eseguite: il sintomo tipico è uno spinner occupato che non si ferma, perché il gestore che lo nascondeva era onViewerReady. Il documento dietro di esso viene renderizzato correttamente.

Non esiste un callback per il click sui link — la gestione degli hyperlink è integrata e guidata da showHyperlinks.

Gruppi di metodi pubblici

GruppoMetodi comuni
Ciclo di vitaView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigazioneGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom e adattaZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientamentoRotate(page, angle), Flip(page, flipType)
MiniatureHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
RicercaCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotazioneSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopiaCopy(...), CopyPage(pageNumber), CopyMode(enabled)

Il file JavaScript contiene anche helper interni. Considera stabili solo i metodi usati dall'interfaccia di riferimento e documentati qui o nelle guide delle funzionalità come punti di integrazione.

Riprova mentre una pagina distribuita è ancora in rendering

retryOn409 mantiene il suo nome storico. È per la produzione asincrona di pagine e riprova la risposta di prontezza corrente 202 Accepted così come il segnale più vecchio 409 Conflict. Quando abilitato, il widget effettua polling con questi valori predefiniti JavaScript:

OpzionePredefinito
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts60
retryMaxTotalMs120000

Lascialo disabilitato per il visualizzatore a nodo singolo normale. Abilitarlo non può rendere asincrono un rendering sincrono non supportato.

Abilitalo quando le pagine sono servite da storage condiviso con FirstPagePriority, dove le pagine successive rispondono legittimamente 202 Accepted fino a quando non sono scritte. Un client che non riprova mostra tile rotti per le pagine ancora in rendering — vedi Distribuzioni distribuite.

Lista di controllo percorsi

  • DoconutOptions.MiddlewarePath deve descrivere il ramo che effettivamente mappi.
  • BasePath deve puntare a quel ramo, scritto senza un / iniziale ('doconut', non '/doconut': il visualizzatore aggiunge lo slash, e //doconut/... è una richiesta a un altro host). L'applicazione di riferimento mantiene la forma di richiesta storica DocImage.axd su un ramo MapWhen e quindi imposta BasePath: '/'.
  • DoconutOptions.ResourcesPath è il percorso della risorsa incorporata.
  • ResPath normalmente punta alla sua sottocartella images, senza un / iniziale — 'doconut-res/images' con il prefisso predefinito. Un ResPath vuoto era corretto nella libreria precedente, dove le risorse provenivano dalla radice dell'applicazione; qui non è corretto e fallisce senza un errore.
  • ExtractHyperlinks deve essere abilitato nella configurazione del formato server prima che showHyperlinks possa visualizzare qualcosa.

Questa pagina è stata utile?