Updated FAQ (markdown)

Ian Gilman 2023-07-11 13:52:40 -07:00
parent d30af8d4ef
commit bf0e0c5c12

9
FAQ.md

@ -3,6 +3,7 @@
* [Why do I see white borders between tiles?](#tile-borders)
* [OpenSeadragon doesn't work well on mobile devices in portrait orientation](#mobile-portrait)
* [OpenSeadragon isn't working right in my Vue application](#vue)
* [Can I use TIFF files in OpenSeadragon?](#tiff)
## Questions and Answers
@ -16,4 +17,10 @@ Especially when using images with transparency, you may see seams between tiles.
In portrait mode, by default the browser loads a much wider page and then zooms it down, which means the device doing a lot more work than it has to, and it can lead to major delays in loading and navigating an image. This behavior should be fixed by setting `<meta name="viewport" content="width=device-width, initial-scale=1" />` in the `<head>` section of your HTML. (https://github.com/openseadragon/openseadragon/issues/2342#issuecomment-1524071957).
### <a name="vue"></a>OpenSeadragon isn't working right in my Vue application
As of OpenSeadragon release 4.0.0, the technique that `Vue2` uses to observe changes in objects/values interferes with the library. `Vue3` should be used instead. If `Vue2` must be used, to fix this issue, `$.extend` can be replaced by `Object.assign` here: https://github.com/openseadragon/openseadragon/blob/ebab356c207e626b6622f88ffcb0cd28b918f85d/src/viewer.js#L1626
As of OpenSeadragon release 4.0.0, the technique that `Vue2` uses to observe changes in objects/values interferes with the library. `Vue3` should be used instead. If `Vue2` must be used, to fix this issue, `$.extend` can be replaced by `Object.assign` here: https://github.com/openseadragon/openseadragon/blob/ebab356c207e626b6622f88ffcb0cd28b918f85d/src/viewer.js#L1626
### <a name="tiff"></a>Can I use TIFF files in OpenSeadragon?
OpenSeadragon doesn't support TIFF files directly, but you have a number of options. You could:
* Convert your TIFF file to one of the formats OpenSeadragon supports, like DZI. There are lots of tools for that at https://openseadragon.github.io/examples/creating-zooming-images/.
* Use a server that converts the TIFF file on the fly, like https://iipimage.sourceforge.io/.
* Use the https://github.com/pearcetm/GeoTIFFTileSource plugin.