gridlines

fcp.gridlines()

Dummy function to return the gridline API with help() (not used directly for plotting).

Keyword Arguments

  • grid_major (boolean) – Enable/disable major x-axis and y-axis gridlines. Defaults to True. More details

  • grid_major_alpha (str) – Transparency value for major gridlines between 0-1. Defaults to 1. More details

  • grid_major_color (str) – Hex-axis color string for x-axis and y-axis major gridlines. Defaults to #ffffff . More details

  • grid_major_width (float) – Major gridline width in pixels (float ok). Defaults to 1.3. More details

  • grid_major_x (boolean) – Enable/disable major x-axis gridlines. Defaults to True. More details

  • grid_major_x2 (boolean) – Enable/disable secondary-axis major x-axis gridlines. Defaults to True. More details

  • grid_major_x2_alpha (str) – Transparency value for secondary-axis major x-axis gridlines between 0-1. Defaults to 1. More details

  • grid_major_x2_color (str) – Hex-axis color string for secondary-axis x-axis major gridlines. Defaults to #ffffff . More details

  • grid_major_x2_width (float) – Major secondary x-axis gridline width in pixels (float ok). Defaults to 1.3. More details

  • grid_major_x_alpha (str) – Transparency value for major x-axis gridlines between 0-1. Defaults to 1. More details

  • grid_major_x_color (str) – Hex-axis color string for x-axis major gridlines. Defaults to #ffffff . More details

  • grid_major_x_width (float) – Major x-axis gridline width in pixels (float ok). Defaults to 1.3. More details

  • grid_major_y (boolean) – Enable/disable major y-axis gridlines. Defaults to True. More details

  • grid_major_y2 (boolean) – Enable/disable secondary-axis major y-axis gridlines. Defaults to True. More details

  • grid_major_y2_alpha (str) – Transparency value for secondary-axis major y-axis gridlines between 0-1. Defaults to 1. More details

  • grid_major_y2_color (str) – Hex-axis color string for secondary-axis y-axis major gridlines. Defaults to #ffffff . More details

  • grid_major_y2_width (float) – Major secondary y-axis gridline width in pixels (float ok). Defaults to 1.3. More details

  • grid_major_y_alpha (str) – Transparency value for major y-axis gridlines between 0-1. Defaults to 1. More details

  • grid_major_y_color (str) – Hex-axis color string for y-axis major gridlines. Defaults to #ffffff . More details

  • grid_major_y_width (float) – Major y-axis gridline width in pixels (float ok). Defaults to 1.3. More details

  • grid_minor (boolean) – Enable/disable minor x-axis and y-axis gridlines. Defaults to True. More details

  • grid_minor_alpha (str) – Transparency value for minor gridlines between 0-1. Defaults to 1. More details

  • grid_minor_color (str) – Hex-axis color string for x-axis and y-axis minor gridlines. Defaults to #ffffff . More details

  • grid_minor_width (float) – minor gridline width in pixels (float ok). Defaults to 0.5. More details

  • grid_minor_x (boolean) – Enable/disable minor x-axis gridlines. Defaults to True. More details

  • grid_minor_x2 (boolean) – Enable/disable secondary-axis minor x-axis gridlines. Defaults to True. More details

  • grid_minor_x2_alpha (str) – Transparency value for secondary-axis minor x-axis gridlines between 0-1. Defaults to 1. More details

  • grid_minor_x2_color (str) – Hex-axis color string for secondary-axis x-axis minor gridlines. Defaults to #ffffff . More details

  • grid_minor_x2_width (float) – minor secondary x-axis gridline width in pixels (float ok). Defaults to 0.5. More details

  • grid_minor_x_alpha (str) – Transparency value for minor x-axis gridlines between 0-1. Defaults to 1. More details

  • grid_minor_x_color (str) – Hex-axis color string for x-axis minor gridlines. Defaults to #ffffff . More details

  • grid_minor_x_width (float) – minor x-axis gridline width in pixels (float ok). Defaults to 0.5. More details

  • grid_minor_y (boolean) – Enable/disable minor y-axis gridlines. Defaults to True. More details

  • grid_minor_y2 (boolean) – Enable/disable secondary-axis minor y-axis gridlines. Defaults to True. More details

  • grid_minor_y2_alpha (str) – Transparency value for secondary-axis minor y-axis gridlines between 0-1. Defaults to 1. More details

  • grid_minor_y2_color (str) – Hex-axis color string for secondary-axis y-axis minor gridlines. Defaults to #ffffff . More details

  • grid_minor_y2_width (float) – minor secondary y-axis gridline width in pixels (float ok). Defaults to 0.5. More details

  • grid_minor_y_alpha (str) – Transparency value for minor y-axis gridlines between 0-1. Defaults to 1. More details

  • grid_minor_y_color (str) – Hex-axis color string for y-axis minor gridlines. Defaults to #ffffff . More details

  • grid_minor_y_width (float) – Minor y-axis gridline width in pixels (float ok). Defaults to 0.5. More details

  • tick_cleanup (str|boolean) – Set the tick cleanup style when dealing with overlaping tick labels {False -> ignore | “shrink” -> change the font | “remove” -> delete one of the overlapping labels}. Defaults to “shirnk”. More details

Examples

>>> import fivecentplots as fcp
>>> from pathlib import Path
>>> import pandas as pd
>>> df = pd.read_csv(Path(fcp.__file__).parent / 'test_data' / 'fake_data.csv')
>>> fcp.plot(df, x='Voltage', y='I [A]', lines=False, ax_size=[400, 300],
             filter='Target Wavelength==450 & Temperature [C]==25 & Boost Level==0.2',
             grid_major_x_style='--', grid_major_y_color='#00EE00',
             grid_minor=True, grid_minor_color='#BB0000', grid_minor_y_alpha=0.3, grid_minor_x_width=2
../_images/example_gridlines.png