Configuración del Visor
Opciones del widget del visor cliente
ViewerConfig (namespace Doconut) describe la apariencia y el comportamiento del visor 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 los valores deben mapearse explícitamente.
Dos cambios del lado del cliente en esta versión fallan silenciosamente. Las funciones manejadoras se pasan como opciones — el widget ya no deriva nombres de funciones globales del id del contenedor — y
ResPathdebe apuntar al prefijo de recursos en lugar de la raíz de la aplicación. Ambos dejan el servidor funcionando perfectamente y no informan nada en la consola del navegador. Si está trasladando una página de la biblioteca anterior, lea Devoluciones de llamada y Lista de verificación de rutas antes que nada.
Propiedades de 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 visor 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 | Retener una ventana móvil de imágenes de página en la memoria del navegador. No usa localStorage. |
bool | LargeDoc | false | Añadir 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 extrae. |
bool | FixedZoom | true | Usar un porcentaje de zoom fijo en lugar de un recálculo responsivo. |
int | FixedZoomPercent | 100 | Zoom fijo para 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 sin ajuste automático. "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 visor sincrónico normal. |
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 directamente serializado 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 del middleware asignado. |
ResPath | "" | Establecer explícitamente a la ruta de imágenes incrustadas. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Ventana de precarga de páginas en memoria y retraso. |
autoLoad | false | Se recomienda el flujo explícito de token. |
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. |
Establezca todos los valores importantes de comportamiento en lugar de confiar en cualquiera de los conjuntos de valores predeterminados:
<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 | Se está iniciando una solicitud de página. |
onPageLoaded | pageNum | Una imagen de página ha terminado de cargarse. |
onThumbnailClicked | pageNum | El usuario seleccionó una miniatura. |
onPageClicked | pageNum | El usuario seleccionó una página. |
onDoubleClick | none | El visor recibió un doble clic. |
onViewerBusy | none | El visor entró en estado ocupado. |
onViewerReady | none | La inicialización se completó. |
onViewerError | none | El visor entró en su estado de error. |
onError | message | Una operación devolvió un mensaje de error. |
onCopy | data | Los datos de copia de texto están disponibles. |
onAutoLoadStatus | pageNum | La carga automática progresó a una página. |
onThumbsShown | none | El panel de miniaturas se volvió visible. |
onAnnLoaded | none | Los datos de anotación se cargaron. |
onAnnSaved | none | Los datos de anotación se guardaron. |
onAnnSaveError | none | La guardado de anotación falló. |
onAnnClosed | none | La UI de anotación se cerró. |
Mantenga los callbacks rápidos; envíe telemetría de forma asíncrona y no bloquee el renderizado de la página.
Cada uno de estos es una opción en el objeto de inicialización. El visor anterior buscaba
funciones globales cuyos nombres derivaba del id del contenedor — una página con
<div id="div_ctlDoc"> solo tenía que declarar function ctlDoc_OnViewerReady(). Esa búsqueda
ha desaparecido. Pase la función explícitamente:
objctlDoc = $('#div_ctlDoc').docViewer({
// ... sus opciones existentes ...
onViewerBusy: ctlDoc_OnViewerBusy, // antes se encontraba por nombre
onViewerReady: ctlDoc_OnViewerReady, // antes se encontraba por nombre
onCopy: ctlDoc_Copy, // antes era ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // antes era ctlDoc_AutoLoadStatus(page)
});La búsqueda anterior estaba envuelta en un catch vacío, por lo que nunca se informó nada. En esta
versión las funciones simplemente nunca se ejecutan: el síntoma habitual es un spinner de carga que nunca
se detiene, porque el manejador que lo ocultaba era onViewerReady. El documento detrás de él se está
renderizando correctamente.
No existe un callback para clics en enlaces — el manejo de hipervínculos está integrado y es impulsado por
showHyperlinks.
Grupos de métodos públicos
| Grupo | Métodos comunes |
|---|---|
| Lifecycle | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Navigation | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Zoom and fit | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Orientation | Rotate(page, angle), Flip(page, flipType) |
| Thumbnails | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Search | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Annotation | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Copy | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
El archivo JavaScript contiene también 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 sigue renderizándose
retryOn409 conserva su nombre histórico. Sirve 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 visor normal de nodo único. Habilitarlo no puede convertir un renderizado sincrónico no soportado en asíncrono.
Habilítelo cuando las páginas se sirvan desde almacenamiento compartido con FirstPagePriority, donde páginas posteriores legítimamente responden 202 Accepted hasta que se escriben. Un cliente que no reintenta muestra mosaicos rotos para páginas que aún se están renderizando — vea
Despliegues distribuidos.
Lista de verificación de rutas
DoconutOptions.MiddlewarePathdebe describir la rama que realmente asigna.BasePathdebe apuntar a esa rama. La aplicación de referencia mantiene la forma histórica de solicitudDocImage.axden una ramaMapWheny por eso estableceBasePath: '/'.DoconutOptions.ResourcesPathes la ruta del recurso incrustado.ResPathnormalmente apunta a su subcarpeta/images—'doconut-res/images'con el prefijo predeterminado. UnResPathvacío era correcto en la biblioteca anterior, donde los recursos provenían de la raíz de la aplicación; no es correcto aquí y falla sin generar error.ExtractHyperlinksdebe estar habilitado en la configuración de formato del servidor antes de queshowHyperlinkspueda mostrar algo.
¿Fue útil esta página?