ViewerConfig – Documentation Doconut

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#

Type	Propriété	Valeur par défaut	Description
`bool`	`ShowThumbs`	`true`	Afficher le panneau des miniatures.
`bool`	`AutoLoad`	`false`	Charger automatiquement après l'initialisation. Le flux de jeton normal appelle `View(token)` explicitement.
`bool`	`AutoFocus`	`true`	Déplacer le focus/scroll du navigateur vers le visualiseur pendant l'initialisation.
`bool`	`AutoPageFocus`	`true`	Garder la miniature actuelle visible pendant le changement de pages.
`int`	`PageZoom`	`100`	Pourcentage de zoom initial.
`int`	`ZoomStep`	`10`	Pourcentage ajouté ou retiré par les commandes de zoom.
`int`	`MaxZoom`	`300`	Pourcentage de zoom maximal.
`bool`	`ShowToolTip`	`true`	Afficher l'infobulle de position de page pendant le défilement.
`string`	`ToolTipPageText`	`"Page "`	Préfixe utilisé dans l'infobulle de page.
`bool`	`CacheEnabled`	`false`	Conserver une fenêtre mobile d'images de pages dans la mémoire du navigateur. N'utilise pas `localStorage`.
`bool`	`LargeDoc`	`false`	Ajouter les éléments de page par lots temporisés pour les documents volumineux.
`bool`	`ShowHyperlinks`	`false`	Rendre les superpositions de liens hypertexte lorsque la configuration du serveur les a extraites.
`bool`	`FixedZoom`	`true`	Utiliser un pourcentage de zoom fixe plutôt qu'un recalcul réactif.
`int`	`FixedZoomPercent`	`100`	Zoom fixe pour le bureau.
`int`	`FixedZoomPercentMobile`	`75`	Zoom fixe pour le mobile.
`string`	`BasePath`	`"/"`	Branche où l'hôte mappe `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	Base de ressources utilisée par le widget. Dans une configuration normale, pointez‑la vers `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` ou vide pour aucun ajustement automatique. `"page"` n'est pas accepté par le widget actuel.
`bool`	`RetryOn409`	`false`	Activer le sondage lorsqu'une requête de page asynchrone/distribuée répond `409`. 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",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Mappage C# vers JavaScript

Ne passez 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
`ShowThumbs`	`showThumbs`
`AutoLoad`	`autoLoad`
`AutoFocus`	`autoFocus`
`AutoPageFocus`	`autoPageFocus`
`PageZoom`	`pageZoom`
`ZoomStep`	`zoomStep`
`MaxZoom`	`maxZoom`
`ShowToolTip`	`showToolTip`
`ToolTipPageText`	`toolTipPageText`
`CacheEnabled`	`cacheEnabled`
`LargeDoc`	`largeDoc`
`ShowHyperlinks`	`showHyperlinks`
`FixedZoom`	`fixedZoom`
`FixedZoomPercent`	`fixedZoomPercent`
`FixedZoomPercentMobile`	`fixedZoomPercentMobile`
`BasePath`	`BasePath`
`ResPath`	`ResPath`
`FitType`	`FitType`
`RetryOn409`	`retryOn409`

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.

Option	Valeur par défaut	Notes
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Limites de largeur du panneau de miniatures.
`showThumbs`	`true`	Visibilité initiale des miniatures.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` diffère de la valeur par défaut C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Géométrie des miniatures en pixels.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` JavaScript diffère de C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Infobulle de position de page.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Valeurs d'initialisation internes ; généralement remplies par `View(token)`.
`debugMode`	`false`	Diagnostics client supplémentaires.
`FitType`	`""`	Aucun ajustement automatique sauf si fourni.
`BasePath`	`"DocImage.axd"`	Valeur par défaut du gestionnaire hérité. Définissez‑la explicitement pour ASP.NET Core.
`ResPath`	`""`	Définir explicitement vers le chemin des images intégrées.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Fenêtre de préchargement de pages en mémoire et délai.
`autoLoad`	`false`	Le flux de jeton explicite est recommandé.
`largeDoc`	`true`	Diffère de la valeur par défaut C#.
`fixedZoom`	`false`	Diffère de la valeur par défaut C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	La valeur mobile diffère de C# (`75`).
`showHyperlinks`	`true`	Nécessite une extraction côté serveur pour produire les superpositions.

Définissez toutes les valeurs importantes du comportement plutôt que 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

Rappel	Arguments	Objectif
`onPageLoading`	`pageNum`	Une requête de page démarre.
`onPageLoaded`	`pageNum`	Une image de page a fini de charger.
`onThumbnailClicked`	`pageNum`	L'utilisateur a sélectionné une miniature.
`onPageClicked`	`pageNum`	L'utilisateur a sélectionné une page.
`onDoubleClick`	none	Le visualiseur a reçu un double‑clic.
`onViewerBusy`	none	Le visualiseur est entré dans un état occupé.
`onViewerReady`	none	Initialisation terminée.
`onViewerError`	none	Le visualiseur est entré dans son état d'erreur.
`onError`	`message`	Une opération a renvoyé un message d'erreur.
`onCopy`	`data`	Des données de copie de texte sont disponibles.
`onAutoLoadStatus`	`pageNum`	Le chargement automatique a progressé jusqu'à une page.
`onThumbsShown`	none	Le panneau de miniatures est devenu visible.
`onAnnLoaded`	none	Données d'annotation chargées.
`onAnnSaved`	none	Données d'annotation enregistrées.
`onAnnSaveError`	none	Échec de l'enregistrement de l'annotation.
`onAnnClosed`	none	Interface d'annotation fermée.

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

Groupes de méthodes publiques

Groupe	Méthodes courantes
Cycle de vie	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigation	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom et ajustement	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientation	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniatures	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Recherche	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Annotation	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Copie	`Copy(...)`, `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.

Nouvelle tentative après HTTP 409

retryOn409 sert à la production de pages asynchrones. Lorsqu'il est activé, le widget interroge avec ces valeurs par défaut JavaScript :

Option	Valeur par défaut
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

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

Liste de contrôle des chemins

DoconutOptions.MiddlewarePath doit décrire la branche que vous mappez réellement.
BasePath doit cibler cette branche.
DoconutOptions.ResourcesPath est la route des ressources intégrées.
ResPath pointe normalement vers son sous‑dossier /images.
ExtractHyperlinks doit être activé dans la configuration de format du serveur avant que showHyperlinks puisse afficher quoi que ce soit.