Initial implementation of scatterplot hyperlinks.

Author: tshead2

sandbox/scatterplot-hyperlinks.ipynb

@@ -452,6 +452,7 @@ def scatterplot(
         color=None,
         filename=None,
         height=None,
+        hyperlink=None,
         label=None,
         margin=50,
         marker="o",
@@ -517,6 +518,7 @@ def scatterplot(
         area=area,
         color=color,
         filename=filename,
+        hyperlink=hyperlink,
         marker=marker,
         mlstyle=mlstyle,
         mstyle=mstyle,

toyplot/__init__.py

@@ -2025,15 +2025,16 @@ def scatterplot(
             a,
             b=None,
             along="x",
+            area=None,
             color=None,
+            filename=None,
+            hyperlink=None,
             marker="o",
-            area=None,
-            size=None,
+            mlstyle=None,
+            mstyle=None,
             opacity=1.0,
+            size=None,
             title=None,
-            mstyle=None,
-            mlstyle=None,
-            filename=None,
         ):
         """Add a bivariate plot to the axes.
 
@@ -2096,6 +2097,7 @@ def scatterplot(
         mstroke = toyplot.color.broadcast(colors=mfill, shape=series.shape)
         mopacity = toyplot.broadcast.scalar(opacity, series.shape)
         mtitle = toyplot.broadcast.pyobject(title, series.shape)
+        mhyperlink = toyplot.broadcast.pyobject(hyperlink, series.shape)
         mstyle = toyplot.style.require(mstyle, allowed=toyplot.style.allowed.marker)
         mlstyle = toyplot.style.require(mlstyle, allowed=toyplot.style.allowed.text)
 
@@ -2114,8 +2116,9 @@ def scatterplot(
         mstroke_keys = []
         mopacity_keys = []
         mtitle_keys = []
-        for index, (series_column, marker_column, msize_column, mfill_column, mstroke_column, mopacity_column, mtitle_column) in enumerate(
-                zip(series.T, marker.T, msize.T, mfill.T, mstroke.T, mopacity.T, mtitle.T)):
+        mhyperlink_keys = []
+        for index, (series_column, marker_column, msize_column, mfill_column, mstroke_column, mopacity_column, mtitle_column, mhyperlink_column) in enumerate(
+                zip(series.T, marker.T, msize.T, mfill.T, mstroke.T, mopacity.T, mtitle.T, mhyperlink.T)):
             coordinate_keys.append(coordinate_axes[0])
             coordinate_keys.append(coordinate_axes[1] + str(index))
             marker_keys.append("marker" + str(index))
@@ -2124,6 +2127,7 @@ def scatterplot(
             mstroke_keys.append("stroke" + str(index))
             mopacity_keys.append("opacity" + str(index))
             mtitle_keys.append("title" + str(index))
+            mhyperlink_keys.append("hyperlink" + str(index))
             table[coordinate_keys[-1]] = series_column
             _mark_exportable(table, coordinate_keys[-1])
             table[marker_keys[-1]] = marker_column
@@ -2132,6 +2136,7 @@ def scatterplot(
             table[mstroke_keys[-1]] = mstroke_column
             table[mopacity_keys[-1]] = mopacity_column
             table[mtitle_keys[-1]] = mtitle_column
+            table[mhyperlink_keys[-1]] = mhyperlink_column
 
         return self.add_mark(
             toyplot.mark.Scatterplot(
@@ -2140,6 +2145,7 @@ def scatterplot(
                 filename=filename,
                 marker=marker_keys,
                 mfill=mfill_keys,
+                mhyperlink=mhyperlink_keys,
                 mlstyle=mlstyle,
                 mopacity=mopacity_keys,
                 msize=msize_keys,
@@ -2502,16 +2508,18 @@ def colormap(self, colormap, offset=None, width=10, style=None):
     def scatterplot(
             self,
             coordinates,
-            offset=None,
+            area=None,
             color=None,
+            filename=None,
+            hyperlink=None,
             marker="o",
-            area=None,
-            size=None,
+            mlstyle=None,
+            mstyle=None,
+            offset=None,
             opacity=1.0,
+            size=None,
             title=None,
-            mstyle=None,
-            mlstyle=None,
-            filename=None):
+            ):
         """Add a univariate plot to the axes.
 
         Parameters
@@ -2554,6 +2562,7 @@ def scatterplot(
         mstroke = toyplot.color.broadcast(colors=mfill, shape=coordinates.shape)
         mopacity = toyplot.broadcast.scalar(opacity, coordinates.shape)
         mtitle = toyplot.broadcast.pyobject(title, coordinates.shape)
+        mhyperlink = toyplot.broadcast.pyobject(hyperlink, coordinates.shape)
         mstyle = toyplot.style.require(mstyle, allowed=toyplot.style.allowed.marker)
         mlstyle = toyplot.style.require(mlstyle, allowed=toyplot.style.allowed.text)
 
@@ -2568,15 +2577,17 @@ def scatterplot(
         mstroke_keys = []
         mopacity_keys = []
         mtitle_keys = []
-        for index, (coordinate_column, marker_column, msize_column, mfill_column, mstroke_column, mopacity_column, mtitle_column) in enumerate(
-                zip(coordinates.T, marker.T, msize.T, mfill.T, mstroke.T, mopacity.T, mtitle.T)):
+        mhyperlink_keys = []
+        for index, (coordinate_column, marker_column, msize_column, mfill_column, mstroke_column, mopacity_column, mtitle_column, mhyperlink_column) in enumerate(
+                zip(coordinates.T, marker.T, msize.T, mfill.T, mstroke.T, mopacity.T, mtitle.T, mhyperlink.T)):
             coordinate_keys.append(coordinate_axes[0] + str(index))
             marker_keys.append("marker" + str(index))
             msize_keys.append("size" + str(index))
             mfill_keys.append("fill" + str(index))
             mstroke_keys.append("stroke" + str(index))
             mopacity_keys.append("opacity" + str(index))
             mtitle_keys.append("title" + str(index))
+            mhyperlink_keys.append("hyperlink" + str(index))
             table[coordinate_keys[-1]] = coordinate_column
             _mark_exportable(table, coordinate_keys[-1])
             table[marker_keys[-1]] = marker_column
@@ -2585,6 +2596,7 @@ def scatterplot(
             table[mstroke_keys[-1]] = mstroke_column
             table[mopacity_keys[-1]] = mopacity_column
             table[mtitle_keys[-1]] = mtitle_column
+            table[mhyperlink_keys[-1]] = mhyperlink_column
 
         if offset is None:
             offset = len(self._children) * self._spacing
@@ -2595,6 +2607,7 @@ def scatterplot(
             filename=filename,
             marker=marker_keys,
             mfill=mfill_keys,
+            mhyperlink=mhyperlink_keys,
             mlstyle=mlstyle,
             mopacity=mopacity_keys,
             msize=msize_keys,

toyplot/coordinates.py

@@ -1780,29 +1780,35 @@ def _render(numberline, mark, context):
 
     dimension1 = numpy.ma.column_stack([mark._table[key] for key in mark._coordinates])
     X = numberline.axis.projection(dimension1)
-    for x, marker, msize, mfill, mstroke, mopacity, mtitle in zip(
+    for x, marker, msize, mfill, mstroke, mopacity, mtitle, mhyperlink in zip(
             X.T,
             [mark._table[key] for key in mark._marker],
             [mark._table[key] for key in mark._msize],
             [mark._table[key] for key in mark._mfill],
             [mark._table[key] for key in mark._mstroke],
             [mark._table[key] for key in mark._mopacity],
             [mark._table[key] for key in mark._mtitle],
+            [mark._table[key] for key in mark._mhyperlink],
         ):
         not_null = numpy.invert(numpy.ma.getmaskarray(x))
 
-        series_xml = xml.SubElement(
-            mark_xml, "g", attrib={"class": "toyplot-Series"})
-        for dx, dmarker, dsize, dfill, dstroke, dopacity, dtitle in zip(
+        series_xml = xml.SubElement(mark_xml, "g", attrib={"class": "toyplot-Series"})
+        for dx, dmarker, dsize, dfill, dstroke, dopacity, dtitle, dhyperlink in zip(
                 x[not_null],
                 marker[not_null],
                 msize[not_null],
                 mfill[not_null],
                 mstroke[not_null],
                 mopacity[not_null],
                 mtitle[not_null],
+                mhyperlink[not_null],
             ):
             if dmarker:
+                if dhyperlink:
+                    datum_xml = xml.SubElement(series_xml, "a", attrib={"xlink:href": dhyperlink})
+                else:
+                    datum_xml = series_xml
+
                 dstyle = toyplot.style.combine(
                     {
                         "fill": toyplot.color.to_css(dfill),
@@ -1811,7 +1817,7 @@ def _render(numberline, mark, context):
                     },
                     mark._mstyle)
                 _draw_marker(
-                    series_xml,
+                    datum_xml,
                     cx=dx,
                     cy=0,
                     marker=toyplot.marker.create(size=dsize, mstyle=dstyle, lstyle=mark._mlstyle) + toyplot.marker.convert(dmarker),
@@ -2866,7 +2872,7 @@ def _render(axes, mark, context):
 
     _render_table(owner=mark, key="data", label="scatterplot", table=mark._table, filename=mark._filename, context=context)
 
-    for x, y, marker, msize, mfill, mstroke, mopacity, mtitle in zip(
+    for x, y, marker, msize, mfill, mstroke, mopacity, mtitle, mhyperlink in zip(
             X.T,
             Y.T,
             [mark._table[key] for key in mark._marker],
@@ -2875,13 +2881,14 @@ def _render(axes, mark, context):
             [mark._table[key] for key in mark._mstroke],
             [mark._table[key] for key in mark._mopacity],
             [mark._table[key] for key in mark._mtitle],
+            [mark._table[key] for key in mark._mhyperlink],
         ):
         not_null = numpy.invert(numpy.logical_or(
             numpy.ma.getmaskarray(x), numpy.ma.getmaskarray(y)))
 
         series_xml = xml.SubElement(
             mark_xml, "g", attrib={"class": "toyplot-Series"})
-        for dx, dy, dmarker, dsize, dfill, dstroke, dopacity, dtitle in zip(
+        for dx, dy, dmarker, dsize, dfill, dstroke, dopacity, dtitle, dhyperlink in zip(
                 x[not_null],
                 y[not_null],
                 marker[not_null],
@@ -2890,8 +2897,14 @@ def _render(axes, mark, context):
                 mstroke[not_null],
                 mopacity[not_null],
                 mtitle[not_null],
+                mhyperlink[not_null],
             ):
             if dmarker:
+                if dhyperlink:
+                    datum_xml = xml.SubElement(series_xml, "a", attrib={"xlink:href": dhyperlink})
+                else:
+                    datum_xml = series_xml
+
                 dstyle = toyplot.style.combine(
                     {
                         "fill": toyplot.color.to_css(dfill),
@@ -2900,7 +2913,7 @@ def _render(axes, mark, context):
                     },
                     mark._mstyle)
                 _draw_marker(
-                    series_xml,
+                    datum_xml,
                     cx=dx,
                     cy=dy,
                     marker=toyplot.marker.create(size=dsize, mstyle=dstyle, lstyle=mark._mlstyle) + toyplot.marker.convert(dmarker),

toyplot/html.py

@@ -801,6 +801,7 @@ def __init__(
             filename,
             marker,
             mfill,
+            mhyperlink,
             mlstyle,
             mopacity,
             msize,
@@ -811,34 +812,37 @@ def __init__(
         ):
         Mark.__init__(self)
 
-        # D axis identifiers
+        self._table = toyplot.require.instance(table, toyplot.data.Table)
+
+        # We require at last one coordinate dimension (number of dimensions = D)
         self._coordinate_axes = toyplot.require.string_vector(coordinate_axes, min_length=1)
         D = len(self._coordinate_axes)
 
-        self._table = toyplot.require.instance(table, toyplot.data.Table)
-
-        # D * N coordinate columns
+        # We require D coordinate columns for each series (number of series = N)
         self._coordinates = toyplot.require.table_keys(table, coordinates, modulus=D)
         N = len(self._coordinates) / D
 
-        # N marker columns
+        # We require 1 export filename
+        self._filename = toyplot.require.filename(filename)
+        # We require 1 marker style
+        self._mstyle = toyplot.style.require(mstyle, allowed=toyplot.style.allowed.marker)
+        # We require 1 marker label style
+        self._mlstyle = toyplot.style.require(mlstyle, allowed=toyplot.style.allowed.text)
+
+        # We require N marker columns
         self._marker = toyplot.require.table_keys(table, marker, length=N)
-        # N marker size columns
-        self._msize = toyplot.require.table_keys(table, msize, length=N)
-        # N marker fill color columns
+        # We require N marker fill color columns
         self._mfill = toyplot.require.table_keys(table, mfill, length=N)
-        # N marker stroke color columns
-        self._mstroke = toyplot.require.table_keys(table, mstroke, length=N)
-        # N marker opacity columns
+        # We require N marker hyperlink columns
+        self._mhyperlink = toyplot.require.table_keys(table, mhyperlink, length=N)
+        # We require N marker opacity columns
         self._mopacity = toyplot.require.table_keys(table, mopacity, length=N)
-        # N marker title columns
+        # We require N marker size columns
+        self._msize = toyplot.require.table_keys(table, msize, length=N)
+        # We require N marker stroke color columns
+        self._mstroke = toyplot.require.table_keys(table, mstroke, length=N)
+        # We require N marker title columns
         self._mtitle = toyplot.require.table_keys(table, mtitle, length=N)
-        # Marker style
-        self._mstyle = toyplot.style.require(mstyle, allowed=toyplot.style.allowed.marker)
-        # Marker label style
-        self._mlstyle = toyplot.style.require(mlstyle, allowed=toyplot.style.allowed.text)
-        # Export filename
-        self._filename = toyplot.require.filename(filename)
 
     def domain(self, axis):
         columns = [coordinate_column for coordinate_axis, coordinate_column in zip(itertools.cycle(self._coordinate_axes), self._coordinates) if coordinate_axis == axis]