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 questo. La classe C# e il widget JavaScript di lunga data hanno impostazioni predefinite diverse, quindi mappa i valori esplicitamente.

Proprietà C#

TipoProprietàPredefinitoDescrizione
boolShowThumbstrueMostra il pannello delle miniature.
boolAutoLoadfalseCarica automaticamente dopo l'inizializzazione. Il flusso normale del 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 di zoom massima.
boolShowToolTiptrueMostra il tooltip della posizione della pagina durante lo scorrimento.
stringToolTipPageText"Page "Prefisso usato nel tooltip della pagina.
boolCacheEnabledfalseMantiene una finestra mobile di immagini delle pagine nella memoria del browser. Non utilizza localStorage.
boolLargeDocfalseAggiunge gli elementi di pagina in batch temporizzati per documenti di grandi dimensioni.
boolShowHyperlinksfalseRenderizza sovrapposizioni di hyperlink quando la configurazione del server li ha estratti.
boolFixedZoomtrueUtilizza 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. "/" corrisponde a DocImage.axd nella radice del sito; altrimenti il ramo dove l'host mappa UseDoconut(), senza una barra iniziale / ("doconut" significa /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" precedente)Cartella da cui il widget carica le proprie immagini: la cartella images sotto ResourcesPath, senza una barra 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; anche 409 è 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",           // nessuna barra iniziale '/': il visualizzatore la aggiunge ("/doconut" diventerebbe //doconut, un altro host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Mappatura da 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/fit consolidate sono PascalCase.

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

Valori predefiniti JavaScript

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

OpzionePredefinitoNote
leftMinWidth / leftMaxWidth220 / 800Limiti della larghezza del riquadro delle miniature.
showThumbstrueVisibilità iniziale delle miniature.
autoFocus / autoPageFocustrue / falseautoPageFocus differisce dal valore predefinito in C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometria delle miniature in pixel.
pageZoom / zoomStep / maxZoom100 / 10 / 200maxZoom di JavaScript 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"Valore predefinito storico del client mantenuto per compatibilità. Gli host ASP.NET Core attuali devono impostarlo esplicitamente al ramo del middleware mappato.
ResPath""Impostare esplicitamente al percorso delle immagini incorporate.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Finestra e ritardo di pre‑caricamento delle pagine in memoria.
autoLoadfalseSi consiglia un flusso di token esplicito.
largeDoctrueDifferisce dal valore predefinito in C#.
fixedZoomfalseDifferisce dal valore predefinito in C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Il valore mobile differisce da C# (75).
showHyperlinkstrueRichiede l'estrazione lato server per produrre overlay.

Imposta tutti i valori comportamentali importanti 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 rapidi; invia la telemetria in modo asincrono e non bloccare il rendering della pagina.

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 adattamentoZoom(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 utilizzati dall'interfaccia di riferimento e documentati qui o nelle guide delle funzionalità.

Ritenta mentre una pagina distribuita è ancora in fase di rendering

retryOn409 mantiene il suo nome storico. È per la produzione di pagine asincrone 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 normale. Abilitarlo non può trasformare un rendering sincrono non supportato in asincrono.

Checklist del percorso

  • DoconutOptions.MiddlewarePath deve descrivere il ramo che effettivamente mappi.
  • BasePath deve 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).
  • DoconutOptions.ResourcesPath è il percorso delle risorse incorporate.
  • ResPath normalmente punta alla sua sottocartella images, anch'essa senza una barra iniziale / ('doconut-res/images').
  • ExtractHyperlinks deve essere abilitato nella configurazione del formato server prima che showHyperlinks possa visualizzare qualcosa.

Questa pagina è stata utile?