Configuring a Neo4j Browser with a default custom GRASS style #171

dhimmel · 2016-05-26T01:13:09Z

I've created a public read-only instance of our Neo4j database at http://neo4j.het.io/ (thanks @jexp for the help). I'd like to have a custom GRASS style applied to every browser instance by default.

On StackOverflow @ikwattro mentioned that:

The style is set in the browser local storage, I'm afraid all users will have to issue the :style command.

So I could always instruct users to run:

:style https://raw.githubusercontent.com/dhimmel/hetionet/383152be2c07f8f5427dd7069535c82b0c5e8d85/hetnet/neo4j/graphstyle.grass

Is there an automated workaround, so users don't have to execute this command? If not, then I'd like suggest a feature request to couple a specific Neo4j database with a custom style. It seems like styles make sense on a per database level, rather than a per browser level. Or perhaps on a per database per browser level, but with a database default.

The text was updated successfully, but these errors were encountered:

oskarhane · 2016-05-26T06:52:47Z

Sure, you can set the server config

browser.post_connect_cmd=style https://raw.githubusercontent.com/dhimmel/hetionet/383152be2c07f8f5427dd7069535c82b0c5e8d85/hetnet/neo4j/graphstyle.grass

in the file neo4j.conf.

Untested, but should work.
Notice the lack of : before style because of the command character is a user setting so the browser takes care of prefixing that to the command.

ikwattro · 2016-05-26T06:54:46Z

@oskarhane Wow that's very cool. Correct me if I'm wrong but there is no such setting in the operations manual ?

Anyway guys, this is awesome !

oskarhane · 2016-05-26T06:59:10Z

@ikwattro you might be correct, it's a quite new feature: http://neo4j.com/release-notes/neo4j-3-0-1/
I'll put it on the docs teams wall. Thanks.

ikwattro · 2016-05-26T07:21:03Z

Thanks, you guys rock ! Shame on me for not having checked the changelog

dhimmel · 2016-05-26T17:27:00Z

Thanks @oskarhane. The browser.post_connect_cmd setting in neo4j.conf is a great feature!. I've gotten browser.post_connect_cmd=play cypher to work and pre-play the cypher guide.

However, it looks like my style command from above doesn't work even when I run it directly from the browser. I'm guessing it could be a CORS issue (as with playing guides from URL in #170). However, the failure is silent. Assuming that reading from a URL is the cause of failure, is there a way to put the GRASS file inside of the Neo4j instance's directory structure and specify a local file with :style?

oskarhane · 2016-05-27T07:30:03Z

Yes, that's probably due to a CORS issue.
There's no supported way of loading a local grass file without user interaction.
Pretty ugly solution, but you could load grass by giving the :style command raw grass input.

:style

node {
  diameter: 50px;
  color: #A5ABB6;
  border-color: #9AA1AC;
  border-width: 2px;
  text-color-internal: #FFFFFF;
  font-size: 10px;
}

relationship {
  color: #A5ABB6;
  shaft-width: 1px;
  font-size: 8px;
  padding: 3px;
  text-color-external: #000000;
  text-color-internal: #FFFFFF;
  caption: '<type>';
}

node.Movie {
  color: #68BDF6;
  border-color: #5CA8DB;
  text-color-internal: #FFFFFF;
  caption: '{title}';
}

node.Person {
  color: #6DCE9E;
  border-color: #60B58B;
  text-color-internal: #FFFFFF;
  caption: '{name}';
}

To put that in the conf file you probably have to replace newlines with spaces.

dhimmel · 2016-05-27T17:40:00Z

Confirming that the failure to load the style from URL was a CORS issue. My web browser console picked up the following error:

XMLHttpRequest cannot load https://raw.githubusercontent.com/dhimmel/hetionet/383152be2c07f8f5427dd7069535c82b0c5e8d85/hetnet/neo4j/graphstyle.grass. Request header field Pragma is not allowed by Access-Control-Allow-Headers in preflight response.

I plan to proceed by applying one of the workarounds, but I think a way to preload a local grass file without user interaction would be good in the longterm.

Also confirming that the one line hack (see code snippet below) works. Therefore, if #172 gets implemented, configuration with a local grass file would be less pressing.

:style node {   diameter: 50px;   color: #A5ABB6;   border-color: #9AA1AC;   border-width: 1px;   text-color-internal: #FFFFFF;   font-size: 10px; }  relationship {   color: #A5ABB6;   shaft-width: 1.5px;   font-size: 8px;   padding: 3px;   text-color-external: #000000;   text-color-internal: #FFFFFF;   caption: '<type>'; }  node.Gene {   color: #0096FF;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.Pathway {   color: #FF9300;   border-color: #FFFFFF;   text-color-internal: #000000;   caption: '{name}'; }  node.Anatomy {   color: #008F00;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.Disease {   color: #8E4F00;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.Compound {   color: #FF2600;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.CellularComponent {   color: #FF9300;   border-color: #FFFFFF;   text-color-internal: #000000;   caption: '{name}'; }  node.BiologicalProcess {   color: #FF9300;   border-color: #FFFFFF;   text-color-internal: #000000;   caption: '{name}'; }  node.SideEffect {   color: #FFFB00;   border-color: #FFFFFF;   text-color-internal: #000000;   caption: '{name}'; }  node.Symptom {   color: #A5ABB6;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.PharmacologicClass {   color: #FF85FF;   border-color: #FFFFFF;   text-color-internal: #FFFFFF;   caption: '{name}'; }  node.MolecularFunction {   color: #FF9300;   border-color: #FFFFFF;   text-color-internal: #000000;   caption: '{name}'; }

Since there's no supported builtin way of loading a local grass file (see neo4j/neo4j-browser#171), hosting grass files using the guide-extension would be handy.

Need to be able to color by node. I think this will help: neo4j/neo4j-browser#171

oskarhane · 2017-06-27T09:17:25Z

This looks like it's resolved, so I'll close this.

References: neo4j/neo4j-browser#172 neo4j/neo4j-browser#171 neo4j/neo4j-browser#548 neo4j/neo4j#9403

Khazl · 2018-02-07T11:20:14Z

I run neo4j Version: 3.3.2 in a docker container and tried to configure a default style as described above.

Grass file is accessible via HTTP (http://domain.com/resources/style.grass)
CORS rules are set
Command added to config: browser.post_connect_cmd=style http://domain.com/resources/style.grass

When i start my container with this config and run match (n) return n i see nothing.
Then i run :style http://domain.com/resources/style.grass and it works... Why?
That leads me to conclude that the grass file ifself (content) and the accessible of this file are not the problem.
It seems that there is an error with the default style configuration.
Do you have any tips to debug this? The logs are clean.

chillier · 2018-06-29T09:51:30Z

For Khazl and others: The solution is to strip carriage returns from style.grass file, (with no "play" command in the grass file). Then the config command has the "style" command -

browser.post_connect_cmd=style http://domain.com/resources/style.grass

You may will have to whitelist "domain.com" with a config statement.
browser.remote_content_hostname_whitelist=*
#(or domain.com)

References: neo4j/neo4j-browser#172 neo4j/neo4j-browser#171 neo4j/neo4j-browser#548 neo4j/neo4j#9403 Former-commit-id: 35e42cb

suchetaswabhav · 2019-03-25T10:03:24Z

Hi,

Can you please tell me where can i find the neo4j.conf file. Because if i make it manually and insert like i did for .grass file and inserted it in favorites, the neo4j.conf file is not acceptable .

Error - .conf is not a valid extension.

oskarhane · 2019-03-25T10:05:08Z

@suchetaswabhav The neo4j conf file is in the database directory, under the conf/ folder.

suchetaswabhav · 2019-03-25T10:06:41Z

I use the image file to open the Neo4j browser and database ..what to do ?

suchetaswabhav · 2019-03-25T10:54:32Z

Thanks oskarhane... i found out . You get it in Graph Applications tab - > Open folder -> configuration

Evin686 · 2019-08-22T02:48:06Z

Hi，guys
Is there a way to preload a local grass file? one line hack,doesn't seem to work

TheRealMarcusChiu · 2021-02-18T23:46:14Z

@Evin686 it probably broke because of this feature implementation #548

FatihSarigol · 2022-02-10T16:06:25Z

Sure, you can set the server config
browser.post_connect_cmd=style https://raw.githubusercontent.com/dhimmel/hetionet/383152be2c07f8f5427dd7069535c82b0c5e8d85/hetnet/neo4j/graphstyle.grass
in the file neo4j.conf.

Untested, but should work. Notice the lack of : before style because of the command character is a user setting so the browser takes care of prefixing that to the command.

This is great but I just wanna make a remark here because importing grass file from some websites just doesn't work, I tried 1 https and 1 http server to host my grass file but both failed, finally I hoped that it would work from github rawfiles and it did. I don't know why the other servers did not work, I can LOAD CSV files from one of them to the same NEO4J browser for instance, but when it is a :style grassfile command it just didn't access the file, regardless of my permission for the server in conf settings.

by the way, calling the grass file from the neo4j/import directory also failed, and so did the one liner style trick inside the conf file

Evin686 · 2022-02-10T16:06:44Z

你好，我是叶文，我已经收到您的邮件啦，谢谢你的来信

dhimmel mentioned this issue May 26, 2016

Allow multiple post-connect commands in neo4j.conf #172

Closed

dhimmel mentioned this issue Jun 10, 2016

Enable guide-extension to serve grass files neo4j-contrib/neo4j-guides#7

Merged

JanetMatsen added a commit to JanetMatsen/Neo4j_meta4 that referenced this issue Nov 7, 2016

The whole network is in, for the 20-line example.

824a292

Need to be able to color by node. I think this will help: neo4j/neo4j-browser#171

oskarhane closed this as completed Jun 27, 2017

dhimmel added a commit to hetio/hetionet that referenced this issue Sep 18, 2017

browser.post_connect_cmd: autoload GRASS style

35e42cb

References: neo4j/neo4j-browser#172 neo4j/neo4j-browser#171 neo4j/neo4j-browser#548 neo4j/neo4j#9403

dhimmel added a commit to hetio/hetionet that referenced this issue Nov 7, 2018

browser.post_connect_cmd: autoload GRASS style

e32551d

References: neo4j/neo4j-browser#172 neo4j/neo4j-browser#171 neo4j/neo4j-browser#548 neo4j/neo4j#9403 Former-commit-id: 35e42cb

pwrose mentioned this issue Oct 3, 2023

Specify grass style file in neo4j.conf sbl-sdsc/kg-import#3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configuring a Neo4j Browser with a default custom GRASS style #171

Configuring a Neo4j Browser with a default custom GRASS style #171

dhimmel commented May 26, 2016

oskarhane commented May 26, 2016 •

edited

Loading

ikwattro commented May 26, 2016 •

edited

Loading

oskarhane commented May 26, 2016

ikwattro commented May 26, 2016 •

edited

Loading

dhimmel commented May 26, 2016

oskarhane commented May 27, 2016 •

edited

Loading

dhimmel commented May 27, 2016 •

edited

Loading

oskarhane commented Jun 27, 2017

Khazl commented Feb 7, 2018

chillier commented Jun 29, 2018

suchetaswabhav commented Mar 25, 2019

oskarhane commented Mar 25, 2019

suchetaswabhav commented Mar 25, 2019 •

edited

Loading

suchetaswabhav commented Mar 25, 2019

Evin686 commented Aug 22, 2019 •

edited

Loading

TheRealMarcusChiu commented Feb 18, 2021

FatihSarigol commented Feb 10, 2022 •

edited

Loading

Evin686 commented Feb 10, 2022 via email

Configuring a Neo4j Browser with a default custom GRASS style #171

Configuring a Neo4j Browser with a default custom GRASS style #171

Comments

dhimmel commented May 26, 2016

oskarhane commented May 26, 2016 • edited Loading

ikwattro commented May 26, 2016 • edited Loading

oskarhane commented May 26, 2016

ikwattro commented May 26, 2016 • edited Loading

dhimmel commented May 26, 2016

oskarhane commented May 27, 2016 • edited Loading

dhimmel commented May 27, 2016 • edited Loading

oskarhane commented Jun 27, 2017

Khazl commented Feb 7, 2018

chillier commented Jun 29, 2018

suchetaswabhav commented Mar 25, 2019

oskarhane commented Mar 25, 2019

suchetaswabhav commented Mar 25, 2019 • edited Loading

suchetaswabhav commented Mar 25, 2019

Evin686 commented Aug 22, 2019 • edited Loading

TheRealMarcusChiu commented Feb 18, 2021

FatihSarigol commented Feb 10, 2022 • edited Loading

Evin686 commented Feb 10, 2022 via email

oskarhane commented May 26, 2016 •

edited

Loading

ikwattro commented May 26, 2016 •

edited

Loading

ikwattro commented May 26, 2016 •

edited

Loading

oskarhane commented May 27, 2016 •

edited

Loading

dhimmel commented May 27, 2016 •

edited

Loading

suchetaswabhav commented Mar 25, 2019 •

edited

Loading

Evin686 commented Aug 22, 2019 •

edited

Loading

FatihSarigol commented Feb 10, 2022 •

edited

Loading