matplotlib functions to plot text with color highlighted substrings
Project description
highlight_text
This package provides two functions that allow you to plot text with in matplotlib:
- htext for plotting onto an axes in data coordinates.
- fig_htext for plotting onto the figure in figure coordinates.
They take a string with substring delimiters = ['<', '>'] to be highlighted according to highlight colors: 'The weather is (sunny) today. Yesterday it (rained).', color = 'k', highlight_colors = ['C1', 'grey'] prints the text with 'sunny' as orange and 'rained' as grey.
A minimal example would be (Replace () with delimiters <> - markdown won't show them):
from highlight_text.htext import htext, fig_htext
fig, ax = plt.subplots()
htext(s = 'The weather is (sunny) today. Yesterday it (rained).',
x = 0, y = 0.5,
color = 'k', highlight_colors = ['C1', 'grey'])
or for the fig_htext:
fig, ax = plt.subplots()
fig_htext(s = 'The weather is (sunny) today. Yesterday it (rained).',
x = 0, y = 0.5,
color = 'k', highlight_colors = ['C1', 'grey'])
You can further highlight by using
highlight_styles ie. ['normal', 'italic', 'oblique']
and highlight_weights ie. ['regular', 'bold'].
This does work with linebreaks \n, fstrings and ha in ['left', 'right', 'center'] as well as va in ['botton', 'top', 'center'].
Make sure to set data limits before using this function. Otherwise the data transformation will not work properly.
Installation
pip install highlight-text
Parameters:
##########
s: text including
x: x position with left alignment
y: y position
color: textcolor of unhighlighted text
highlight_colors: list of highlight colors
highlight_weights = ['regular']: the fontweight used for highlighted text
highlight_styles = ['normal']: the fontstyle used for highlighted text
string_weight = 'regular': the fontweight used for normal text
string_style = 'normal': the fontstyle used for normal text
delim = ['<', '>']: delimiters to enclose the highlight substrings
va = 'bottom', textalignment has to be in ['bottom', 'top', 'center']
ha = 'left', textalignment has to be in ['left', 'right', 'center']
hpadding = 0: extra padding between highlight and normal text
linespacing = 0.25: linespacing in factor of font height between rows
**kwargs: figure.text | plt.text kwargs
[ax: axes to draw the text onto (in case of htext)]
[fig: figure(in case of fig_htext)]
Returns:
##########
a list of texts
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for highlight_text-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c82f82a5dfd0d8e72c292779137c4ce2de08d0a9c4435849bd195969d06a2296 |
|
MD5 | 698bdbdbb1f205a1c7589cfa48eca766 |
|
BLAKE2b-256 | 3a11e540a015f4d770a798ea895de564a0159a8cb8a2d5ce43fd5e9c5cc77c01 |