Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

release v0.11.0 #88

Merged
merged 1 commit into from
Oct 27, 2023
Merged

release v0.11.0 #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions versioned_docs/version-0.11.0/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Frequently Asked Questions
---

A list of frequently asked questions about Gosling.js.

## How to debug gosling specs?

To check whether your gosling spec is valid, you can either
- copy-and-paste your spec on the [online Editor](http://gosling.js.org) to see if there is any warning message.
- call a validation function `console.log(gosling.validateGoslingSpec(yourSpec));`

## How to show Gosling Tooltips that are hidden under other components?
You can modify the z-index of the tooltip components to address this issue.

```css
/* override styles of tooltips */
.track-mouseover-menu {
z-index: 1;
}
```
HiGlass defines the original [CSS styles of the tooltips](https://github.com/higlass/higlass/blob/54f5aae61d3474f9e868621228270f0c90ef9343/app/styles/HiGlass.module.scss#L54).


## The component is rendered in React but there is no visualization

<img src="https://user-images.githubusercontent.com/44389194/136196719-abefef53-49e0-4ea5-8dae-a438fa6d5f33.png" alt="bug_screenshot"/>

For problems like this, please ensure that you have added the following style sheets in your base html file.

```html
<head>
...
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
<link rel="stylesheet" href="https://unpkg.com/higlass@1.11.3/dist/hglib.css">
</head>
```
Please refer to [Use Gosling.js in React App](./#use-goslingjs-in-react-app) for more details.

## How to make Gosling visualizations responsive?

To make Gosling visualizations responsive, you need to listen to the resize event and update the `width` property accordingly.
Below is an example in React app.

```javascript
// Change the width upon resize event of the browser
useEffect(() => {
window.addEventListener(
"resize",
debounce(() => {
// this value is used to set `width` of a track when updating spec
setVisPanelWidth( window.innerWidth );
}, 500) // wait for 500ms instead of updating right away
);
}, []);
```
Loading
Loading