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 ResPath debe 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#

TipoPropiedadPredeterminadoDescripción
boolShowThumbstrueMostrar el panel de miniaturas.
boolAutoLoadfalseCargar automáticamente después de la inicialización. El flujo normal de tokens llama a View(token) explícitamente.
boolAutoFocustrueMover el foco/desplazamiento del navegador al visor durante la inicialización.
boolAutoPageFocustrueMantener la miniatura actual visible mientras cambian las páginas.
intPageZoom100Porcentaje de zoom inicial.
intZoomStep10Porcentaje añadido o eliminado por los comandos de zoom.
intMaxZoom300Porcentaje máximo de zoom.
boolShowToolTiptrueMostrar la información sobre posición de página mientras se desplaza.
stringToolTipPageText"Page "Prefijo usado en la información sobre la página.
boolCacheEnabledfalseRetener una ventana móvil de imágenes de página en la memoria del navegador. No usa localStorage.
boolLargeDocfalseAñadir elementos de página en lotes temporizados para documentos grandes.
boolShowHyperlinksfalseRenderizar superposiciones de hipervínculos cuando la configuración del servidor los extrae.
boolFixedZoomtrueUsar un porcentaje de zoom fijo en lugar de un recálculo responsivo.
intFixedZoomPercent100Zoom fijo para escritorio.
intFixedZoomPercentMobile75Zoom fijo para móvil.
stringBasePath"/"Rama donde el host asigna UseDoconut().
stringResPath"doconut-res"Base de recursos usada por el widget. En una configuración normal apúntela a <ResourcesPath>/images.
stringFitType"width""width", "height" o vacío para sin ajuste automático. "page" no es aceptado por el widget actual.
boolRetryOn409falseHabilitar 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.
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 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
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

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ónPredeterminadoNotas
leftMinWidth / leftMaxWidth220 / 800Límites de ancho del panel de miniaturas.
showThumbstrueVisibilidad inicial de miniaturas.
autoFocus / autoPageFocustrue / falseautoPageFocus difiere del valor predeterminado de C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometría de miniaturas en píxeles.
pageZoom / zoomStep / maxZoom100 / 10 / 200maxZoom de JavaScript difiere de C# (300).
showToolTip / toolTipPageTexttrue / "Page "Información sobre posición de página.
format / doc / AccessToken"" / 0 / ""Valores internos de inicialización; normalmente poblados por View(token).
debugModefalseDiagnó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 / cacheDelayfalse / 3 / 3Ventana de precarga de páginas en memoria y retraso.
autoLoadfalseSe recomienda el flujo explícito de token.
largeDoctrueDifiere del valor predeterminado de C#.
fixedZoomfalseDifiere del valor predeterminado de C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50El valor móvil difiere de C# (75).
showHyperlinkstrueRequiere 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:

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 llamadaArgumentosPropósito
onPageLoadingpageNumSe está iniciando una solicitud de página.
onPageLoadedpageNumUna imagen de página ha terminado de cargarse.
onThumbnailClickedpageNumEl usuario seleccionó una miniatura.
onPageClickedpageNumEl usuario seleccionó una página.
onDoubleClicknoneEl visor recibió un doble clic.
onViewerBusynoneEl visor entró en estado ocupado.
onViewerReadynoneLa inicialización se completó.
onViewerErrornoneEl visor entró en su estado de error.
onErrormessageUna operación devolvió un mensaje de error.
onCopydataLos datos de copia de texto están disponibles.
onAutoLoadStatuspageNumLa carga automática progresó a una página.
onThumbsShownnoneEl panel de miniaturas se volvió visible.
onAnnLoadednoneLos datos de anotación se cargaron.
onAnnSavednoneLos datos de anotación se guardaron.
onAnnSaveErrornoneLa guardado de anotación falló.
onAnnClosednoneLa 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:

javascript
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

GrupoMétodos comunes
LifecycleView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigationGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom and fitZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientationRotate(page, angle), Flip(page, flipType)
ThumbnailsHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
SearchCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopyCopy(...), 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ónPredeterminado
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts60
retryMaxTotalMs120000

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.MiddlewarePath debe describir la rama que realmente asigna.
  • BasePath debe apuntar a esa rama. La aplicación de referencia mantiene la forma histórica de solicitud DocImage.axd en una rama MapWhen y por eso establece BasePath: '/'.
  • DoconutOptions.ResourcesPath es la ruta del recurso incrustado.
  • ResPath normalmente apunta a su subcarpeta /images'doconut-res/images' con el prefijo predeterminado. Un ResPath vací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.
  • ExtractHyperlinks debe estar habilitado en la configuración de formato del servidor antes de que showHyperlinks pueda mostrar algo.

¿Fue útil esta página?