ViewerConfig

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 ResPath deve 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#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    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/adattamento consolidate sono PascalCase.

Predefiniti JavaScript

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

Imposta tutti i valori importanti invece di fare affidamento su uno dei 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

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

Ognuna di queste è un'opzione nell'oggetto di inizializzazione. 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:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... your existing options ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // was found by name
    onViewerReady:    ctlDoc_OnViewerReady,     // was found by name
    onCopy:           ctlDoc_Copy,              // was ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // was ctlDoc_AutoLoadStatus(page)
});

La vecchia ricerca era avvolta 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 dei collegamenti ipertestuali è integrata e guidata da showHyperlinks.

Gruppi di metodi pubblici

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à come punti di integrazione stabili.

Riprova mentre una pagina distribuita è ancora in rendering

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

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 finché non sono scritte. Un client che non riprova mostra tile rotti per le pagine ancora in rendering — vedi Distribuzioni distribuite.

Checklist dei percorsi

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