ViewerConfig

ViewerConfig (espace de noms Doconut) décrit l'apparence et le comportement du visualiseur du navigateur. Il n'affecte pas la qualité du rendu du document ; utilisez une configuration de format pour cela. La classe C# et le widget JavaScript de longue date possèdent des valeurs par défaut différentes, il faut donc mapper les valeurs explicitement.

Deux changements côté client dans cette version échouent silencieusement. Les fonctions de gestionnaire sont passées en tant qu'options — le widget ne dérive plus les noms de fonctions globales à partir de l'ID du conteneur — et ResPath doit pointer vers le préfixe des ressources plutôt que vers la racine de l'application. Les deux laissent le serveur fonctionner parfaitement et ne signalent rien dans la console du navigateur. Si vous transportez une page depuis la bibliothèque précédente, lisez les Rappels et la Liste de contrôle des chemins avant toute chose.

Propriétés C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Correspondance C# vers JavaScript

Ne passez pas un ViewerConfig sérialisé directement à docViewer(...). La plupart des clés du widget sont en camelCase, tandis que trois clés de chemin/ajustement établies sont en PascalCase.

Valeurs par défaut JavaScript

Le widget possède des valeurs par défaut plus anciennes qui diffèrent de la classe C#. Les valeurs suivantes proviennent de l’implémentation actuelle de docViewer.js.

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

Rappels

Gardez les rappels rapides ; envoyez la télémétrie de façon asynchrone et ne bloquez pas le rendu de la page.

Chacune de ces options fait partie de l'objet d'initialisation. Le visualiseur précédent recherchait les fonctions globales dont les noms étaient dérivés de l'ID du conteneur — une page avec <div id="div_ctlDoc"> ne devait déclarer que function ctlDoc_OnViewerReady(). Cette recherche a disparu. Passez la fonction explicitement :

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

L'ancienne recherche était enveloppée dans un catch vide, donc rien n’était jamais signalé. Dans cette version, les fonctions ne s’exécutent tout simplement jamais : le symptôme habituel est un indicateur d’activité qui ne s’arrête jamais, car le gestionnaire qui le cachait était onViewerReady. Le document derrière s’affiche correctement.

Il n’existe aucun rappel de clic sur les liens — la gestion des hyperliens est intégrée et pilotée par showHyperlinks.

Groupes de méthodes publiques

Le fichier JavaScript contient également des aides internes. Considérez uniquement les méthodes utilisées par l’interface de référence et documentées ici ou dans les guides fonctionnels comme des points d’intégration stables.

Réessayer pendant qu’une page distribuée est encore en cours de rendu

retryOn409 conserve son nom historique. Il sert à la production de pages asynchrone et réessaye la réponse de disponibilité 202 Accepted ainsi que le signal plus ancien 409 Conflict. Lorsqu’il est activé, le widget interroge avec les valeurs par défaut JavaScript suivantes :

Laissez‑le désactivé pour le visualiseur mono‑noeud normal. L’activer ne peut pas rendre asynchrone un rendu synchrone non pris en charge.

Activez‑le lorsque les pages sont servies depuis un stockage partagé avec FirstPagePriority, où les pages suivantes répondent légitimement 202 Accepted jusqu’à ce qu’elles soient écrites. Un client qui ne réessaye pas affiche des tuiles cassées pour les pages encore en cours de rendu — voir Déploiements distribués.

Liste de contrôle des chemins

• DoconutOptions.MiddlewarePath doit décrire la branche que vous mappez réellement.
• BasePath doit cibler cette branche. L’application de référence conserve la forme de requête historique DocImage.axd sur une branche MapWhen et définit donc BasePath: '/'.
• DoconutOptions.ResourcesPath est la route des ressources intégrées.
• ResPath pointe normalement vers son sous‑dossier /images — 'doconut-res/images' avec le préfixe par défaut. Un ResPath vide était correct dans la bibliothèque précédente, où les ressources provenaient de la racine de l’application ; ce n’est pas correct ici, et cela échoue sans erreur.
• ExtractHyperlinks doit être activé dans la configuration du format serveur avant que showHyperlinks puisse afficher quoi que ce soit.