ViewerConfig – Documentação Doconut

ViewerConfig (namespace Doconut) descreve a aparência e o comportamento do visualizador no navegador. Não afeta a qualidade de renderização do documento; use uma configuração de formato para isso. A classe C# e o plugin JavaScript legado têm padrões diferentes, portanto mapeie os valores explicitamente.

Propriedades C#

Tipo	Propriedade	Padrão	Descrição
`bool`	`ShowThumbs`	`true`	Exibir o painel de miniaturas.
`bool`	`AutoLoad`	`false`	Carregar automaticamente após a inicialização. O fluxo normal de token chama `View(token)` explicitamente.
`bool`	`AutoFocus`	`true`	Mover o foco/rolagem do navegador para o visualizador durante a inicialização.
`bool`	`AutoPageFocus`	`true`	Manter a miniatura atual visível enquanto as páginas mudam.
`int`	`PageZoom`	`100`	Porcentagem de zoom inicial.
`int`	`ZoomStep`	`10`	Porcentagem adicionada ou removida pelos comandos de zoom.
`int`	`MaxZoom`	`300`	Porcentagem máxima de zoom.
`bool`	`ShowToolTip`	`true`	Exibir a dica de posição da página ao rolar.
`string`	`ToolTipPageText`	`"Page "`	Prefixo usado na dica da página.
`bool`	`CacheEnabled`	`false`	Manter uma janela móvel de imagens de página na memória do navegador. Não utiliza `localStorage`.
`bool`	`LargeDoc`	`false`	Adicionar elementos de página em lotes cronometrados para documentos grandes.
`bool`	`ShowHyperlinks`	`false`	Renderizar sobreposições de hiperlinks quando a configuração do servidor os extraiu.
`bool`	`FixedZoom`	`true`	Usar uma porcentagem de zoom fixa em vez de recalculação responsiva.
`int`	`FixedZoomPercent`	`100`	Zoom fixo para desktop.
`int`	`FixedZoomPercentMobile`	`75`	Zoom fixo para dispositivos móveis.
`string`	`BasePath`	`"/"`	Onde o visualizador envia solicitações de página. `"/"` é `DocImage.axd` na raiz do site; caso contrário, o ramo onde o host mapeia `UseDoconut()`, sem uma barra inicial `/` (`"doconut"` significa `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` anteriormente)	Pasta de onde o widget carrega suas próprias imagens: a pasta `images` sob `ResourcesPath`, sem uma barra inicial `/`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` ou vazio para nenhum ajuste automático. `"page"` não é aceito pelo widget atual.
`bool`	`RetryOn409`	`false`	Habilitar polling quando uma solicitação de página assíncrona/distribuída responde `409`. Não é necessário para o visualizador síncrono normal.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // sem barra inicial '/': o visualizador a adiciona ("/doconut" se tornaria //doconut, outro host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Mapeamento de C# para JavaScript

Não passe um ViewerConfig serializado diretamente para docViewer(...). A maioria das chaves do widget são camelCase, enquanto três chaves estabelecidas de caminho/ajuste são 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`

Padrões JavaScript

O widget tem padrões mais antigos que diferem da classe C#. Os valores a seguir provêm da implementação atual de docViewer.js.

Opção	Padrão	Observações
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Limites de largura do painel de miniaturas.
`showThumbs`	`true`	Visibilidade inicial das miniaturas.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` difere do padrão C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Geometria das miniaturas em pixels.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` do JavaScript difere do C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Dica de posição da página.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Valores internos de inicialização; normalmente preenchidos por `View(token)`.
`debugMode`	`false`	Diagnósticos adicionais do cliente.
`FitType`	`""`	Nenhum ajuste automático a menos que fornecido.
`BasePath`	`"DocImage.axd"`	Manipulador legado padrão. Defina explicitamente para ASP.NET Core.
`ResPath`	`""`	Defina explicitamente para o caminho das imagens incorporadas.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Janela e atraso de pré-carregamento de páginas em memória.
`autoLoad`	`false`	Fluxo de token explícito é recomendado.
`largeDoc`	`true`	Difere do padrão C#.
`fixedZoom`	`false`	Difere do padrão C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Valor móvel difere do C# (`75`).
`showHyperlinks`	`true`	Requer extração no lado do servidor para produzir sobreposições.

Defina todos os valores importantes de comportamento em vez de depender de qualquer conjunto de padrões:

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>

Retornos de chamada

Callback	Argumentos	Propósito
`onPageLoading`	`pageNum`	Uma solicitação de página está começando.
`onPageLoaded`	`pageNum`	A imagem da página terminou de carregar.
`onThumbnailClicked`	`pageNum`	O usuário selecionou uma miniatura.
`onPageClicked`	`pageNum`	O usuário selecionou uma página.
`onDoubleClick`	none	O visualizador recebeu um duplo clique.
`onViewerBusy`	none	O visualizador entrou em estado ocupado.
`onViewerReady`	none	Inicialização concluída.
`onViewerError`	none	O visualizador entrou em estado de erro.
`onError`	`message`	Uma operação retornou uma mensagem de erro.
`onCopy`	`data`	Dados de cópia de texto estão disponíveis.
`onAutoLoadStatus`	`pageNum`	O carregamento automático avançou para uma página.
`onThumbsShown`	none	O painel de miniaturas ficou visível.
`onAnnLoaded`	none	Dados de anotação carregados.
`onAnnSaved`	none	Dados de anotação salvos.
`onAnnSaveError`	none	Falha ao salvar a anotação.
`onAnnClosed`	none	Interface de anotação fechada.

Mantenha os callbacks rápidos; envie telemetria de forma assíncrona e não bloqueie a renderização da página.

Grupos de métodos públicos

Grupo	Métodos comuns
Ciclo de vida	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navegação	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom e ajuste	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientação	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniaturas	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Busca	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Anotação	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Copiar	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

O arquivo JavaScript também contém auxiliares internos. Considere apenas os métodos usados pela UI de referência e documentados aqui ou nos guias de recursos como pontos de integração estáveis.

Repetir após HTTP 409

retryOn409 serve para produção assíncrona de páginas. Quando habilitado, o widget faz polling com esses padrões JavaScript:

Opção	Padrão
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Deixe desativado para o visualizador normal. Habilitá-lo não pode tornar uma renderização síncrona não suportada assíncrona.

Lista de verificação de caminhos

DoconutOptions.MiddlewarePath deve descrever o ramo que você realmente mapeia.
BasePath deve apontar para esse ramo, escrito sem uma barra inicial / ('doconut', não '/doconut': o visualizador adiciona a barra, e //doconut/... é uma solicitação para outro host).
DoconutOptions.ResourcesPath é a rota de recurso incorporado.
ResPath normalmente aponta para sua subpasta images, também sem uma barra inicial / ('doconut-res/images').
ExtractHyperlinks deve estar habilitado na configuração de formato do servidor antes que showHyperlinks possa exibir algo.