Merge pull request #16361 from timvandermeij/jsdoc-pdfvieweroptions

Declare the `linkService` and `l10n` properties as optional in the `PDFViewerOptions` documentation
This commit is contained in:
Jonas Jenwald 2023-04-27 17:16:32 +02:00 committed by GitHub
commit cefa8c601a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -83,7 +83,7 @@ function isValidAnnotationEditorMode(mode) {
* @property {HTMLDivElement} container - The container for the viewer element. * @property {HTMLDivElement} container - The container for the viewer element.
* @property {HTMLDivElement} [viewer] - The viewer element. * @property {HTMLDivElement} [viewer] - The viewer element.
* @property {EventBus} eventBus - The application event bus. * @property {EventBus} eventBus - The application event bus.
* @property {IPDFLinkService} linkService - The navigation/linking service. * @property {IPDFLinkService} [linkService] - The navigation/linking service.
* @property {IDownloadManager} [downloadManager] - The download manager * @property {IDownloadManager} [downloadManager] - The download manager
* component. * component.
* @property {PDFFindController} [findController] - The find controller * @property {PDFFindController} [findController] - The find controller
@ -115,7 +115,7 @@ function isValidAnnotationEditorMode(mode) {
* @property {number} [maxCanvasPixels] - The maximum supported canvas size in * @property {number} [maxCanvasPixels] - The maximum supported canvas size in
* total pixels, i.e. width * height. Use -1 for no limit. The default value * total pixels, i.e. width * height. Use -1 for no limit. The default value
* is 4096 * 4096 (16 mega-pixels). * is 4096 * 4096 (16 mega-pixels).
* @property {IL10n} l10n - Localization service. * @property {IL10n} [l10n] - Localization service.
* @property {boolean} [enablePermissions] - Enables PDF document permissions, * @property {boolean} [enablePermissions] - Enables PDF document permissions,
* when they exist. The default value is `false`. * when they exist. The default value is `false`.
* @property {Object} [pageColors] - Overwrites background and foreground colors * @property {Object} [pageColors] - Overwrites background and foreground colors