ViewerConfig

Opções do widget visualizador do cliente

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 widget JavaScript de longa data têm padrões diferentes, portanto mapeie os valores explicitamente.

Duas alterações do lado do cliente nesta versão falham silenciosamente. As funções manipuladoras são passadas como opções — o widget não deriva mais nomes de funções globais a partir do ID do contêiner — e ResPath deve apontar para o prefixo de recursos em vez da raiz da aplicação. Ambas deixam o servidor funcionando perfeitamente e não relatam nada no console do navegador. Se você está migrando uma página da biblioteca anterior, leia Retornos de chamada e Lista de verificação de caminho antes de qualquer outra coisa.

Propriedades C#

TipoPropriedadePadrãoDescrição
boolShowThumbstrueExibir o painel de miniaturas.
boolAutoLoadfalseCarregar automaticamente após a inicialização. O fluxo normal de token chama View(token) explicitamente.
boolAutoFocustrueMover o foco/rolagem do navegador para o visualizador durante a inicialização.
boolAutoPageFocustrueManter a miniatura atual visível enquanto as páginas mudam.
intPageZoom100Percentual de zoom inicial.
intZoomStep10Percentual adicionado ou removido pelos comandos de zoom.
intMaxZoom300Percentual máximo de zoom.
boolShowToolTiptrueExibir a dica de posição da página enquanto rola.
stringToolTipPageText"Page "Prefixo usado na dica da página.
boolCacheEnabledfalseManter uma janela móvel de imagens de página na memória do navegador. Não usa localStorage.
boolLargeDocfalseAnexar elementos de página em lotes cronometrados para documentos grandes.
boolShowHyperlinksfalseRenderizar sobreposições de hiperlinks quando a configuração do servidor os extraiu.
boolFixedZoomtrueUsar um percentual de zoom fixo em vez de recalcular responsivamente.
intFixedZoomPercent100Zoom fixo para desktop.
intFixedZoomPercentMobile75Zoom fixo para dispositivos móveis.
stringBasePath"/"Ramo onde o host mapeia UseDoconut().
stringResPath"doconut-res"Base de recursos usada pelo widget. Em uma configuração normal aponte para <ResourcesPath>/images.
stringFitType"width""width", "height" ou vazio para nenhum ajuste automático. "page" não é aceito pelo widget atual.
boolRetryOn409falseHabilitar polling quando a produção de página assíncrona/distribuída responde 202 Accepted; 409 também é aceito por compatibilidade com servidores antigos. 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",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Mapeamento C# → JavaScript

Não passe um ViewerConfig serializado diretamente para docViewer(...). A maioria das chaves do widget usa camelCase, enquanto três chaves estabelecidas de caminho/ajuste usam PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

Padrões JavaScript

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

OpçãoPadrãoObservações
leftMinWidth / leftMaxWidth220 / 800Limites de largura do painel de miniaturas.
showThumbstrueVisibilidade inicial das miniaturas.
autoFocus / autoPageFocustrue / falseautoPageFocus difere do padrão C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometria das miniaturas em pixels.
pageZoom / zoomStep / maxZoom100 / 10 / 200maxZoom JavaScript difere do C# (300).
showToolTip / toolTipPageTexttrue / "Page "Dica de posição da página.
format / doc / AccessToken"" / 0 / ""Valores internos de inicialização; normalmente preenchidos por View(token).
debugModefalseDiagnósticos adicionais do cliente.
FitType""Nenhum ajuste automático a menos que seja fornecido.
BasePath"DocImage.axd"Padrão histórico do cliente mantido por compatibilidade. Hosts ASP.NET Core atuais devem defini‑lo explicitamente para o ramo de middleware mapeado.
ResPath""Definir explicitamente para o caminho de imagens incorporadas.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Janela de pré‑carregamento de páginas em memória e atraso.
autoLoadfalseRecomenda‑se fluxo de token explícito.
largeDoctrueDifere do padrão C#.
fixedZoomfalseDifere do padrão C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Valor móvel difere do C# (75).
showHyperlinkstrueRequer extração no servidor para produzir sobreposições.

Defina todos os valores importantes ao invés de confiar em 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

Retorno de chamadaArgumentosPropósito
onPageLoadingpageNumUma solicitação de página está iniciando.
onPageLoadedpageNumA imagem da página terminou de carregar.
onThumbnailClickedpageNumO usuário selecionou uma miniatura.
onPageClickedpageNumO usuário selecionou uma página.
onDoubleClicknoneO visualizador recebeu um duplo clique.
onViewerBusynoneO visualizador entrou em estado ocupado.
onViewerReadynoneInicialização concluída.
onViewerErrornoneO visualizador entrou em estado de erro.
onErrormessageUma operação retornou uma mensagem de erro.
onCopydataDados de cópia de texto estão disponíveis.
onAutoLoadStatuspageNumAuto‑carregamento avançou para uma página.
onThumbsShownnoneO painel de miniaturas tornou‑se visível.
onAnnLoadednoneDados de anotação carregados.
onAnnSavednoneDados de anotação salvos.
onAnnSaveErrornoneFalha ao salvar anotação.
onAnnClosednoneInterface 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.

Cada um desses é uma opção no objeto de inicialização. O visualizador anterior procurava funções globais cujos nomes eram derivados do ID do contêiner — uma página com <div id="div_ctlDoc"> precisava declarar function ctlDoc_OnViewerReady(). Essa procura foi removida. Passe a função explicitamente:

javascript
objctlDoc = $('#div_ctlDoc').docViewer({
    // ... suas opções existentes ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // antes era encontrado por nome
    onViewerReady:    ctlDoc_OnViewerReady,     // antes era encontrado por nome
    onCopy:           ctlDoc_Copy,              // antes era ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // antes era ctlDoc_AutoLoadStatus(page)
});

A antiga procura estava envolvida em um catch vazio, portanto nada jamais foi relatado. Nesta versão as funções simplesmente nunca são executadas: o sintoma usual é um spinner de carregamento que nunca para, porque o manipulador que o ocultava era onViewerReady. O documento por trás dele está sendo renderizado corretamente.

Não há callback de clique em link — o tratamento de hiperlinks está embutido e controlado por showHyperlinks.

Grupos de métodos públicos

GrupoMétodos comuns
Ciclo de vidaView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavegaçãoGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom e ajusteZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientaçãoRotate(page, angle), Flip(page, flipType)
MiniaturasHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
BuscaCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnotaçãoSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CópiaCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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

Repetição enquanto uma página distribuída ainda está sendo renderizada

retryOn409 mantém seu nome histórico. É usado para produção de página assíncrona e tenta novamente a resposta atual 202 Accepted assim como o sinal mais antigo 409 Conflict. Quando habilitado, o widget faz polling com estes padrões JavaScript:

OpçãoPadrão
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts60
retryMaxTotalMs120000

Deixe desativado para o visualizador normal de nó único. Habilitá‑lo não pode transformar uma renderização síncrona não suportada em assíncrona.

Habilite quando as páginas são servidas a partir de armazenamento compartilhado com FirstPagePriority, onde páginas posteriores legitimamente respondem 202 Accepted até serem gravadas. Um cliente que não repete mostra blocos quebrados para páginas ainda em renderização — veja Implantações Distribuídas.

Lista de verificação de caminho

  • DoconutOptions.MiddlewarePath deve descrever o ramo que você realmente mapeia.
  • BasePath deve apontar para esse ramo. A aplicação de referência mantém a forma histórica de requisição DocImage.axd em um ramo MapWhen e, portanto, define BasePath: '/'.
  • DoconutOptions.ResourcesPath é a rota de recurso incorporado.
  • ResPath normalmente aponta para sua subpasta /images'doconut-res/images' com o prefixo padrão. Um ResPath vazio era correto na biblioteca anterior, onde os recursos vinham da raiz da aplicação; não está correto aqui e falha sem gerar erro.
  • ExtractHyperlinks deve estar habilitado na configuração de formato do servidor antes que showHyperlinks possa exibir qualquer coisa.

Esta página foi útil?