ViewerConfig

Options du widget de visualisation client

ViewerConfig (namespace 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 ont 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 gestionnaires 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 migrez une page depuis la bibliothèque précédente, lisez Rappels et Liste de contrôle des chemins avant toute chose.

Propriétés C#

TypePropriétéValeur par défautDescription
boolShowThumbstrueAffiche le panneau de vignettes.
boolAutoLoadfalseCharge automatiquement après l'initialisation. Le flux normal de jetons appelle explicitement View(token).
boolAutoFocustrueDéplace le focus/scroll du navigateur vers le visualiseur pendant l'initialisation.
boolAutoPageFocustrueGarde la vignette actuelle visible pendant le changement de pages.
intPageZoom100Pourcentage de zoom initial.
intZoomStep10Pourcentage ajouté ou retiré par les commandes de zoom.
intMaxZoom300Pourcentage de zoom maximal.
boolShowToolTiptrueAffiche l'infobulle de position de page pendant le défilement.
stringToolTipPageText"Page "Préfixe utilisé dans l'infobulle de page.
boolCacheEnabledfalseConserve une fenêtre mobile d'images de pages dans la mémoire du navigateur. N'utilise pas localStorage.
boolLargeDocfalseAjoute les éléments de page par lots chronométrés pour les documents volumineux.
boolShowHyperlinksfalseRendu des superpositions de liens hypertexte lorsque la configuration du serveur les a extraites.
boolFixedZoomtrueUtilise un pourcentage de zoom fixe plutôt qu'un recalcul réactif.
intFixedZoomPercent100Zoom fixe pour le bureau.
intFixedZoomPercentMobile75Zoom fixe pour mobile.
stringBasePath"/"Où le visualiseur envoie les requêtes de pages. "/" correspond à DocImage.axd à la racine du site ; sinon c'est la branche où l'hôte mappe UseDoconut(), sans slash initial ("doconut" signifie /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0 ; "doconut-res" auparavant)Dossier d'où le widget charge ses propres images : le dossier images sous ResourcesPath, sans slash initial.
stringFitType"width""width", "height" ou vide pour aucun ajustement automatique. "page" n'est pas accepté par le widget actuel.
boolRetryOn409falseActive le sondage lorsque la production de pages asynchrone/distribuée répond 202 Accepted ; 409 est également accepté pour la compatibilité avec les anciens serveurs. Non nécessaire pour le visualiseur synchrone normal.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // pas de '/' initial : le visualiseur l'ajoute ("\/doconut" deviendrait //doconut, un autre hôte)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

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

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

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.

OptionValeur par défautRemarques
leftMinWidth / leftMaxWidth220 / 800Limites de largeur du volet des miniatures.
showThumbstrueVisibilité initiale des miniatures.
autoFocus / autoPageFocustrue / falseautoPageFocus diffère du défaut C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Géométrie des miniatures en pixels.
pageZoom / zoomStep / maxZoom100 / 10 / 200maxZoom JavaScript diffère du C# (300).
showToolTip / toolTipPageTexttrue / "Page "Info-bulle de position de page.
format / doc / AccessToken"" / 0 / ""Valeurs d'initialisation internes ; généralement remplis par View(token).
debugModefalseDiagnostics client supplémentaires.
FitType""Pas d'ajustement automatique sauf si fourni.
BasePath"DocImage.axd"Valeur par défaut historique du client conservée pour compatibilité. Les hôtes ASP.NET Core actuels doivent la définir explicitement vers la branche du middleware mappée.
ResPath""Défini explicitement vers le chemin des images intégrées.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Fenêtre et délai de préchargement de pages en mémoire.
autoLoadfalseLe flux de jeton explicite est recommandé.
largeDoctrueDiffère du défaut C#.
fixedZoomfalseDiffère du défaut C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Valeur mobile diffère du C# (75).
showHyperlinkstrueNécessite une extraction côté serveur pour produire des superpositions.

Définissez toutes les valeurs importantes du comportement au lieu de vous fier à l'un ou l'autre des ensembles de valeurs par défaut :

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>

Rappels

RappelArgumentsObjectif
onPageLoadingpageNumUne requête de page démarre.
onPageLoadedpageNumUne image de page a fini de charger.
onThumbnailClickedpageNumL'utilisateur a sélectionné une miniature.
onPageClickedpageNumL'utilisateur a sélectionné une page.
onDoubleClicknoneLe visualiseur a reçu un double-clic.
onViewerBusynoneLe visualiseur est entré dans un état occupé.
onViewerReadynoneInitialisation terminée.
onViewerErrornoneLe visualiseur est entré dans son état d'erreur.
onErrormessageUne opération a renvoyé un message d'erreur.
onCopydataDes données de copie de texte sont disponibles.
onAutoLoadStatuspageNumLe chargement automatique a progressé jusqu'à une page.
onThumbsShownnoneLe panneau des miniatures est devenu visible.
onAnnLoadednoneDonnées d'annotation chargées.
onAnnSavednoneDonnées d'annotation enregistrées.
onAnnSaveErrornoneL'enregistrement de l'annotation a échoué.
onAnnClosednoneInterface d'annotation fermée.

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

Chacun de ceux-ci est une option sur l'objet d'initialisation. Le visualiseur précédent recherchait des fonctions globales dont les noms étaient dérivés de l'ID du conteneur — une page avec <div id="div_ctlDoc"> devait seulement déclarer function ctlDoc_OnViewerReady(). Cette recherche a disparu. Passez la fonction explicitement :

javascript
objctlDoc = $('#div_ctlDoc').docViewer({
    // ... vos options existantes ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // était trouvé par son nom
    onViewerReady:    ctlDoc_OnViewerReady,     // était trouvé par son nom
    onCopy:           ctlDoc_Copy,              // était ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // était 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, parce que le gestionnaire qui le cachait était onViewerReady. Le document derrière s'affiche correctement.

Il n'existe aucun rappel de clic de lien — la gestion des hyperliens est intégrée et pilotée par showHyperlinks.

Groupes de méthodes publiques

GroupeMéthodes communes
Cycle de vieView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigationGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom et ajustementZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientationRotate(page, angle), Flip(page, flipType)
MiniaturesHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
RechercheCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopierCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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

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

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

OptionValeur par défaut
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts60
retryMaxTotalMs120000

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’à leur écriture. Un client qui ne réessaye pas affichera des tuiles cassées pour les pages encore en cours de rendu — voir Déploiements distribués(Distributed Deployments).

Liste de contrôle du chemin

  • DoconutOptions.MiddlewarePath doit décrire la branche que vous mappez réellement.
  • BasePath doit cibler cette branche, écrite sans slash initial / ('doconut', pas '/doconut' : le visualiseur ajoute le slash, et //doconut/... constitue une requête vers un autre hôte). L’application de référence conserve la forme historique de requête DocImage.axd sur une branche MapWhen et définit donc BasePath: '/'.
  • DoconutOptions.ResourcesPath est la route des ressources embarquées.
  • ResPath cible normalement son sous‑dossier images, sans slash initial — '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 générer d’erreur.
  • ExtractHyperlinks doit être activé dans la configuration du format serveur avant que showHyperlinks puisse afficher quoi que ce soit.

Cette page était-elle utile ?