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 plugin JavaScript hérité ont des valeurs par défaut différentes, il faut donc mapper les valeurs explicitement.

Propriétés C#

TypePropriétéValeur par défautDescription
boolShowThumbstrueAfficher le panneau des miniatures.
boolAutoLoadfalseCharger automatiquement après l'initialisation. Le flux de jetons normal appelle View(token) explicitement.
boolAutoFocustrueDéplacer le focus/scroll du navigateur vers le visualiseur pendant l'initialisation.
boolAutoPageFocustrueConserver la miniature actuelle visible pendant le changement de pages.
intPageZoom100Pourcentage de zoom initial.
intZoomStep10Pourcentage ajouté ou retiré par les commandes de zoom.
intMaxZoom300Pourcentage de zoom maximal.
boolShowToolTiptrueAfficher l'infobulle de position de page pendant le défilement.
stringToolTipPageText"Page "Préfixe utilisé dans l'infobulle de page.
boolCacheEnabledfalseConserver une fenêtre mobile d'images de pages dans la mémoire du navigateur. Il n'utilise pas localStorage.
boolLargeDocfalseAjouter les éléments de page par lots temporisés pour les gros documents.
boolShowHyperlinksfalseRendre les superpositions de liens hypertexte lorsque la configuration du serveur les a extraites.
boolFixedZoomtrueUtiliser un pourcentage de zoom fixe plutôt qu'un recalcul réactif.
intFixedZoomPercent100Zoom fixe pour le bureau.
intFixedZoomPercentMobile75Zoom fixe pour le mobile.
stringBasePath"/"Où le visualiseur envoie les requêtes de page. "/" est le gestionnaire DocImage.axd à la racine du site. Pour une application dans un répertoire virtuel, utilisez le nom du répertoire sans un / initial ("myapp" signifie /myapp/DocImage.axd).
stringResPath"doconut-res/images"Dossier d'où le widget charge ses propres images : le dossier images sous ResourcesPath, sans un / initial.
stringFitType"width""width", "height", ou vide pour aucun ajustement automatique. "page" n'est pas accepté par le widget actuel.
boolRetryOn409falseRéessaie les requêtes de page qui répondent « still rendering ». DocImage.axd rend de façon synchrone et n'envoie jamais ce signal ; laissez‑le false.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = le gestionnaire DocImage.axd à la racine du site (Web.config)
    ResPath = "doconut-res/images", // le dossier images sous ResourcesPath, pas de '/' initial
    ShowHyperlinks = true
};
// Émettez‑le avec viewer.RenderViewer("viewerEl", token, config) - voir la référence Viewer.

Générer un ViewerConfig avec RenderViewer

Viewer.RenderViewer(elementId, token, config) transforme un ViewerConfig en script d'initialisation du widget. Il écrit six des propriétés ci‑dessus — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom et FitType — puis appelle View(token). Les autres propriétés ne sont pas écrites : pour MaxZoom, ShowHyperlinks, les réglages de zoom, ou tout rappel, initialisez le widget vous‑même avec les options JavaScript ci‑dessous. Voir Visionneuse pour RenderViewer.

Correspondance C# vers JavaScript

Ne transmettez pas un ViewerConfig directement sérialisé à 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 docViewer.js.

OptionValeur par défautRemarques
leftMinWidth / leftMaxWidth220 / 800Limites de largeur du panneau des vignettes.
showThumbstrueVisibilité initiale des vignettes.
autoFocus / autoPageFocustrue / falseautoPageFocus diffère de la valeur par défaut C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Géométrie des vignettes en pixels.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom diffère de C# (300).
showToolTip / toolTipPageTexttrue / "Page "Info-bulle de position de page.
format / doc / AccessToken"" / 0 / ""Valeurs d'initialisation internes ; généralement remplies par View(token).
debugModefalseDiagnostics client supplémentaires.
FitType""Ajustement automatique désactivé sauf si fourni.
BasePath"DocImage.axd"Valeur par défaut héritée. Définissez-la explicitement : '/' pour le gestionnaire à la racine du site.
ResPath""Définissez explicitement 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 jetons explicite est recommandé.
largeDoctrueDiffère de la valeur par défaut C#.
fixedZoomfalseDiffère de la valeur par défaut C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50La valeur mobile diffère de 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: '/',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

Rappels

RappelArgumentsObjectif
onPageLoadingpageNumUne requête de page démarre.
onPageLoadedpageNumLe chargement d'une image de page est terminé.
onThumbnailClickedpageNumL'utilisateur a sélectionné une vignette.
onPageClickedpageNumL'utilisateur a sélectionné une page.
onDoubleClicknoneLe visualiseur a reçu un double-clic.
onViewerBusynoneLe visualiseur est entré en état occupé.
onViewerReadynoneInitialisation terminée.
onViewerErrornoneLe visualiseur est entré en é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é vers une page.
onThumbsShownnoneLe panneau de vignettes est devenu visible.
onAnnLoadednoneLes données d'annotation ont été chargées.
onAnnSavednoneLes données d'annotation ont été enregistrées.
onAnnSaveErrornoneL'enregistrement des annotations a échoué.
onAnnClosednoneL'interface d'annotation a été fermée.

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

Groupes de méthodes publiques

GroupeMéthodes courantes
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)
VignettesHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
RechercheCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopieCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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.

Options de réessai

Le widget accepte également retryOn409 et ses paramètres de temporisation (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Ils servent les déploiements dont les pages sont générées en arrière-plan. DocImage.axd rend chaque page pendant la requête, donc laissez retryOn409 désactivé.

Liste de contrôle des chemins

  • BasePath est '/' lorsque le gestionnaire DocImage.axd se trouve à la racine du site — l'attribut path du gestionnaire dans Web.config détermine où il répond. Dans un répertoire virtuel, utilisez le nom du répertoire sans / initial ('myapp', pas '/myapp' : le visualiseur ajoute la barre oblique, et //myapp/... est une requête vers un autre hôte).
  • DoconutOptions.ResourcesPath est l'endroit où le module de ressources sert les fichiers intégrés (/doconut-res par défaut).
  • ResPath cible son sous-dossier images, également sans / initial ('doconut-res/images'). Le pointer vers 'doconut-res' entraîne un 404 pour chaque icône alors que le document continue de s'afficher.
  • En MVC, routes.IgnoreRoute("doconut-res/{*pathInfo}") doit suivre ResourcesPath si vous le modifiez.
  • ExtractHyperlinks doit être activé dans la configuration du format serveur avant que showHyperlinks puisse afficher quoi que ce soit.

Cette page était-elle utile ?