diff --git a/FAQ.md b/FAQ.md index 3014a68..eb72ee5 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1 +1,19 @@ -Coming soon! \ No newline at end of file +# Frequently Asked Questions +* [I created an OpenSeadragon viewer. Why don't I see anything?](./#size) +* [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) + +## Questions and Answers + +### I created an OpenSeadragon viewer. Why don't I see anything? +The viewer must be given a non-zero size - both **width** and **height** - in order to see the results. Use your browser's developer tools to inspect the viewer element and see the width and height that are computed. One common problem is not defining the `height` of the viewer. Most of the time, `width` is non-zero by default, because `div` elements are full-width. However, if you have the viewer within a container with `display: grid;` or similar, you may need to define `width` or `min-width` to ensure the viewer can be seen. + +### Why do I see white borders between tiles? +Especially when using images with transparency, you may see seams between tiles. As of release 3.0.1, you can set `subPixelRoundingForTransparency: OpenSeadragon.SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS` to help address this visual artifact of the tile stitching operation (see https://github.com/openseadragon/openseadragon/discussions/2085#discussioncomment-1957842). Note that this does not fully solve the issue - for example, when the viewer and/or image are rotated, seams may still appear. This is due to intrinsic limitations of `canvas context2d` drawing, and an enhancement to support WebGL drawing is planned. + +### OpenSeadragon doesn't work well on mobile devices in portrait orientation +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 `` in the `` section of your HTML. (https://github.com/openseadragon/openseadragon/issues/2342#issuecomment-1524071957). + +### 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 \ No newline at end of file