search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``igraph`.`drawing`.`graph`.`GephiGraphStreamingDrawer``

class documentation

`class GephiGraphStreamingDrawer(AbstractGraphDrawer): (source)`

Constructor: `GephiGraphStreamingDrawer(conn, *args, **kwds)`

View In Hierarchy

Graph drawer that sends a graph to a file-like object (e.g., socket, URL connection, file) using the Gephi graph streaming format.

The Gephi graph streaming format is a simple JSON-based format that can be used to post mutations to a graph (i.e. node and edge additions, removals and updates) to a remote component. For instance, one can open up Gephi (http://www.gephi.org), install the Gephi graph streaming plugin and then send a graph from igraph straight into the Gephi window by using `GephiGraphStreamingDrawer` with the appropriate URL where Gephi is listening.

The `connection` property exposes the `GephiConnection` that the drawer uses. The drawer also has a property called `streamer` which exposes the underlying `GephiGraphStreamer` that is responsible for generating the JSON objects, encoding them and writing them to a file-like object. If you want to customize the encoding process, this is the object where you can tweak things to your taste.

Method | `__init__` | Constructs a Gephi graph streaming drawer that will post graphs to the given Gephi connection. If `conn` is `None`, the remaining arguments of the constructor are forwarded intact to the constructor of `GephiConnection`...
Method | `draw` | Draws (i.e. sends) the given graph to the destination of the drawer using the Gephi graph streaming API.
Instance Variable | `connection` | Undocumented
Instance Variable | `streamer` | Undocumented

Inherited from `AbstractGraphDrawer`:

Static Method | `ensure_layout` | Helper method that ensures that layout is an instance of `Layout`. If it is not, the method will try to convert it to a `Layout` according to the following rules:
Static Method | `_determine_edge_order` | Returns the order in which the edge of the given graph have to be drawn, assuming that the relevant keyword arguments (`edge_order` and `edge_order_by`) are given in `kwds` as a dictionary. If neither `edge_order`...
Static Method | `_determine_vertex_order` | Returns the order in which the vertices of the given graph have to be drawn, assuming that the relevant keyword arguments (`vertex_order` and `vertex_order_by`) are given in `kwds` as a dictionary. If neither ...

def __init__(self, conn=None, *args, **kwds): (source)

Constructs a Gephi graph streaming drawer that will post graphs to the given Gephi connection. If `conn` is `None`, the remaining arguments of the constructor are forwarded intact to the constructor of `GephiConnection` in order to create a connection. This means that any of the following are valid:

- `GephiGraphStreamingDrawer()` will construct a drawer that connects to workspace 0 of the local Gephi instance on port 8080.
- `GephiGraphStreamingDrawer(workspace=2)` will connect to workspace 2 of the local Gephi instance on port 8080.
- `GephiGraphStreamingDrawer(port=1234)` will connect to workspace 0 of the local Gephi instance on port 1234.
- `GephiGraphStreamingDrawer(host="remote", port=1234, workspace=7)` will connect to workspace 7 of the Gephi instance on host `remote`, port 1234.
- `GephiGraphStreamingDrawer(url="http://remote:1234/workspace7)` is the same as above, but with an explicit URL.

def draw(self, graph, *args, **kwds): (source)
overrides `igraph.drawing.baseclasses.AbstractGraphDrawer.draw`

Draws (i.e. sends) the given graph to the destination of the drawer using the Gephi graph streaming API.

The following keyword arguments are allowed:

- `encoder` lets one specify an instance of `json.JSONEncoder` that will be used to encode the JSON objects.

connection = (source)

Undocumented

streamer = (source)

Undocumented