ViewerConfig – Doconut Documentación

ViewerConfig (namespace Doconut) describe la apariencia y el comportamiento del visualizador del navegador. No afecta la calidad de renderizado del documento; use una configuración de formato para eso. La clase C# y el widget JavaScript de larga data tienen valores predeterminados diferentes, por lo que debe mapear los valores explícitamente.

Propiedades C#

Tipo	Propiedad	Predeterminado	Descripción
`bool`	`ShowThumbs`	`true`	Mostrar el panel de miniaturas.
`bool`	`AutoLoad`	`false`	Cargar automáticamente después de la inicialización. El flujo normal de tokens llama a `View(token)` explícitamente.
`bool`	`AutoFocus`	`true`	Mover el foco/desplazamiento del navegador al visualizador durante la inicialización.
`bool`	`AutoPageFocus`	`true`	Mantener la miniatura actual visible mientras cambian las páginas.
`int`	`PageZoom`	`100`	Porcentaje de zoom inicial.
`int`	`ZoomStep`	`10`	Porcentaje añadido o eliminado por los comandos de zoom.
`int`	`MaxZoom`	`300`	Porcentaje máximo de zoom.
`bool`	`ShowToolTip`	`true`	Mostrar la información sobre posición de página mientras se desplaza.
`string`	`ToolTipPageText`	`"Page "`	Prefijo usado en la información sobre la página.
`bool`	`CacheEnabled`	`false`	Mantener una ventana móvil de imágenes de página en la memoria del navegador. No utiliza `localStorage`.
`bool`	`LargeDoc`	`false`	Agregar elementos de página en lotes temporizados para documentos grandes.
`bool`	`ShowHyperlinks`	`false`	Renderizar superposiciones de hipervínculos cuando la configuración del servidor los extrajo.
`bool`	`FixedZoom`	`true`	Usar un porcentaje de zoom fijo en lugar de un recálculo responsivo.
`int`	`FixedZoomPercent`	`100`	Zoom fijo de escritorio.
`int`	`FixedZoomPercentMobile`	`75`	Zoom fijo para móvil.
`string`	`BasePath`	`"/"`	Rama donde el host asigna `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	Base de recursos usada por el widget. En una configuración normal, apúntela a `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` o vacío para no ajustar automáticamente. `"page"` no es aceptado por el widget actual.
`bool`	`RetryOn409`	`false`	Habilitar sondeo cuando la producción de página asíncrona/distribuida responde `202 Accepted`; `409` también se acepta para compatibilidad con servidores antiguos. No es necesario para el visualizador sincrónico normal.

csharp

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

Mapeo de C# a JavaScript

No pase un ViewerConfig serializado directamente a docViewer(...). La mayoría de las claves del widget están en camelCase, mientras que tres claves establecidas de ruta/ajuste están 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`

Valores predeterminados de JavaScript

El widget tiene valores predeterminados más antiguos que difieren de la clase C#. Los siguientes valores provienen de la implementación actual de docViewer.js.

Opción	Predeterminado	Notas
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Límites de ancho del panel de miniaturas.
`showThumbs`	`true`	Visibilidad inicial de miniaturas.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` difiere del valor predeterminado de C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Geometría de miniaturas en píxeles.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` de JavaScript difiere de C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Información sobre posición de página.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Valores internos de inicialización; normalmente poblados por `View(token)`.
`debugMode`	`false`	Diagnósticos adicionales del cliente.
`FitType`	`""`	Sin ajuste automático a menos que se proporcione.
`BasePath`	`"DocImage.axd"`	Valor predeterminado histórico del cliente mantenido por compatibilidad. Los hosts actuales de ASP.NET Core deben establecerlo explícitamente a la rama de middleware asignada.
`ResPath`	`""`	Establecer explícitamente a la ruta de imágenes incrustadas.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Ventana y retraso de precarga de páginas en memoria.
`autoLoad`	`false`	Se recomienda un flujo de token explícito.
`largeDoc`	`true`	Difiere del valor predeterminado de C#.
`fixedZoom`	`false`	Difiere del valor predeterminado de C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	El valor móvil difiere de C# (`75`).
`showHyperlinks`	`true`	Requiere extracción del lado del servidor para producir superposiciones.

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>

Devoluciones de llamada

Devolución de llamada	Argumentos	Propósito
`onPageLoading`	`pageNum`	Comienza una solicitud de página.
`onPageLoaded`	`pageNum`	Una imagen de página ha terminado de cargar.
`onThumbnailClicked`	`pageNum`	El usuario seleccionó una miniatura.
`onPageClicked`	`pageNum`	El usuario seleccionó una página.
`onDoubleClick`	none	El visualizador recibió un doble clic.
`onViewerBusy`	none	El visualizador entró en estado ocupado.
`onViewerReady`	none	Inicialización completada.
`onViewerError`	none	El visualizador entró en su estado de error.
`onError`	`message`	Una operación devolvió un mensaje de error.
`onCopy`	`data`	Datos de copia de texto disponibles.
`onAutoLoadStatus`	`pageNum`	La carga automática avanzó a una página.
`onThumbsShown`	none	El panel de miniaturas se volvió visible.
`onAnnLoaded`	none	Datos de anotación cargados.
`onAnnSaved`	none	Datos de anotación guardados.
`onAnnSaveError`	none	Error al guardar la anotación.
`onAnnClosed`	none	Interfaz de anotación cerrada.

Mantenga las devoluciones de llamada rápidas; envíe telemetría de forma asíncrona y no bloquee el renderizado de la página.

Grupos de métodos públicos

Grupo	Métodos comunes
Ciclo de vida	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navegación	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom y ajuste	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientación	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniaturas	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Búsqueda	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Anotación	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Copiar	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

El archivo JavaScript también contiene ayudantes internos. Trate solo los métodos usados por la UI de referencia y documentados aquí o en las guías de características como puntos de integración estables.

Reintento mientras una página distribuida aún se está renderizando

retryOn409 conserva su nombre histórico. Es para producción de página asíncrona y reintenta la respuesta de disponibilidad actual 202 Accepted así como la señal más antigua 409 Conflict. Cuando está habilitado, el widget sondea con estos valores predeterminados de JavaScript:

Opción	Predeterminado
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Déjelo deshabilitado para el visualizador normal. Habilitarlo no puede convertir una renderización sincrónica no soportada en asíncrona.

Lista de verificación de rutas

DoconutOptions.MiddlewarePath debe describir la rama que realmente asigna.
BasePath debe apuntar a esa rama.
DoconutOptions.ResourcesPath es la ruta del recurso incrustado.
ResPath normalmente apunta a su subcarpeta /images.
ExtractHyperlinks debe estar habilitado en la configuración de formato del servidor antes de que showHyperlinks pueda mostrar algo.