ViewerConfig – Doconut Documentazione

ViewerConfig (namespace Doconut) descrive l'aspetto e il comportamento del visualizzatore del browser. Non influisce sulla qualità del rendering del documento; usa una configurazione di formato per questo. La classe C# e il plugin JavaScript legacy hanno impostazioni predefinite diverse, quindi mappa i valori esplicitamente.

Proprietà C#

Tipo	Proprietà	Predefinito	Descrizione
`bool`	`ShowThumbs`	`true`	Mostra il pannello delle miniature.
`bool`	`AutoLoad`	`false`	Carica automaticamente dopo l'inizializzazione. Il flusso normale del token chiama esplicitamente `View(token)`.
`bool`	`AutoFocus`	`true`	Sposta il focus/scroll del browser sul visualizzatore durante l'inizializzazione.
`bool`	`AutoPageFocus`	`true`	Mantieni la miniatura corrente visibile mentre le pagine cambiano.
`int`	`PageZoom`	`100`	Percentuale di zoom iniziale.
`int`	`ZoomStep`	`10`	Percentuale aggiunta o rimossa dai comandi di zoom.
`int`	`MaxZoom`	`300`	Percentuale massima di zoom.
`bool`	`ShowToolTip`	`true`	Mostra il tooltip della posizione della pagina durante lo scorrimento.
`string`	`ToolTipPageText`	`"Page "`	Prefisso usato nel tooltip della pagina.
`bool`	`CacheEnabled`	`false`	Mantiene una finestra mobile di immagini delle pagine nella memoria del browser. Non utilizza `localStorage`.
`bool`	`LargeDoc`	`false`	Aggiunge gli elementi delle pagine in batch temporizzati per documenti di grandi dimensioni.
`bool`	`ShowHyperlinks`	`false`	Renderizza le sovrapposizioni dei collegamenti ipertestuali quando la configurazione del server li ha estratti.
`bool`	`FixedZoom`	`true`	Usa una percentuale di zoom fissa invece di un ricalcolo responsivo.
`int`	`FixedZoomPercent`	`100`	Zoom fisso per desktop.
`int`	`FixedZoomPercentMobile`	`75`	Zoom fisso per mobile.
`string`	`BasePath`	`"/"`	Ramo dove l'host mappa `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	Base delle risorse usata dal widget. In una configurazione normale puntala a `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` o vuoto per nessun adattamento automatico. `"page"` non è accettato dal widget corrente.
`bool`	`RetryOn409`	`false`	Abilita il polling quando una richiesta di pagina asincrona/distribuita risponde `409`. Non necessario per il visualizzatore sincrono normale.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Mappatura C# a JavaScript

Do not pass a directly serialized ViewerConfig to docViewer(...). Most widget keys are camelCase, while three established path/fit keys are 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`

Predefiniti JavaScript

The widget has older defaults that differ from the C# class. The following values come from the current docViewer.js implementation.

Opzione	Predefinito	Note
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Limiti di larghezza del pannello delle miniature.
`showThumbs`	`true`	Visibilità iniziale delle miniature.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` differisce dal valore predefinito C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Geometria delle miniature in pixel.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` JavaScript differisce da C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Tooltip della posizione della pagina.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Valori di inizializzazione interni; normalmente popolati da `View(token)`.
`debugMode`	`false`	Diagnostica client aggiuntiva.
`FitType`	`""`	Nessun adattamento automatico a meno che non sia fornito.
`BasePath`	`"DocImage.axd"`	Valore predefinito del gestore legacy. Impostalo esplicitamente per ASP.NET Core.
`ResPath`	`""`	Impostalo esplicitamente al percorso delle immagini incorporate.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Finestra e ritardo di pre-caricamento delle pagine in memoria.
`autoLoad`	`false`	Si raccomanda un flusso di token esplicito.
`largeDoc`	`true`	Differisce dal valore predefinito C#.
`fixedZoom`	`false`	Differisce dal valore predefinito C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Il valore mobile differisce da C# (`75`).
`showHyperlinks`	`true`	Richiede l'estrazione lato server per produrre le sovrapposizioni.

Set all behaviorally important values instead of relying on either set of defaults:

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>

Callback

Callback	Argomenti	Scopo
`onPageLoading`	`pageNum`	Una richiesta di pagina sta iniziando.
`onPageLoaded`	`pageNum`	Un'immagine di pagina ha terminato il caricamento.
`onThumbnailClicked`	`pageNum`	L'utente ha selezionato una miniatura.
`onPageClicked`	`pageNum`	L'utente ha selezionato una pagina.
`onDoubleClick`	none	Il visualizzatore ha ricevuto un doppio click.
`onViewerBusy`	none	Il visualizzatore è entrato in uno stato occupato.
`onViewerReady`	none	Inizializzazione completata.
`onViewerError`	none	Il visualizzatore è entrato nello stato di errore.
`onError`	`message`	Un'operazione ha restituito un messaggio di errore.
`onCopy`	`data`	I dati di copia del testo sono disponibili.
`onAutoLoadStatus`	`pageNum`	Il caricamento automatico è progredito a una pagina.
`onThumbsShown`	none	Il pannello delle miniature è diventato visibile.
`onAnnLoaded`	none	Dati di annotazione caricati.
`onAnnSaved`	none	Dati di annotazione salvati.
`onAnnSaveError`	none	Salvataggio dell'annotazione fallito.
`onAnnClosed`	none	Interfaccia di annotazione chiusa.

Mantieni le callback rapide; invia telemetria in modo asincrono e non bloccare il rendering della pagina.

Gruppi di metodi pubblici

Gruppo	Metodi comuni
Ciclo di vita	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigazione	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom e adattamento	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientamento	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniature	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Ricerca	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Annotazione	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Copia	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

Il file JavaScript contiene anche helper interni. Considera stabili solo i metodi usati dall'interfaccia di riferimento e documentati qui o nelle guide funzionali come punti di integrazione.

Retry dopo HTTP 409

retryOn409 è per la produzione di pagine asincrone. Quando abilitato, il widget effettua polling con questi valori predefiniti JavaScript:

Opzione	Predefinito
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Lascialo disabilitato per il visualizzatore normale. Abilitarlo non può trasformare un rendering sincrono non supportato in asincrono.

Checklist dei percorsi

DoconutOptions.MiddlewarePath deve descrivere il ramo che effettivamente mappi.
BasePath deve puntare a quel ramo.
DoconutOptions.ResourcesPath è il percorso delle risorse incorporate.
ResPath normalmente punta alla sua sottocartella /images.
ExtractHyperlinks deve essere abilitato nella configurazione del formato server prima che showHyperlinks possa visualizzare qualcosa.