ViewerConfig

Opciones del widget de visualizador del cliente

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 se deben mapear los valores explícitamente.

Propiedades 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 visualizador 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.
boolCacheEnabledfalseConservar 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"/"Dónde el visualizador envía solicitudes de página. "/" está DocImage.axd en la raíz del sitio; de lo contrario, la rama donde el host asigna UseDoconut(), sin un / inicial ("doconut" significa /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" antes)Carpeta desde la que el widget carga sus propias imágenes: la carpeta images bajo ResourcesPath, sin un / inicial.
stringFitType"width""width", "height", o vacío para no 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 es aceptado para compatibilidad con servidores más 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",           // sin '/' : el visor lo agrega ("/doconut" se convertiría en //doconut, otro host)
    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
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 docViewer.js.

OpciónPredeterminadoNotas
leftMinWidth / leftMaxWidth220 / 800Límites del ancho del panel de miniaturas.
showThumbstrueVisibilidad inicial de la miniatura.
autoFocus / autoPageFocustrue / falseautoPageFocus difiere del valor predeterminado de C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometría de miniaturas en píxeles.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom 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 retenido por compatibilidad. Los hosts actuales de ASP.NET Core deben establecerlo explícitamente en la rama de middleware asignada.
ResPath""Establecer explícitamente en la ruta de imágenes incrustadas.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Ventana y retraso de precarga de página en memoria.
autoLoadfalseSe recomienda un flujo de token explícito.
largeDoctrueDifiere del valor predeterminado de C#.
fixedZoomfalseDifiere del valor predeterminado de C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Valor 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 depender de 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ónArgumentosPropó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.
onDoubleClickningunoEl visor recibió un doble clic.
onViewerBusyningunoEl visor entró en estado ocupado.
onViewerReadyningunoInicialización completada.
onViewerErrorningunoEl 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 avanzó a una página.
onThumbsShownningunoEl panel de miniaturas se volvió visible.
onAnnLoadedningunoDatos de anotación cargados.
onAnnSavedningunoDatos de anotación guardados.
onAnnSaveErrorningunoFalló el guardado de anotación.
onAnnClosedningunoInterfaz de anotación cerrada.

Mantenga las devoluciones rápidas; envíe telemetría de forma asíncrona y no bloquee la renderización de la página.

Grupos de métodos públicos

GrupoMétodos comunes
Ciclo de vidaView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavegaciónGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom y ajusteZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientaciónRotate(page, angle), Flip(page, flipType)
MiniaturasHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
BúsquedaCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnotaciónSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopiarCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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

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

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

OpciónPredeterminado
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

Déjelo desactivado para el visor normal. Activarlo no puede convertir una renderización sincrónica no compatible en asíncrona.

Lista de verificación de rutas

  • DoconutOptions.MiddlewarePath debe describir la rama que realmente asignas.
  • BasePath debe apuntar a esa rama, escrita sin un / inicial ('doconut', no '/doconut': el visor agrega la barra diagonal, y //doconut/... es una solicitud a otro host).
  • DoconutOptions.ResourcesPath es la ruta del recurso incrustado.
  • ResPath normalmente apunta a su subcarpeta images, también sin un / inicial ('doconut-res/images').
  • ExtractHyperlinks debe estar habilitado en la configuración de formato del servidor antes de que showHyperlinks pueda mostrar algo.

¿Fue útil esta página?