autofig.call.Plot.init (function)

def __init__(self, x=None, y=None, z=None, c=None, s=None, i=None, xerror=None, xunit=None, xlabel=None, yerror=None, yunit=None, ylabel=None, zerror=None, zunit=None, zlabel=None, cunit=None, clabel=None, cmap=None, sunit=None, slabel=None, smap=None, smode=None, iunit=None, itol=0.0, axorder=None, axpos=None, title=None, label=None, marker=None, linestyle=None, linebreak=None, highlight=True, uncover=False, trail=False, consider_for_limits=True, **kwargs)

Create a autofig.call.Plot object which defines a single call to matplotlib.

See also:

• autofig.call.Mesh

Note that the following keyword arguments are not allowed and will raise an error suggesting the appropriate autofig argument:

• markersize or ms: use size or s
• linewidth or lw: use size or s

Arguments

• x (list/array, optional, default=None): array of values for the x-axes. Access via autofig.call.Plot.x.
• y (list/array, optional, default=None): array of values for the y-axes. Access via autofig.call.Plot.y.
• z (list/array, optional, default=None): array of values for the z-axes. Access via autofig.call.Plot.z
• c or color (list/array, optional, default=None): array of values for the color-direction. Access via autofig.call.Plot.c. Note: color takes precedence over c if both are provided.
• s or size (list/array, optional, default=None): array of values for the size-direction. Access via autofig.call.Plot.s. Note: size takes precedence over s if both are provided.
• i (list/array or string, optional, default=None): array of values for the independent-variable. If a string, can be one of: 'x', 'y', 'z', 'c', 's' to reference an existing array. Access via autofig.call.Plot.i.
• xerror (float or list/array, optional, default=None): errors for x. See autofig.call.Plot.x and autofig.call.CallDimensionX.error.
• xunit (string or astropy unit, optional, default=None): units for x. See autofig.call.Plot.x and autofig.call.CallDimensionX.unit.
• xlabel (strong, optional, default=None): label for x. See autofig.call.Plot.x and autofig.call.CallDimensionX.label.
• yerror (float or list/array, optional, default=None): errors for y. See autofig.call.Plot.y and autofig.call.CallDimensionY.error.
• yunit (string or astropy unit, optional, default=None): units for y. See autofig.call.Plot.y and autofig.call.CallDimensionY.unit.
• ylabel (strong, optional, default=None): label for y. See autofig.call.Plot.y and autofig.call.CallDimensionY.label.
• zerror (float or list/array, optional, default=None): errors for z. See autofig.call.Plot.z and autofig.call.CallDimensionZ.error.
• zunit (string or astropy unit, optional, default=None): units for z. See autofig.call.Plot.z and autofig.call.CallDimensionZ.unit.
• zlabel (strong, optional, default=None): label for x. See autofig.call.Plot.z and autofig.call.CallDimensionZ.label.
• cerror (float or list/array, optional, default=None): errors for c. See autofig.call.Plot.c and autofig.call.CallDimensionC.error.
• cunit (string or astropy unit, optional, default=None): units for c. See autofig.call.Plot.c and autofig.call.CallDimensionC.unit.
• clabel (strong, optional, default=None): label for c. See autofig.call.Plot.c and autofig.call.CallDimensionC.label.
• serror (float or list/array, optional, default=None): errors for s. See autofig.call.Plot.s and autofig.call.CallDimensionS.error.
• sunit (string or astropy unit, optional, default=None): units for s. See autofig.call.Plot.s and autofig.call.CallDimensionS.unit.
• slabel (strong, optional, default=None): label for s. See autofig.call.Plot.s and autofig.call.CallDimensionS.label.
• iunit (string or astropy unit, optional, default=None): units for i. See autofig.call.Plot.i and autofig.call.CallDimensionI.unit.
• itol (float, optional, default=0.0): see autofig.call.DimensionI.tol.
• axorder (int, optional, default=None): see autofig.call.Plot.axorder.
• axpos (tuple, optional, default=None): see autofig.call.Plot.axpos.
• title (string, optional, default=None): see autofig.call.Plot.title.
• label (string, optional, default=None): see autofig.call.Plot.label.
• marker or m (string, optional, default=None): see autofig.call.Plot.marker. Note: marker takes precedence over m if both are provided.
• linestyle or ls (string, optional, default=None): see autofig.call.Plot.linestyle. Note: linestyle takes precedence over ls if both are provided.
• linebreak (string, optional, default=None): see autofig.call.Plot.linebreak.
• highlight (bool, optional, default=False): see autofig.call.Plot.highlight.
• highlight_marker (string, optional, default=None)
• highlight_linestyle or highlight_ls (string, optional, default=None): Note: highlight_linestyle takes precedence over highlight_ls if both are provided.
• highlight_size or highlight_s (float, optional, default=None): Note: highlight_size takes precedence over highlight_s if both are provided.
• highlight_color or highlight_c (string, optional, default=None): Note: highlight_color takes precedence over highlight_c if both are provided.
• consider_for_limits (bool, optional, default=True): see autofig.call.Call.consider_for_limits.
• uncover (bool, optional, default=False): see autofig.call.Call.uncover.
• trail (bool or Float, optional, default=False): see autofig.call.Call.trail.
• **kwargs: additional keyword arguments are stored and passed on when attaching to a parent axes. See autofig.axes.Axes.add_call.

Returns

• the instantiated autofig.call.Plot object.