This is an automated email from the ASF dual-hosted git repository. spmallette pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit 15094c933f85b275cf3a0601d5be22d516a6c937 Author: Stephen Mallette <[email protected]> AuthorDate: Tue Nov 20 10:04:27 2018 -0500 Added some notes about Gephi and :remote instances CTR --- docs/src/reference/gremlin-applications.asciidoc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc index 43a2201..7c503e2 100644 --- a/docs/src/reference/gremlin-applications.asciidoc +++ b/docs/src/reference/gremlin-applications.asciidoc @@ -2368,6 +2368,30 @@ Gephi plugin configuration parameters as accepted via the `:remote config` comma NOTE: This plugin is typically only useful to the Gremlin Console and is enabled in the there by default. +The instructions above assume that the `Graph` instance being visualized is local to the Gremlin Console. It makes that +assumption because the Gephi plugin requires a locally held `Graph`. If the intent is to visualize a `Graph` instance +hosted in Gremlin Server or a TinkerPop-enabled graph that can only be connected to in a "remote" fashion, then it +is still possible to use the Gephi plugin, but the requirement for a locally held `Graph` remains the same. To use +the Gephi plugin in these situations simply use <<subgraph-step,subgraph()-step>> to extract the portion of the remote +graph that will be visualized. Use of that step will return a `TinkerGraph` instance to the Gremlin Console at which +point it can be used locally with the Gephi plugin. The following example demonstrates the general steps: + +[source,text] +---- +gremlin> :remote connect tinkerpop.server conf/remote-objects.yaml <1> +... +gremlin> :> g.E().hasLabel('knows').subgraph('subGraph').cap('subGraph') <2> +... +gremlin> graph = result[0].object <3> +... +---- + +<1> Be sure to connect with a serializer configured to return objects and not their `toString()` representation which +is discussed in more detail in the <<connecting-via-console, Connecting Via Console>> Section. +<2> Use the `:>` command to subgraph the remote graph as needed. +<3> The `TinkerGraph` of that previous traversal can be found in the `result` object and now that the `Graph` is local +to Gremlin Console it can be used with Gephi as shown in the prior instruction set. + [[giraph-plugin]] === Giraph Plugin
