Skip to content

Offset and scaling factors in axis format #4376 #6086

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

Closed
wants to merge 15 commits into from
Closed

Offset and scaling factors in axis format #4376 #6086

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
137c7aa
Ticket 4376: Implemented functionality to let the user set an offset or
VincentVandalon Feb 26, 2016
ab1b3a2
Ticket 4376: Added more information in signature of the functions
VincentVandalon Mar 1, 2016
4079e1a
Reformatted documentation of related function
VincentVandalon Mar 1, 2016
bfc7389
Fixed minor issue, default scaling did not use scaling factor
VincentVandalon Mar 1, 2016
09f800c
Added functionality to manually set offset/scaling string
VincentVandalon Mar 1, 2016
02f0a11
Made come more readable and more consistent with matplotlib defaults
VincentVandalon Mar 2, 2016
5368336
Made code in ticker.py PEP8 compliant
VincentVandalon Mar 2, 2016
fee8ab9
Removed old test and changed code to respect rcParams
VincentVandalon Mar 2, 2016
681820f
Changes multiplication sign from cdot to cross
VincentVandalon Mar 6, 2016
66061ad
axis.formatter.useoffset is still honored, however, it is not directl…
VincentVandalon Mar 6, 2016
53ed618
Allowed both multiplication and scaling again
VincentVandalon Mar 6, 2016
4c86635
Updated test images to handle addtion of x sign in scaling factor of …
VincentVandalon Mar 6, 2016
9ce9d3c
PEP8 issues
VincentVandalon Mar 6, 2016
8d9d121
Minor improvements suggested by tacaswell
VincentVandalon Mar 8, 2016
2737c5c
- Improved documentation with the suggestions of tacaswell.
VincentVandalon Mar 17, 2016
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
Prev Previous commit
Next Next commit
Added functionality to manually set offset/scaling string
  • Loading branch information
@VincentVandalon
VincentVandalon committed Mar 1, 2016
commit 09f800ccf74c7299318e9f820fcfff452abf64d3
24 changes: 23 additions & 1 deletion lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ def __init__(self, useOffset=None, useMathText=None, useLocale=None):
self.orderOfMagnitude = 0
self.format = ''
self._scientific = True
self._offsetString = ''
self._powerlimits = rcParams['axes.formatter.limits']
if useLocale is None:
useLocale = rcParams['axes.formatter.use_locale']
Expand Down Expand Up @@ -592,11 +593,29 @@ def format_data(self, value):
return self.fix_minus(s)


def set_offset_string(self,s):
"""
Set the string which typically contains the offset
or the scaling factor which is to be displayed on the axis.
Set this to and empty string "" allows the string set by offset or scaling
algorithm.

Parameters
----------
s: String describing the offset
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There needs to be a space before the :


Returns
-------
None
"""
self._offsetString=s

def get_offset(self):
"""
Returns a string with the offset(or scientific notation)/scaling
factor which is properly formatted. This is used as additional text
next to the ticks.
next to the ticks, either determined by offset/scaling or set by the
user

Parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not include unneeded sections.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if you mean (1) leave it as it was or (2) no documentation needed for this method as a user will probably not use this method. Which one do you prefer?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest of the docstring is good, just do not include the Parameters section (as there ane no parameters).

----------
Expand All @@ -606,6 +625,9 @@ def get_offset(self):
-------
:string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no : here

"""
#String has been set manually, so just return that
if self._offsetString != '' :
return self._offsetString

if len(self.locs) == 0:
return ''
Expand Down