cairo_draw.py 83.2 KB
Newer Older
Tiago Peixoto's avatar
Tiago Peixoto committed
1 2 3 4 5
#! /usr/bin/env python
# -*- coding: utf-8 -*-
#
# graph_tool -- a general graph manipulation python module
#
Tiago Peixoto's avatar
Tiago Peixoto committed
6
# Copyright (C) 2006-2015 Tiago de Paula Peixoto <tiago@skewed.de>
Tiago Peixoto's avatar
Tiago Peixoto committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

21
from __future__ import division, absolute_import, print_function
22 23 24
import sys
if sys.version_info < (3,):
    range = xrange
25

Tiago Peixoto's avatar
Tiago Peixoto committed
26 27
import os
import warnings
28
import numpy
Tiago Peixoto's avatar
Tiago Peixoto committed
29 30 31 32

try:
    import cairo
except ImportError:
33
    msg = "Error importing cairo. Graph drawing will not work."
34
    warnings.warn(msg, RuntimeWarning)
35
    raise
Tiago Peixoto's avatar
Tiago Peixoto committed
36

Tiago Peixoto's avatar
Tiago Peixoto committed
37
default_cm = None
Tiago Peixoto's avatar
Tiago Peixoto committed
38
try:
39 40
    import matplotlib.artist
    import matplotlib.backends.backend_cairo
41 42
    import matplotlib.cm
    import matplotlib.colors
43
    from matplotlib.cbook import flatten
44 45 46 47 48 49 50 51 52 53 54 55 56 57
    default_clrs = [(0.5529411764705883, 0.8274509803921568, 0.7803921568627451, 1.0),
                    #(1.0, 1.0, 0.7019607843137254, 1.0),
                    (0.7450980392156863, 0.7294117647058823, 0.8549019607843137, 1.0),
                    (0.984313725490196, 0.5019607843137255, 0.4470588235294118, 1.0),
                    (0.5019607843137255, 0.6941176470588235, 0.8274509803921568, 1.0),
                    (0.9921568627450981, 0.7058823529411765, 0.3843137254901961, 1.0),
                    (0.7019607843137254, 0.8705882352941177, 0.4117647058823529, 1.0),
                    (0.9882352941176471, 0.803921568627451, 0.8980392156862745, 1.0),
                    (0.8509803921568627, 0.8509803921568627, 0.8509803921568627, 1.0),
                    (0.7372549019607844, 0.5019607843137255, 0.7411764705882353, 1.0),
                    (0.8, 0.9215686274509803, 0.7725490196078432, 1.0),
                    (1.0, 0.9294117647058824, 0.43529411764705883, 1.0)]
    default_cm = matplotlib.colors.LinearSegmentedColormap.from_list("Set3",
                                                                     default_clrs)
58
    is_draw_inline = 'inline' in matplotlib.get_backend()
Tiago Peixoto's avatar
Tiago Peixoto committed
59
except ImportError:
60
    msg = "Error importing matplotlib module. Graph drawing will not work."
61
    warnings.warn(msg, RuntimeWarning)
62
    raise
Tiago Peixoto's avatar
Tiago Peixoto committed
63

64 65
try:
    import IPython.display
Tiago Peixoto's avatar
Tiago Peixoto committed
66
except ImportError:
67 68
    pass

Tiago Peixoto's avatar
Tiago Peixoto committed
69 70 71 72
import numpy as np
import gzip
import bz2
import zipfile
73
import copy
74
import io
Tiago Peixoto's avatar
Tiago Peixoto committed
75 76
from collections import defaultdict

77
from .. import Graph, GraphView, PropertyMap, ungroup_vector_property,\
78 79
     group_vector_property, _prop, _check_prop_vector

Tiago Peixoto's avatar
Tiago Peixoto committed
80 81 82
from .. stats import label_parallel_edges, label_self_loops

from .. dl_import import dl_import
83
dl_import("from . import libgraph_tool_draw")
Tiago Peixoto's avatar
Tiago Peixoto committed
84
try:
85
    from .libgraph_tool_draw import vertex_attrs, edge_attrs, vertex_shape,\
Tiago Peixoto's avatar
Tiago Peixoto committed
86 87
        edge_marker
except ImportError:
88 89
    msg = "Error importing cairo-based drawing library. " + \
        "Was graph-tool compiled with cairomm support?"
90
    warnings.warn(msg, RuntimeWarning)
Tiago Peixoto's avatar
Tiago Peixoto committed
91 92

from .. draw import sfdp_layout, random_layout, _avg_edge_distance, \
93 94 95 96 97 98 99 100 101
    coarse_graphs, radial_tree_layout, prop_to_size

try:
    from matplotlib.colors import colorConverter
except ImportError:
    pass

from .. generation import graph_union
from .. topology import shortest_path
Tiago Peixoto's avatar
Tiago Peixoto committed
102 103 104

_vdefaults = {
    "shape": "circle",
105 106
    "color": (0.6, 0.6, 0.6, 0.8),
    "fill_color": (0.6470588235294118, 0.058823529411764705, 0.08235294117647059, 0.8),
Tiago Peixoto's avatar
Tiago Peixoto committed
107
    "size": 5,
108
    "aspect": 1.,
109
    "anchor": 1,
Tiago Peixoto's avatar
Tiago Peixoto committed
110 111 112
    "pen_width": 0.8,
    "halo": 0,
    "halo_color": [0., 0., 1., 0.5],
113
    "halo_size": 1.5,
Tiago Peixoto's avatar
Tiago Peixoto committed
114 115 116
    "text": "",
    "text_color": [0., 0., 0., 1.],
    "text_position": -1.,
117 118
    "text_rotation": 0.,
    "text_offset": [0., 0.],
Tiago Peixoto's avatar
Tiago Peixoto committed
119 120 121
    "font_family": "serif",
    "font_slant": cairo.FONT_SLANT_NORMAL,
    "font_weight": cairo.FONT_WEIGHT_NORMAL,
122
    "font_size": 12.,
123 124
    "surface": None,
    "pie_fractions": [0.75, 0.25],
125
    "pie_colors": default_clrs # ('b', 'g', 'r', 'c', 'm', 'y', 'k')
Tiago Peixoto's avatar
Tiago Peixoto committed
126 127 128
    }

_edefaults = {
129
    "color": (0.1796875, 0.203125, 0.2109375, 0.8),
Tiago Peixoto's avatar
Tiago Peixoto committed
130 131 132 133 134
    "pen_width": 1,
    "start_marker": "none",
    "mid_marker": "none",
    "end_marker": "none",
    "marker_size": 4.,
135
    "mid_marker_pos": .5,
Tiago Peixoto's avatar
Tiago Peixoto committed
136
    "control_points": [],
Tiago Peixoto's avatar
Tiago Peixoto committed
137
    "gradient": [],
138
    "dash_style": [],
139
    "text": "",
140
    "text_color": (0., 0., 0., 1.),
141 142 143 144 145 146
    "text_distance": 5,
    "text_parallel": True,
    "font_family": "serif",
    "font_slant": cairo.FONT_SLANT_NORMAL,
    "font_weight": cairo.FONT_WEIGHT_NORMAL,
    "font_size": 12.,
147
    "sloppy": False
Tiago Peixoto's avatar
Tiago Peixoto committed
148 149 150 151 152 153 154 155 156 157 158 159
    }


def shape_from_prop(shape, enum):
    if isinstance(shape, PropertyMap):
        if shape.key_type() == "v":
            prop = shape.get_graph().new_vertex_property("int")
            descs = shape.get_graph().vertices()
        else:
            descs = shape.get_graph().edges()
            prop = shape.get_graph().new_edge_property("int")
        offset = min(enum.values.keys())
160
        vals = dict([(int(k - offset), v) for k, v in enum.values.items()])
Tiago Peixoto's avatar
Tiago Peixoto committed
161 162 163
        for v in descs:
            if shape.value_type() == "string":
                prop[v] = int(enum.__dict__[shape[v]])
164 165 166 167
            elif int(shape[v]) in vals:
                prop[v] = int(vals[int(shape[v])])
            elif int(shape[v]) - offset in vals:
                prop[v] = int(vals[int(shape[v]) - offset])
Tiago Peixoto's avatar
Tiago Peixoto committed
168
            else:
169 170
                raise ValueError("Invalid value for attribute %s: %s" %
                                 (repr(enum), repr(shape[v])))
Tiago Peixoto's avatar
Tiago Peixoto committed
171 172 173 174 175 176 177 178 179 180
        return prop

    if isinstance(shape, str):
        return int(enum.__dict__[shape])
    else:
        return shape

    raise ValueError("Invalid value for attribute %s: %s" %
                     (repr(enum), repr(shape)))

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
def open_file(name, mode="r"):
    name = os.path.expanduser(name)
    base, ext = os.path.splitext(name)
    if ext == ".gz":
        out = gzip.GzipFile(name, mode)
        name = base
    elif ext == ".bz2":
        out = bz2.BZ2File(name, mode)
        name = base
    elif ext == ".zip":
        out = zipfile.ZipFile(name, mode)
        name = base
    else:
        out = open(name, mode)
    fmt = os.path.splitext(name)[1].replace(".", "")
196
    return out, fmt
197

198 199 200 201 202 203 204 205 206 207 208 209
def get_file_fmt(name):
    name = os.path.expanduser(name)
    base, ext = os.path.splitext(name)
    if ext == ".gz":
        name = base
    elif ext == ".bz2":
        name = base
    elif ext == ".zip":
        name = base
    fmt = os.path.splitext(name)[1].replace(".", "")
    return fmt

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224

def surface_from_prop(surface):
    if isinstance(surface, PropertyMap):
        if surface.key_type() == "v":
            prop = surface.get_graph().new_vertex_property("object")
            descs = surface.get_graph().vertices()
        else:
            descs = surface.get_graph().edges()
            prop = surface.get_graph().new_edge_property("object")
        surface_map = {}
        for v in descs:
            if surface.value_type() == "string":
                if surface[v] not in surface_map:
                    sfc = gen_surface(surface[v])
                    surface_map[surface[v]] = sfc
225
                prop[v] = surface_map[surface[v]]
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
            elif surface.value_type() == "python::object":
                if isinstance(surface[v], cairo.Surface):
                    prop[v] = surface[v]
                else:
                    raise ValueError("Invalid value type for surface property: " +
                                     str(type(surface[v])))
            else:
                raise ValueError("Invalid value type for surface property: " +
                                 surface.value_type())
        return prop

    if isinstance(surface, str):
        return gen_surface(surface)
    elif isinstance(surface, cairo.Surface) or surface is None:
        return surface

    raise ValueError("Invalid value for attribute surface: " + repr(surface))

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
def centered_rotation(g, pos, text_pos=True):
    x, y = ungroup_vector_property(pos, [0, 1])
    cm = (x.fa.mean(), y.fa.mean())
    dx = x.fa - cm[0]
    dy = y.fa - cm[0]
    angle = g.new_vertex_property("double")
    angle.fa = numpy.arctan2(dy, dx)
    pi = numpy.pi
    angle.fa += 2 * pi
    angle.fa %= 2 * pi
    if text_pos:
        idx = (angle.a > pi / 2 ) * (angle.a < 3 * pi / 2)
        tpos = g.new_vertex_property("double")
        angle.a[idx] += pi
        tpos.a[idx] = pi
        return angle, tpos
    return angle
Tiago Peixoto's avatar
Tiago Peixoto committed
261 262 263 264

def _convert(attr, val, cmap):
    if attr == vertex_attrs.shape:
        return shape_from_prop(val, vertex_shape)
265 266
    if attr == vertex_attrs.surface:
        return surface_from_prop(val)
Tiago Peixoto's avatar
Tiago Peixoto committed
267 268 269 270
    if attr in [edge_attrs.start_marker, edge_attrs.mid_marker,
                edge_attrs.end_marker]:
        return shape_from_prop(val, edge_marker)

271 272 273 274
    if attr in [vertex_attrs.pie_colors]:
        if isinstance(val, PropertyMap):
            if val.value_type() in ["vector<double>", "vector<long double>"]:
                return val
275
            if val.value_type() in ["vector<int32_t>", "vector<int64_t>", "vector<bool>"]:
276 277 278 279 280
                g = val.get_graph()
                new_val = g.new_vertex_property("vector<double>")
                rg = [float("inf"), -float("inf")]
                for v in g.vertices():
                    for x in val[v]:
281 282
                        rg[0] = min(x, rg[0])
                        rg[1] = max(x, rg[1])
283 284 285
                if rg[0] == rg[1]:
                    rg[1] = 1
                for v in g.vertices():
286
                    new_val[v] = flatten([cmap((x - rg[0]) / (rg[1] - rg[0])) for x in val[v]])
287
                return new_val
288 289 290 291
            if val.value_type() == "vector<string>":
                g = val.get_graph()
                new_val = g.new_vertex_property("vector<double>")
                for v in g.vertices():
292
                    new_val[v] = flatten([matplotlib.colors.ColorConverter().to_rgba(x) for x in val[v]])
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                return new_val
            if val.value_type() == "python::object":
                try:
                    g = val.get_graph()
                    new_val = g.new_vertex_property("vector<double>")
                    for v in g.vertices():
                        try:
                            new_val[v] = [float(x) for x in flatten(val[v])]
                        except ValueError:
                            new_val[v] = flatten([matplotlib.colors.ColorConverter().to_rgba(x) for x in val[v]])
                    return new_val
                except ValueError:
                    pass
        else:
            try:
                return [float(x) for x in flatten(val)]
            except ValueError:
                try:
                    new_val = flatten(matplotlib.colors.ColorConverter().to_rgba(x) for x in val)
                    return list(new_val)
                except ValueError:
                    pass
Tiago Peixoto's avatar
Tiago Peixoto committed
315
    if attr in [vertex_attrs.color, vertex_attrs.fill_color,
316
                vertex_attrs.text_color, vertex_attrs.halo_color,
317
                edge_attrs.color, edge_attrs.text_color]:
Tiago Peixoto's avatar
Tiago Peixoto committed
318 319 320 321 322 323 324 325 326 327 328
        if isinstance(val, list):
            return val
        if isinstance(val, (tuple, np.ndarray)):
            return list(val)
        if isinstance(val, str):
            return list(matplotlib.colors.ColorConverter().to_rgba(val))
        if isinstance(val, PropertyMap):
            if val.value_type() in ["vector<double>", "vector<long double>"]:
                return val
            if val.value_type() in ["int32_t", "int64_t", "double",
                                    "long double", "unsigned long", "bool"]:
Tiago Peixoto's avatar
Tiago Peixoto committed
329 330 331
                try:
                    vrange = [val.fa.min(), val.fa.max()]
                except ValueError:
Tiago Peixoto's avatar
Tiago Peixoto committed
332 333 334 335 336
                    vrange = val[val.get_graph().vertex(0)]
                    vrange = [vrange, vrange]
                    for v in val.get_graph().vertices():
                        vrange[0] = min(vrange[0], val[v])
                        vrange[1] = max(vrange[1], val[v])
337
                cnorm = matplotlib.colors.Normalize(vmin=vrange[0],
Tiago Peixoto's avatar
Tiago Peixoto committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
                                                    vmax=vrange[1])
                if val.key_type() == "v":
                    prop = val.get_graph().new_vertex_property("vector<double>")
                    descs = val.get_graph().vertices()
                else:
                    prop = val.get_graph().new_edge_property("vector<double>")
                    descs = val.get_graph().edges()
                for v in descs:
                    prop[v] = cmap(cnorm(val[v]))
                return prop
            if val.value_type() == "string":
                if val.key_type() == "v":
                    prop = val.get_graph().new_vertex_property("vector<double>")
                    for v in val.get_graph().vertices():
                        prop[v] = matplotlib.colors.ColorConverter().to_rgba(val[v])
                elif val.key_type() == "e":
                    prop = val.get_graph().new_edge_property("vector<double>")
                    for e in val.get_graph().edges():
                        prop[e] = matplotlib.colors.ColorConverter().to_rgba(val[e])
                return prop
        raise ValueError("Invalid value for attribute %s: %s" %
                         (repr(attr), repr(val)))
    return val


def _attrs(attrs, d, g, cmap):
    nattrs = {}
    defaults = {}
366
    for k, v in list(attrs.items()):
Tiago Peixoto's avatar
Tiago Peixoto committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
        try:
            if d == "v":
                attr = vertex_attrs.__dict__[k]
            else:
                attr = edge_attrs.__dict__[k]
        except KeyError:
            warnings.warn("Unknown attribute: " + k, UserWarning)
            continue
        if isinstance(v, PropertyMap):
            nattrs[int(attr)] = _prop(d, g, _convert(attr, v, cmap))
        else:
            defaults[int(attr)] = _convert(attr, v, cmap)
    return nattrs, defaults


def get_attr(attr, d, attrs, defaults):
    if attr in attrs:
        p = attrs[attr]
    else:
        p = defaults[attr]
    if isinstance(p, PropertyMap):
        return p[d]
    else:
        return p


393 394
def position_parallel_edges(g, pos, loop_angle=float("nan"),
                            parallel_distance=1):
Tiago Peixoto's avatar
Tiago Peixoto committed
395 396
    lp = label_parallel_edges(GraphView(g, directed=False))
    ll = label_self_loops(g)
397 398 399 400 401 402
    if isinstance(loop_angle, PropertyMap):
        angle = loop_angle
    else:
        angle = g.new_vertex_property("double")
        angle.a = float(loop_angle)

Tiago Peixoto's avatar
Tiago Peixoto committed
403
    g = GraphView(g, directed=True)
404 405
    if ((len(lp.fa) == 0 or lp.fa.max() == 0) and
        (len(ll.fa) == 0 or ll.fa.max() == 0)):
Tiago Peixoto's avatar
Tiago Peixoto committed
406 407 408 409
        return []
    else:
        spline = g.new_edge_property("vector<double>")
        libgraph_tool_draw.put_parallel_splines(g._Graph__graph,
410
                                                _prop("v", g, pos),
Tiago Peixoto's avatar
Tiago Peixoto committed
411
                                                _prop("e", g, lp),
412
                                                _prop("e", g, spline),
413
                                                _prop("v", g, angle),
414
                                                parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
415 416 417 418 419 420
        return spline


def parse_props(prefix, args):
    props = {}
    others = {}
421
    for k, v in list(args.items()):
Tiago Peixoto's avatar
Tiago Peixoto committed
422 423 424 425 426 427 428 429
        if k.startswith(prefix + "_"):
            props[k.replace(prefix + "_", "")] = v
        else:
            others[k] = v
    return props, others


def cairo_draw(g, pos, cr, vprops=None, eprops=None, vorder=None, eorder=None,
430 431
               nodesfirst=False, vcmap=default_cm,
               ecmap=default_cm, loop_angle=float("nan"),
432
               parallel_distance=None, fit_view=False, **kwargs):
Tiago Peixoto's avatar
Tiago Peixoto committed
433
    r"""
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
    Draw a graph to a :mod:`cairo` context.

    Parameters
    ----------
    g : :class:`~graph_tool.Graph`
        Graph to be drawn.
    pos : :class:`~graph_tool.PropertyMap`
        Vector-valued vertex property map containing the x and y coordinates of
        the vertices.
    cr : :class:`~cairo.Context`
        A :class:`~cairo.Context` instance.
    vprops : dict (optional, default: ``None``)
        Dictionary with the vertex properties. Individual properties may also be
        given via the ``vertex_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    eprops : dict (optional, default: ``None``)
        Dictionary with the vertex properties. Individual properties may also be
        given via the ``edge_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    vorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the vertices are drawn.
    eorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the edges are drawn.
    nodesfirst : bool (optional, default: ``False``)
        If ``True``, the vertices are drawn first, otherwise the edges are.
459
    vcmap : :class:`matplotlib.colors.Colormap` (optional, default: :class:`default_cm`)
460
        Vertex color map.
461
    ecmap : :class:`matplotlib.colors.Colormap` (optional, default: :class:`default_cm`)
462
        Edge color map.
463
    loop_angle : float or :class:`~graph_tool.PropertyMap` (optional, default: ``nan``)
464 465 466 467 468
        Angle used to draw self-loops. If ``nan`` is given, they will be placed
        radially from the center of the layout.
    parallel_distance : float (optional, default: ``None``)
        Distance used between parallel edges. If not provided, it will be
        determined automatically.
469
    fit_view : bool or float or tuple (optional, default: ``True``)
470
        If ``True``, the layout will be scaled to fit the entire clip region.
471
        If a float value is given, it will be interpreted as ``True``, and in
472 473 474
        addition the viewport will be scaled out by that factor. If a tuple
        value is given, it should have four values ``(x, y, w, h)`` that
        specify the view in user coordinates.
475 476
    bg_color : str or sequence (optional, default: ``None``)
        Background color. The default is transparent.
477 478 479 480 481 482 483 484
    vertex_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``vertex_<prop-name>`` specify the
        vertex property with name ``<prop-name>``, as an alternative to the
        ``vprops`` parameter.
    edge_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``edge_<prop-name>`` specify the edge
        property with name ``<prop-name>``, as an alternative to the ``eprops``
        parameter.
Tiago Peixoto's avatar
Tiago Peixoto committed
485 486 487

    """

488 489
    vprops = {} if vprops is None else copy.copy(vprops)
    eprops = {} if eprops is None else copy.copy(eprops)
Tiago Peixoto's avatar
Tiago Peixoto committed
490 491 492 493 494 495 496 497

    props, kwargs = parse_props("vertex", kwargs)
    vprops.update(props)
    props, kwargs = parse_props("edge", kwargs)
    eprops.update(props)
    for k in kwargs:
        warnings.warn("Unknown parameter: " + k, UserWarning)

498
    cr.save()
499
    if fit_view != False:
500 501
        extents = cr.clip_extents()
        output_size = (extents[2] - extents[0], extents[3] - extents[1])
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
        try:
            x, y, w, h = fit_view
            cr.scale(output_size[0] / w, output_size[1] / h)
            cr.translate(-x, -y)
        except TypeError:
            offset, zoom = fit_to_view(g, pos, output_size,
                                       vprops.get("size", _vdefaults["size"]),
                                       vprops.get("pen_width", _vdefaults["pen_width"]),
                                       None, vprops.get("text", None),
                                       vprops.get("font_family",
                                                  _vdefaults["font_family"]),
                                       vprops.get("font_size",
                                                  _vdefaults["font_size"]),
                                       cr)
            cr.translate(offset[0], offset[1])
            if not isinstance(fit_view, bool):
                zoom /= fit_view
            cr.scale(zoom, zoom)
520

Tiago Peixoto's avatar
Tiago Peixoto committed
521
    if "control_points" not in eprops:
522 523 524 525 526 527 528 529 530 531
        if parallel_distance is None:
            parallel_distance = vprops.get("size", _vdefaults["size"])
            if isinstance(parallel_distance, PropertyMap):
                parallel_distance = parallel_distance.fa.mean()
            parallel_distance /= 1.5
            M = cr.get_matrix()
            scale = transform_scale(M, 1,)
            parallel_distance /= scale
        eprops["control_points"] = position_parallel_edges(g, pos, loop_angle,
                                                           parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
532 533
    if g.is_directed() and "end_marker" not in eprops:
        eprops["end_marker"] = "arrow"
534

535 536 537 538 539
    if vprops.get("text_position", None) == "centered":
        angle, tpos = centered_rotation(g, pos, text_pos=True)
        vprops["text_position"] = tpos
        vprops["text_rotation"] = angle

Tiago Peixoto's avatar
Tiago Peixoto committed
540 541 542 543 544 545
    vattrs, vdefaults = _attrs(vprops, "v", g, vcmap)
    eattrs, edefaults = _attrs(eprops, "e", g, ecmap)
    vdefs = _attrs(_vdefaults, "v", g, vcmap)[1]
    vdefs.update(vdefaults)
    edefs = _attrs(_edefaults, "e", g, ecmap)[1]
    edefs.update(edefaults)
546 547 548 549 550 551

    if "control_points" not in eprops:
        if parallel_distance is None:
            parallel_distance = _defaults
        eprops["control_points"] = position_parallel_edges(g, pos, loop_angle,
                                                           parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
552 553 554 555
    g = GraphView(g, directed=True)
    libgraph_tool_draw.cairo_draw(g._Graph__graph, _prop("v", g, pos),
                                  _prop("v", g, vorder), _prop("e", g, eorder),
                                  nodesfirst, vattrs, eattrs, vdefs, edefs, cr)
556
    cr.restore()
Tiago Peixoto's avatar
Tiago Peixoto committed
557 558


559 560
def color_contrast(color):
    c = np.asarray(color)
561 562
    y = c[0] * .299 + c[1] * .587 + c[2] * .114
    if y < .5:
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
        c[:3] = 1
    else:
        c[:3] = 0
    return c


def auto_colors(g, bg, pos, back):
    c = g.new_vertex_property("vector<double>")
    for v in g.vertices():
        if isinstance(bg, PropertyMap):
            bgc = bg[v]
        elif isinstance(bg, str):
            bgc = matplotlib.colors.ColorConverter().to_rgba(bg)
        else:
            bgc = bg
        if isinstance(pos, PropertyMap):
            p = pos[v]
        else:
581 582 583 584
            if pos == "centered":
                p = 0
            else:
                p = pos
585 586 587 588 589 590
        if p < 0:
            c[v] = color_contrast(bgc)
        else:
            c[v] = color_contrast(back)
    return c

Tiago Peixoto's avatar
Tiago Peixoto committed
591 592
def graph_draw(g, pos=None, vprops=None, eprops=None, vorder=None, eorder=None,
               nodesfirst=False, output_size=(600, 600), fit_view=True,
593
               inline=is_draw_inline, mplfig=None, output=None, fmt="auto", **kwargs):
594 595 596 597 598 599 600 601 602 603 604 605 606 607
    r"""Draw a graph to screen or to a file using :mod:`cairo`.

    Parameters
    ----------
    g : :class:`~graph_tool.Graph`
        Graph to be drawn.
    pos : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        Vector-valued vertex property map containing the x and y coordinates of
        the vertices. If not given, it will be computed using :func:`sfdp_layout`.
    vprops : dict (optional, default: ``None``)
        Dictionary with the vertex properties. Individual properties may also be
        given via the ``vertex_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    eprops : dict (optional, default: ``None``)
608
        Dictionary with the edge properties. Individual properties may also be
609 610 611 612 613 614 615 616 617 618 619
        given via the ``edge_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    vorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the vertices are drawn.
    eorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the edges are drawn.
    nodesfirst : bool (optional, default: ``False``)
        If ``True``, the vertices are drawn first, otherwise the edges are.
    output_size : tuple of scalars (optional, default: ``(600,600)``)
        Size of the drawing canvas. The units will depend on the output format
        (pixels for the screen, points for PDF, etc).
620 621 622 623 624 625
    fit_view : bool, float or tuple (optional, default: ``True``)
        If ``True``, the layout will be scaled to fit the entire clip region.
        If a float value is given, it will be interpreted as ``True``, and in
        addition the viewport will be scaled out by that factor. If a tuple
        value is given, it should have four values ``(x, y, w, h)`` that
        specify the view in user coordinates.
626 627 628
    inline : bool (optional, default: ``False``)
        If ``True`` and an `IPython notebook <http://ipython.org/notebook>`_  is
        being used, an inline version of the drawing will be returned.
629 630 631 632 633
    mplfig : :mod:`matplotlib` container object (optional, default: ``None``)
        The ``mplfig`` object needs to have an ``artists`` attribute. This can
        for example be a :class:`matplotlib.figure.Figure` or
        :class:`matplotlib.axes.Axes`. Only the cairo backend is supported; use
        ``switch_backend('cairo')``.
634 635
    output : string or file object (optional, default: ``None``)
        Output file name (or object). If not given, the graph will be displayed via
636 637 638 639 640
        :func:`interactive_window`.
    fmt : string (default: ``"auto"``)
        Output file format. Possible values are ``"auto"``, ``"ps"``, ``"pdf"``,
        ``"svg"``, and ``"png"``. If the value is ``"auto"``, the format is
        guessed from the ``output`` parameter.
641 642
    bg_color : str or sequence (optional, default: ``None``)
        Background color. The default is transparent.
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    vertex_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``vertex_<prop-name>`` specify the
        vertex property with name ``<prop-name>``, as an alternative to the
        ``vprops`` parameter.
    edge_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``edge_<prop-name>`` specify the edge
        property with name ``<prop-name>``, as an alternative to the ``eprops``
        parameter.
    **kwargs
        Any extra parameters are passed to :func:`~graph_tool.draw.interactive_window`,
        :class:`~graph_tool.draw.GraphWindow`, :class:`~graph_tool.draw.GraphWidget`
        and :func:`~graph_tool.draw.cairo_draw`.

    Returns
    -------
    pos : :class:`~graph_tool.PropertyMap`
        Vector vertex property map with the x and y coordinates of the vertices.
    selected : :class:`~graph_tool.PropertyMap` (optional, only if ``output is None``)
        Boolean-valued vertex property map marking the vertices which were
        selected interactively.

    Notes
    -----


    .. table:: **List of vertex properties**

        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | Name          | Description                                       | Accepted types         | Default Value                    |
        +===============+===================================================+========================+==================================+
        | shape         | The vertex shape. Can be one of the following     | ``str`` or ``int``     | ``"circle"``                     |
        |               | strings: "circle", "triangle", "square",          |                        |                                  |
        |               | "pentagon", "hexagon", "heptagon", "octagon"      |                        |                                  |
        |               | "double_circle", "double_triangle",               |                        |                                  |
        |               | "double_square", "double_pentagon",               |                        |                                  |
        |               | "double_hexagon", "double_heptagon",              |                        |                                  |
679
        |               | "double_octagon", "pie".                          |                        |                                  |
680 681 682 683 684 685 686 687 688 689 690 691 692
        |               | Optionally, this might take a numeric value       |                        |                                  |
        |               | corresponding to position in the list above.      |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | color         | Color used to stroke the lines of the vertex.     | ``str`` or list of     | ``[0., 0., 0., 1]``              |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | fill_color    | Color used to fill the interior of the vertex.    | ``str`` or list of     | ``[0.640625, 0, 0, 0.9]``        |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | size          | The size of the vertex, in the default units of   | ``float`` or ``int``   | ``5``                            |
        |               | the output format (normally either pixels or      |                        |                                  |
        |               | points).                                          |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
693 694
        | aspect        | The aspect ratio of the vertex.                   | ``float`` or ``int``   | ``1.0``                          |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
695 696 697 698
        | anchor        | Specifies how the edges anchor to the vertices.   |  ``int``               | ``1``                            |
        |               | If `0`, the anchor is at the center of the vertex,|                        |                                  |
        |               | otherwise it is at the border.                    |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
699 700 701 702 703 704 705 706 707 708
        | pen_width     | Width of the lines used to draw the vertex, in    | ``float`` or ``int``   | ``0.8``                          |
        |               | the default units of the output format (normally  |                        |                                  |
        |               | either pixels or points).                         |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | halo          | Whether to draw a circular halo around the        | ``bool``               | ``False``                        |
        |               | vertex.                                           |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | halo_color    | Color used to draw the halo.                      | ``str`` or list of     | ``[0., 0., 1., 0.5]``            |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
709 710 711
        | halo_size     | Relative size of the halo.                        | ``float``              | ``1.5``                          |
        |               |                                                   |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
712 713
        | text          | Text to draw together with the vertex.            | ``str``                | ``""``                           |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
714 715 716
        | text_color    | Color used to draw the text. If the value is      | ``str`` or list of     | ``"auto"``                       |
        |               | ``"auto"``, it will be computed based on          | ``floats``             |                                  |
        |               | fill_color to maximize contrast.                  |                        |                                  |
717 718
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_position | Position of the text relative to the vertex.      | ``float`` or ``int``   | ``-1``                           |
719
        |               | If the passed value is positive, it will          |  or ``"centered"``     |                                  |
720 721 722
        |               | correspond to an angle in radians, which will     |                        |                                  |
        |               | determine where the text will be placed outside   |                        |                                  |
        |               | the vertex. If the value is negative, the text    |                        |                                  |
723 724
        |               | will be placed inside the vertex. If the value is |                        |                                  |
        |               | ``-1``, the vertex size will be automatically     |                        |                                  |
725 726 727
        |               | increased to accommodate the text. The special    |                        |                                  |
        |               | value ``"centered"`` positions the texts rotated  |                        |                                  |
        |               | radially around the center of mass.               |                        |                                  |
728
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
729 730 731 732 733 734
        | text_offset   | Text position offset.                             | list of ``float``      | ``[0.0, 0.0]``                   |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_rotation | Angle of rotation (in radians) for the text.      | ``float``              | ``0.0``                          |
        |               | The center of rotation is the position of the     |                        |                                  |
        |               | vertex.                                           |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
735 736 737 738 739 740 741 742
        | font_family   | Font family used to draw the text.                | ``str``                | ``"serif"``                      |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_slant    | Font slant used to draw the text.                 | ``cairo.FONT_SLANT_*`` | :data:`cairo.FONT_SLANT_NORMAL`  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_weight   | Font weight used to draw the text.                | ``cairo.FONT_WEIGHT_*``| :data:`cairo.FONT_WEIGHT_NORMAL` |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_size     | Font size used to draw the text.                  | ``float`` or ``int``   | ``12``                           |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
743 744
        | surface       | The cairo surface used to draw the vertex. If     | :class:`cairo.Surface` | ``None``                         |
        |               | the value passed is a string, it is interpreted   | or ``str``             |                                  |
Tiago Peixoto's avatar
Tiago Peixoto committed
745
        |               | as an image file name to be loaded.               |                        |                                  |
746
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
747 748 749 750 751 752
        | pie_fractions | Fractions of the pie sections for the vertices if | list of ``int`` or     | ``[0.75, 0.25]``                 |
        |               | ``shape=="pie"``.                                 | ``float``              |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | pie_colors    | Colors used in the pie sections if                | list of strings or     | ``('b','g','r','c','m','y','k')``|
        |               | ``shape=="pie"``.                                 | ``float``.             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
753 754 755 756 757 758 759 760 761 762 763 764 765 766


    .. table:: **List of edge properties**

        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | Name           | Description                                       | Accepted types         | Default Value                    |
        +================+===================================================+========================+==================================+
        | color          | Color used to stroke the edge lines.              | ``str`` or list of     | ``[0.179, 0.203,0.210, 0.8]``    |
        |                |                                                   | floats                 |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | pen_width      | Width of the line used to draw the edge, in       | ``float`` or ``int``   | ``1.0``                          |
        |                | the default units of the output format (normally  |                        |                                  |
        |                | either pixels or points).                         |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
767
        | start_marker,  | Edge markers. Can be one of "none", "arrow",      | ``str`` or ``int``     | ``none``                         |
768 769 770 771
        | mid_marker,    | "circle", "square", "diamond", or "bar".          |                        |                                  |
        | end_marker     | Optionally, this might take a numeric value       |                        |                                  |
        |                | corresponding to position in the list above.      |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
772 773
        | mid_marker_pos | Relative position of the middle marker.           | ``float``              | ``0.5``                          |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
774 775 776 777
        | marker_size    | Size of edge markers, in units appropriate to the | ``float`` or ``int``   | ``4``                            |
        |                | output format (normally either pixels or points). |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | control_points | Control points of a Bézier spline used to draw    | sequence of ``floats`` | ``[]``                           |
Tiago Peixoto's avatar
Tiago Peixoto committed
778 779 780 781 782 783 784 785 786
        |                | the edge. Each spline segment requires 6 values   |                        |                                  |
        |                | corresponding to the (x,y) coordinates of the two |                        |                                  |
        |                | intermediary control points and the final point.  |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | gradient       | Stop points of a linear gradient used to stroke   | sequence of ``floats`` | ``[]``                           |
        |                | the edge. Each group of 5 elements is interpreted |                        |                                  |
        |                | as ``[o, r, g, b, a]`` where ``o`` is the offset  |                        |                                  |
        |                | in the range [0, 1] and the remaining values      |                        |                                  |
        |                | specify the colors.                               |                        |                                  |
787
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
788 789 790 791 792 793
        | dash_style     | Dash pattern is specified by an array of positive | sequence of ``floats`` | ``[]``                           |
        |                | values. Each value provides the length of         |                        |                                  |
        |                | alternate "on" and "off" portions of the stroke.  |                        |                                  |
        |                | The last value specifies an offset into the       |                        |                                  |
        |                | pattern at which the stroke begins.               |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
        | text           | Text to draw next to the edges.                   | ``str``                | ``""``                           |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_color     | Color used to draw the text.                      | ``str`` or list of     | ``[0., 0., 0., 1.]``             |
        |                |                                                   | ``floats``             |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_distance  | Distance from the edge and its text.              | ``float`` or ``int``   | ``4``                            |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_parallel  | If ``True`` the text will be drawn parallel to    | ``bool``               | ``True``                         |
        |                | the edges.                                        |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_family    | Font family used to draw the text.                | ``str``                | ``"serif"``                      |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_slant     | Font slant used to draw the text.                 | ``cairo.FONT_SLANT_*`` | :data:`cairo.FONT_SLANT_NORMAL`  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_weight    | Font weight used to draw the text.                | ``cairo.FONT_WEIGHT_*``| :data:`cairo.FONT_WEIGHT_NORMAL` |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_size      | Font size used to draw the text.                  | ``float`` or ``int``   | ``12``                           |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
812 813 814

    Examples
    --------
815 816 817 818 819 820 821
    .. testcode::
       :hide:

       np.random.seed(42)
       gt.seed_rng(42)
       from numpy import sqrt

822 823 824
    >>> g = gt.price_network(1500)
    >>> deg = g.degree_property_map("in")
    >>> deg.a = 4 * (sqrt(deg.a) * 0.5 + 0.4)
825 826
    >>> ebet = gt.betweenness(g)[1]
    >>> ebet.a /= ebet.a.max() / 10.
827 828 829 830 831 832 833 834 835 836
    >>> eorder = ebet.copy()
    >>> eorder.a *= -1
    >>> pos = gt.sfdp_layout(g)
    >>> control = g.new_edge_property("vector<double>")
    >>> for e in g.edges():
    ...     d = sqrt(sum((pos[e.source()].a - pos[e.target()].a) ** 2)) / 5
    ...     control[e] = [0.3, d, 0.7, d]
    >>> gt.graph_draw(g, pos=pos, vertex_size=deg, vertex_fill_color=deg, vorder=deg,
    ...               edge_color=ebet, eorder=eorder, edge_pen_width=ebet,
    ...               edge_control_points=control, # some curvy edges
837 838 839
    ...               output="graph-draw.pdf")
    <...>

840 841 842 843 844 845 846 847 848
    .. testcode::
       :hide:

       gt.graph_draw(g, pos=pos, vertex_size=deg, vertex_fill_color=deg, vorder=deg,
                     edge_color=ebet, eorder=eorder, edge_pen_width=ebet,
                     edge_control_points=control,
                     output="graph-draw.png")


849 850 851
    .. figure:: graph-draw.*
        :align: center

852 853
        SFDP force-directed layout of a Price network with 1500 nodes. The
        vertex size and color indicate the degree, and the edge color and width
854
        the edge betweenness centrality.
855 856 857

    """

Tiago Peixoto's avatar
Tiago Peixoto committed
858 859 860 861 862 863 864 865 866
    vprops = vprops.copy() if vprops is not None else {}
    eprops = eprops.copy() if eprops is not None else {}

    props, kwargs = parse_props("vertex", kwargs)
    vprops.update(props)
    props, kwargs = parse_props("edge", kwargs)
    eprops.update(props)

    if pos is None:
867
        if (g.num_vertices() > 2 and output is None and
868
            not inline and kwargs.get("update_layout", True)):
Tiago Peixoto's avatar
Tiago Peixoto committed
869 870 871 872 873 874 875 876 877
            L = np.sqrt(g.num_vertices())
            pos = random_layout(g, [L, L])
            if g.num_vertices() > 1000:
                if "multilevel" not in kwargs:
                    kwargs["multilevel"] = True
            if "layout_K" not in kwargs:
                kwargs["layout_K"] = _avg_edge_distance(g, pos) / 10
        else:
            pos = sfdp_layout(g)
878 879
    else:
        _check_prop_vector(pos, name="pos", floating=True)
880
        if output is None and not inline:
881 882 883 884
            if "layout_K" not in kwargs:
                kwargs["layout_K"] = _avg_edge_distance(g, pos)
            if "update_layout" not in kwargs:
                kwargs["update_layout"] = False
Tiago Peixoto's avatar
Tiago Peixoto committed
885

886 887 888 889 890 891 892 893
    if "pen_width" in eprops and "marker_size" not in eprops:
        pw = eprops["pen_width"]
        if isinstance(pw, PropertyMap):
            pw = pw.copy()
            pw.a = pw.a * 2.75
            eprops["marker_size"] = pw
        else:
            eprops["marker_size"] = pw * 2.75
894

895 896 897 898 899 900 901 902 903
    if "text" in eprops and "text_distance" not in eprops and "pen_width" in eprops:
        pw = eprops["pen_width"]
        if isinstance(pw, PropertyMap):
            pw = pw.copy()
            pw.a *= 2
            eprops["text_distance"] = pw
        else:
            eprops["text_distance"] = pw * 2

904
    if "text" in vprops and ("text_color" not in vprops or vprops["text_color"] == "auto"):
905 906
        vcmap = kwargs.get("vcmap", matplotlib.cm.jet)
        bg = _convert(vertex_attrs.fill_color, vprops.get("fill_color", _vdefaults["fill_color"]), vcmap)
907 908 909 910 911 912 913 914 915
        if "bg_color" in kwargs:
            bg_color = kwargs["bg_color"]
        else:
            bg_color = [1., 1., 1., 1.]
        vprops["text_color"] = auto_colors(g, bg,
                                           vprops.get("text_position",
                                                      _vdefaults["text_position"]),
                                           bg_color)

916
    if mplfig:
917 918 919 920 921 922 923 924 925 926 927 928
        ax = None
        if isinstance(mplfig, matplotlib.figure.Figure):
            ctr = ax = mplfig.gca()
        elif isinstance(mplfig, matplotlib.axes.Axes):
            ctr = ax = mplfig
        else:
            ctr = mplfig

        artist = GraphArtist(g, pos, vprops, eprops, vorder, eorder, nodesfirst,
                             ax, **kwargs)
        ctr.artists.append(artist)

929 930 931 932 933 934 935 936 937
        if fit_view != False and ax is not None:
            try:
                x, y, w, h = fit_view
            except TypeError:
                x, y = ungroup_vector_property(pos, [0, 1])
                l, r = x.a.min(), x.a.max()
                b, t = y.a.min(), y.a.max()
                w = r - l
                h = t - b
938 939 940 941
            ax.set_xlim(l - w * .1, r + w * .1)
            ax.set_ylim(b - h * .1, t + h * .1)

        return pos
942

943 944
    if inline:
        if fmt == "auto":
945 946 947 948 949
            if output is None:
                fmt = "png"
            else:
                fmt = get_file_fmt(output)
        output_file = output
950 951
        output = io.BytesIO()

952
    if output is None:
953 954 955 956 957 958 959 960
        for p, val in vprops.items():
            if isinstance(val, PropertyMap):
                vprops[p] = _convert(vertex_attrs.__dict__[p], val,
                                     kwargs.get("vcmap", default_cm))
        for p, val in eprops.items():
            if isinstance(val, PropertyMap):
                eprops[p] = _convert(edge_attrs.__dict__[p], val,
                                     kwargs.get("ecmap", default_cm))
Tiago Peixoto's avatar
Tiago Peixoto committed
961 962 963
        return interactive_window(g, pos, vprops, eprops, vorder, eorder,
                                  nodesfirst, **kwargs)
    else:
964 965 966 967 968 969
        if isinstance(output, str):
            out, auto_fmt = open_file(output, mode="wb")
        else:
            out = output
            if fmt == "auto":
                raise ValueError("File format must be specified.")
Tiago Peixoto's avatar
Tiago Peixoto committed
970 971

        if fmt == "auto":
972
            fmt = auto_fmt
Tiago Peixoto's avatar
Tiago Peixoto committed
973 974 975 976
        if fmt == "pdf":
            srf = cairo.PDFSurface(out, output_size[0], output_size[1])
        elif fmt == "ps":
            srf = cairo.PSSurface(out, output_size[0], output_size[1])
Tiago Peixoto's avatar
Tiago Peixoto committed
977 978 979
        elif fmt == "eps":
            srf = cairo.PSSurface(out, output_size[0], output_size[1])
            srf.set_eps(True)
Tiago Peixoto's avatar
Tiago Peixoto committed
980 981 982 983 984 985 986 987 988 989 990
        elif fmt == "svg":
            srf = cairo.SVGSurface(out, output_size[0], output_size[1])
        elif fmt == "png":
            srf = cairo.ImageSurface(cairo.FORMAT_ARGB32, output_size[0],
                                     output_size[1])
        else:
            raise ValueError("Invalid format type: " + fmt)

        cr = cairo.Context(srf)

        adjust_default_sizes(g, output_size, vprops, eprops)
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
        if fit_view != False:
            try:
                x, y, w, h = fit_view
                offset, zoom = [0, 0], 1
            except TypeError:
                offset, zoom = fit_to_view(g, pos, output_size, vprops["size"],
                                           vprops["pen_width"], None,
                                           vprops.get("text", None),
                                           vprops.get("font_family",
                                                      _vdefaults["font_family"]),
                                           vprops.get("font_size",
                                                      _vdefaults["font_size"]),
                                           cr)
                fit_view = False
Tiago Peixoto's avatar
Tiago Peixoto committed
1005 1006 1007 1008 1009 1010 1011 1012 1013
        else:
            offset, zoom = [0, 0], 1

        if "bg_color" in kwargs:
            bg_color = kwargs["bg_color"]
            del  kwargs["bg_color"]
            cr.set_source_rgba(bg_color[0], bg_color[1],
                               bg_color[2], bg_color[3])
            cr.paint()
1014

Tiago Peixoto's avatar
Tiago Peixoto committed
1015 1016 1017 1018
        cr.translate(offset[0], offset[1])
        cr.scale(zoom, zoom)

        cairo_draw(g, pos, cr, vprops, eprops, vorder, eorder,
1019
                   nodesfirst, fit_view=fit_view, **kwargs)
1020

1021
        if fmt == "png":
Tiago Peixoto's avatar
Tiago Peixoto committed
1022
            srf.write_to_png(out)
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032

        del cr

        if inline:
            img = None
            if fmt == "png":
                img = IPython.display.Image(data=out.getvalue())
            if fmt == "svg":
                img = IPython.display.SVG(data=out.getvalue())
            if img is None:
1033 1034
                inl_out = io.BytesIO()
                inl_srf = cairo.ImageSurface(cairo.FORMAT_ARGB32,
Pietro Battiston's avatar
Pietro Battiston committed
1035 1036
                                             output_size[0],
                                             output_size[1])
1037 1038 1039 1040 1041 1042
                inl_cr = cairo.Context(inl_srf)
                inl_cr.set_source_surface(srf, 0, 0)
                inl_cr.paint()
                inl_srf.write_to_png(inl_out)
                del inl_srf
                img = IPython.display.Image(data=inl_out.getvalue())
1043
            srf.finish()
1044 1045 1046 1047 1048 1049 1050 1051
            if output_file is not None:
                if isinstance(output_file, str):
                    ofile, auto_fmt = open_file(output_file, mode="wb")
                else:
                    ofile = output_file
                ofile.write(out.getvalue())
                if isinstance(output_file, str):
                    ofile.close()
1052
            IPython.display.display(img)
1053
        del srf
Tiago Peixoto's avatar
Tiago Peixoto committed
1054
        return pos
1055 1056 1057 1058 1059


def adjust_default_sizes(g, geometry, vprops, eprops, force=False):
    if "size" not in vprops or force:
        A = geometry[0] * geometry[1]
Tiago Peixoto's avatar
Tiago Peixoto committed
1060 1061
        N = max(g.num_vertices(), 1)
        vprops["size"] = np.sqrt(A / N) / 3.5
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084

    if "pen_width" not in vprops or force:
        size = vprops["size"]
        if isinstance(vprops["size"], PropertyMap):
            size = vprops["size"].fa.mean()
        vprops["pen_width"] = size / 10
        if "pen_width" not in eprops or force:
            eprops["pen_width"] = size / 10
        if "marker_size" not in eprops or force:
            eprops["marker_size"] = size * 0.8


def scale_ink(scale, vprops, eprops):
    if "size" not in vprops:
        vprops["size"] = _vdefaults["size"]
    if "pen_width" not in vprops:
        vprops["pen_width"] = _vdefaults["pen_width"]
    if "font_size" not in vprops:
        vprops["font_size"] = _vdefaults["font_size"]
    if "pen_width" not in eprops:
        eprops["pen_width"] = _edefaults["pen_width"]
    if "marker_size" not in eprops:
        eprops["marker_size"] = _edefaults["marker_size"]
1085 1086 1087 1088
    if "font_size" not in eprops:
        eprops["font_size"] = _edefaults["font_size"]
    if "text_distance" not in eprops:
        eprops["text_distance"] = _edefaults["text_distance"]
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

    for props in [vprops, eprops]:
        if isinstance(props["pen_width"], PropertyMap):
            props["pen_width"].fa *= scale
        else:
            props["pen_width"] *= scale
    if isinstance(vprops["size"], PropertyMap):
        vprops["size"].fa *= scale
    else:
        vprops["size"] *= scale
    if isinstance(vprops["font_size"], PropertyMap):
        vprops["font_size"].fa *= scale
    else:
        vprops["font_size"] *= scale
    if isinstance(eprops["marker_size"], PropertyMap):
        eprops["marker_size"].fa *= scale
    else:
        eprops["marker_size"] *= scale
1107 1108 1109 1110 1111 1112 1113 1114
    if isinstance(eprops["font_size"], PropertyMap):
        eprops["font_size"].fa *= scale
    else:
        eprops["font_size"] *= scale
    if isinstance(eprops["text_distance"], PropertyMap):
        eprops["text_distance"].fa *= scale
    else:
        eprops["text_distance"] *= scale
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

def get_bb(g, pos, size, pen_width, size_scale=1, text=None, font_family=None,
           font_size=None, cr=None):
    size = size.fa[:g.num_vertices()] if isinstance(size, PropertyMap) else size
    pen_width = pen_width.fa if isinstance(pen_width, PropertyMap) else pen_width
    pos_x, pos_y = ungroup_vector_property(pos, [0, 1])
    if text is not None and text != "":
        if not isinstance(size, PropertyMap):
            uniform = (not isinstance(font_size, PropertyMap) and
                       not isinstance(font_family, PropertyMap))
            size = np.ones(len(pos_x.fa)) * size
        else:
            uniform = False
        for i, v in enumerate(g.vertices()):
            ff = font_family[v] if isinstance(font_family, PropertyMap) \
               else font_family
            cr.select_font_face(ff)
            fs = font_size[v] if isinstance(font_family, PropertyMap) \
               else font_size
1134 1135
            if not isinstance(font_size, PropertyMap):
                cr.set_font_size(fs)
1136 1137 1138 1139 1140 1141 1142 1143 1144
            t = text[v] if isinstance(text, PropertyMap) else text
            if not isinstance(t, str):
                t = str(t)
            extents = cr.text_extents(t)
            s = max(extents[2], extents[3]) * 1.4
            size[i] = max(size[i] * size_scale, s) / size_scale
            if uniform:
                size[:] = size[i]
                break
1145 1146
    sl = label_self_loops(g)
    slm = sl.a.max() * 0.75
1147
    delta = (size * size_scale * (slm + 1)) / 2 + pen_width * 2
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
    x_range = [pos_x.fa.min(), pos_x.fa.max()]
    y_range = [pos_y.fa.min(), pos_y.fa.max()]
    x_delta = [x_range[0] - (pos_x.fa - delta).min(),
               (pos_x.fa + delta).max(