Skip to content

Commit

Permalink
More documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lmcinnes committed Feb 18, 2024
1 parent 2b5e089 commit 2f71e26
Show file tree
Hide file tree
Showing 7 changed files with 3,423 additions and 50 deletions.
14 changes: 7 additions & 7 deletions datamapplot/interactive_rendering.py
Original file line number Diff line number Diff line change
Expand Up @@ -365,13 +365,13 @@
"""

_TOOL_TIP_CSS = """
font-size: 0.8em;
font-family: {{title_font_family}};
color: {{title_font_color}} !important;
background-color: {{title_background}} !important;
border-radius: 12px;
box-shadow: 2px 3px 10px {{shadow_color}};
max-width: 25%;
font-size: 0.8em;
font-family: {{title_font_family}};
color: {{title_font_color}} !important;
background-color: {{title_background}} !important;
border-radius: 12px;
box-shadow: 2px 3px 10px {{shadow_color}};
max-width: 25%;
"""


Expand Down
2 changes: 1 addition & 1 deletion doc/colour_controls.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@
"id": "4e8273a5",
"metadata": {},
"source": [
"Now it is simply a matter of passing this in the ``create_plot`` using the ``marker_color_array`` keyword argument, and we can have the poit coloured according to the colours specified in our array. Since we are using our own colours we'll want to turn of the coloured label text (since there are no cluster colours to be matching with), and not use the glow effect."
"Now it is simply a matter of passing this in the ``create_plot`` using the ``marker_color_array`` keyword argument, and we can have the points coloured according to the colours specified in our array. Since we are using our own colours we'll want to turn off the coloured label text (since there are no cluster colours to be matching with), and not use the glow effect."
]
},
{
Expand Down
8 changes: 0 additions & 8 deletions doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,3 @@ DataMapPlot will return a matplotlib Figure and Axes, which you can then apply w
matplotlib commands you wish to, to add extra plot elements, or otherwise alter things
(at your own risk). If you feel you have a pretty common adjustment, consider submitting a PR
to the library so we can make it available to everyone.

Can I make the plot interactive, with hover tooltips?
-----------------------------------------------------

No, not with this library. DataMapPlot was built to provide static images for inclusion in
papers, presentations and posters. If you need interactive data map plotting then you
should check out the `ThisNotThat <https://github.com/TutteInstitute/thisnotthat>`_ library
which provides tools for a wide variety of interactivity.
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ and followed by guides on basic usage, through to the more complicated options a
colour_controls
placement_controls
interactive_intro
interactive_sizing_options
interactive_colour_options
auto_examples/index
api
faq
Expand Down
3,106 changes: 3,106 additions & 0 deletions doc/interactive_colour_options.ipynb

Large diffs are not rendered by default.

340 changes: 306 additions & 34 deletions doc/interactive_intro.ipynb

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions examples/plot_interactive_arxiv_ml.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
logo="https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/ArXiv_logo_2022.svg/512px-ArXiv_logo_2022.svg.png",
logo_width=128,
on_click="window.open(`http://google.com/search?q=\"{hover_text}\"`)",
enable_search=True,
darkmode=True,
)
plot

0 comments on commit 2f71e26

Please sign in to comment.