Skip to content

Added lightweight title option #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielGoldfarb merged 2 commits into from
Aug 17, 2020
Merged

Added lightweight title option #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1685252
Added lightweight title option
teddyrowan Aug 13, 2020
f5c1338
Implemented dictionary support for plot title kwarg. Allows user to m…
teddyrowan Aug 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/mplfinance/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

version_info = (0, 12, 7, 'alpha', 0)
version_info = (0, 12, 7, 'alpha', 1)

_specifier_ = {'alpha': 'a','beta': 'b','candidate': 'rc','final': ''}

Expand Down
22 changes: 17 additions & 5 deletions src/mplfinance/plotting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def _valid_plot_kwargs():
'Validator' : lambda value: mcolors.is_color_like(value) },

'title' : { 'Default' : None, # Figure Title
'Validator' : lambda value: isinstance(value,str) },
'Validator' : lambda value: isinstance(value,(str,dict)) },

'axtitle' : { 'Default' : None, # Axes Title (subplot title)
'Validator' : lambda value: isinstance(value,str) },
Expand Down Expand Up @@ -624,16 +624,28 @@ def plot( data, **kwargs ):
if external_axes_mode:
volumeAxes.tick_params(axis='x',rotation=xrotation)
volumeAxes.xaxis.set_major_formatter(formatter)

if config['title'] is not None:
if config['tight_layout']:
# IMPORTANT: 0.89 is based on the top of the top panel
# being at 0.18+0.7 = 0.88. See _panels.py
# If the value changes there, then it needs to change here.
fig.suptitle(config['title'],size='x-large',weight='semibold', va='bottom', y=0.89)
title_kwargs = dict(size='x-large',weight='semibold', va='bottom', y=0.89)
else:
fig.suptitle(config['title'],size='x-large',weight='semibold', va='center')

title_kwargs = dict(size='x-large',weight='semibold', va='center')
if isinstance(config['title'],dict):
title_dict = config['title']
if 'title' not in title_dict:
raise ValueError('Must have "title" entry in title dict')
else:
title = title_dict['title']
del title_dict['title']
title_kwargs.update(title_dict) # allows override default values set by mplfinance above
else:
title = config['title'] # config['title'] is a string
fig.suptitle(title,**title_kwargs)


if config['axtitle'] is not None:
axA1.set_title(config['axtitle'])

Expand Down