Plot Parameters | teradatamlwidgets - Plot Parameters - Teradata VantageCloud Lake

Lake - Analyze Your Data with ClearScape Analytics™
Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2026-02-20
dita:mapPath
tcl1683670667798.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
tcl1683670667798

Required Parameters

x
Specifies a DataFrame column to use for the x-axis data.
series
Specifies DataFrame columns to use for the y-axis data

Optional Arguments

scale
Specifies DataFrame columns to use for scale data to wiggle and mesh plots.
"scale" is significant for wiggle and mesh plots, and ignored for other type of plots.
current_plot
Specifies the kind of plot.
Permitted values:
  • 'line'
  • 'bar'
  • 'scatter'
  • 'corr'
  • 'wiggle'
  • 'mesh'

Default value is 'line'.

cmap
Specifies the name of the colormap to be used for plotting.
  • Significant only when corresponding type of plot is mesh or geometry.
  • Ignored for other type of plots.
Permitted values: All colormaps mentioned in the following URLs are supported.
grid_color
Specifies the color of the grid.
Hexadecimal color codes are not supported.
Permitted values:
  • 'blue'
  • 'orange'
  • 'green'
  • 'red'
  • 'purple'
  • 'brown'
  • 'pink'
  • 'gray'
  • 'olive'
  • 'cyan'
  • Any additional colors mentioned in RGB Monitor Colors.

Default value is 'gray'.

grid_format
Specifies the format for the grid.
grid_linestyle
Specifies the line style of the grid.
Permitted values:
  • - (default)
  • --
  • -.
grid_linewidth
Specifies the line width of the grid.
Valid range: 0.5 <= grid_linewidth <= 10.

Default value is 0.8.

heading
Specifies the heading for the plot.
height
Specifies the height of plot image in pixels.

Default value is 480.

width
Specifies the width of plot image in pixels.

Default value is 640.

legend
Specifies the legends for the Plot.
legend_style
Specifies the location for legend to display on Plot image. By default, legend is displayed at upper right corner.
Permitted values:
  • 'upper right' (default)
  • 'upper left'
  • 'lower right'
  • 'lower left'
  • 'right'
  • 'center left'
  • 'center right'
  • 'lower center'
  • 'upper center'
  • 'center'
linestyle
Specifies the line style for the plot.
Permitted values:
  • - (default)
  • --
  • -.
  • :
linewidth
Specifies the line width for the plot.
Valid range: 0.5 <= linewidth <= 10.

Default value is 0.8.

marker
Specifies the type of the marker to be used.

Permitted values are all supported markers mentioned in the latest version of matplotlib.markers documentation (matplotlib.markers).

markersize
Specifies the size of the marker.
Valid range: 1 <= markersize <= 20.

Default value is 6.

reverse_xaxis
Specifies whether to reverse tick values on x-axis or not.

Default values is False.

reverse_yaxis
Specifies whether to reverse tick values on y-axis or not.

Default value is False.

style

Specifies the color for the plot.

Hexadecimal color codes are not supported.
Permitted values:
  • 'blue'
  • 'orange'
  • 'green'
  • 'red'
  • 'purple'
  • 'brown'
  • 'pink'
  • 'gray'
  • 'olive'
  • 'cyan'
  • Any additional colors mentioned in RGB Monitor Colors.

Default value is 'blue'.

title
Specifies the label for x-axis.
  • When set to empty string, label is not displayed for x-axis.
  • When set to None, name of the x-axis column is displayed as label.
xmin
Specifies minimum for x range for xtick values.
xmax
Specifies maximum for x range for xtick values.
xtick_format
Specifies whether to format tick values for x-axis or not.
ylabel
Specifies the label for y-axis.
  • When set to empty string, label is not displayed for y-axis.
  • When set to None, name of the y-axis column(s) is displayed as label.
ymin
Specifies minimum for y range for ytick values.
ymax
Specifies maximum for y range for ytick values.
ytick_format
Specifies whether to format tick values for y-axis or not.
vmin
Specifies the lower range of the color map. By default, the range is derived from data and color codes are assigned accordingly.
"vmin" significant only for Geometry Plot.
vmax
Specifies the upper range of the color map. By default, the range is derived from data and color codes are assigned accordingly.
"vmax" Significant only for Geometry Plot.
For example, assume you want to use colormap 'matter' and derive the colors for values which are in between 1 and 100.
Colormap 'matter' starts with Pale Yellow and ends with Violet.
  • If "colormap_range" is not specified, then range is derived from existing values. Thus, colors are represented as follows in the whole range:
    • 1 as Pale Yellow
    • 100 as Violet
  • If "colormap_range" is specified as -100 and 100, the value 1 is at middle of the specified range. Thus, colors are represented as follows in the whole range:
    • -100 as Pale Yellow
    • 1 as Orange
    • 100 as Violet
wiggle_fill
Specifies whether to fill the wiggle area or not. By default, the right positive half of the wiggle is not filled. If specified as True, wiggle area is filled.
Applicable only for the wiggle plot.
wiggle_scale
Specifies the scale of the wiggle. By default, the amplitude of wiggle is scaled relative to RMS of the first payload. In certain cases, it can lead to excessively large wiggles. Use "wiggle_scale" to adjust the relative size of the wiggle.
Applicable only for the wiggle and mesh plots.