Login
Introduction
Technical Documentation
Tasks
Version

Scatterplot Plotly

TASK
Typing name :  TASK.gws_core.PlotlyScatterplot Brick :  gws_core v Parent : 

Scatter plot from plotly(px)

Plotly scatter plot plotly.express.scatter()

please check : [https://plotly.com/python-api-reference/generated/plotly.express.scatter.html] for more info

Input

Table
2d excel like table

Output

Plotly figure
Plotly resource

Configuration

x

str: column name for x-axis' values

Type : string

y

Optional

str: column name for y-axis' values

Type : string

color

Optional

str: column name to color the graph figures

Type : string

title

Optional

Title of the graph

Type : string

y_axis_name

Optional

set the y axis name

Type : string

x_axis_name

Optional

set the x axis name

Type : string

template

OptionalAdvanced parameter

Plotly template to use

Type : stringAllowed values : ggplot2  seaborn  simple_white  plotly  plotly_dark  presentation  xgridoff  ygridoff  gridon  none 

animation_frame

OptionalAdvanced parameter

str: Values from this column are used to assign marks to animation frames.

Type : string

animation_group

OptionalAdvanced parameter

str: Values from this column are used to provide object-constancy across animation frames: rows with matching `animation_group`s will be treated as if they describe the same object in each frame.

Type : string

log_x

OptionalAdvanced parameter

the x-axis is log-scaled in cartesian coordinates.

Type : bool

log_y

OptionalAdvanced parameter

the y-axis is log-scaled in cartesian coordinates.

Type : bool

range_x

OptionalAdvanced parameter

If provided, overrides auto-scaling on the x-axis in cartesian coordinates.

Type : string

range_y

OptionalAdvanced parameter

If provided, overrides auto-scaling on the y-axis in cartesian coordinates.

Type : string

width

OptionalAdvanced parameter

int: The figure width in pixels.

Type : int

height

OptionalAdvanced parameter

int The figure height in pixels

Type : int

label_columns

OptionalAdvanced parameter

one column per line, and same line for the text

Type : list

label_text

OptionalAdvanced parameter

text for labels, size should match 'colot to label'

Type : list

facet_row

OptionalAdvanced parameter

str: Values from this column are used to assign marks to facetted subplots in the vertical direction.

Type : string

facet_col

OptionalAdvanced parameter

Values from this column are used to assign marks to facetted subplots in the horizontal direction.

Type : string

facet_col_wrap

OptionalAdvanced parameter

int: Maximum number of facet columns.

Type : int

facet_row_spacing

OptionalAdvanced parameter

float: Spacing between facet rows, in paper units. Default is 0.03 or 0.0.7 when facet_col_wrap is used.

Type : float

facet_col_spacing

OptionalAdvanced parameter

float: Spacing between facet columns, in paper units. Default is 0.03 or 0.0.7 when facet_col_wrap is used.

Type : float

hover_data

OptionalAdvanced parameter

list str: Values from these columns appear in the hover tooltip.

Type : list

hover_name

OptionalAdvanced parameter

Values from this column appear in bold in the hover tooltip.

Type : string

orientation

OptionalAdvanced parameter

Orientation of the box plot ('v' for vertical, 'h' for horizontal)

Type : stringAllowed values : v  h  Default value : v

size

Optional

Values from this column are used to assign mark sizes

Type : string

opacity

OptionalAdvanced parameter

float: opacity of the marks

Type : float

size_max

OptionalAdvanced parameter

int: maximum size of the marks

Type : intDefault value : 20

marginal_x

OptionalAdvanced parameter

If set, a horizontal subplot is drawn above the main plot, visualizing the x-distribution.

Type : stringAllowed values : rug  box  violin  histogram 

marginal_y

OptionalAdvanced parameter

If set, a vertical subplot is drawn to the right of the main plot, visualizing the y-distribution.

Type : stringAllowed values : rug  box  violin  histogram 

symbol

Optional

str: Values from this column are used to assign symbols to marks.

Type : string

render_mode

OptionalAdvanced parameter

Controls the browser API used to draw marks.

Type : stringAllowed values : svg  webgl  auto 

error_x

OptionalAdvanced parameter

str: Values from this column are used to size x-axis error bars

Type : string

error_x_minus

OptionalAdvanced parameter

str: Values from this column or array_like are used to size x-axis error bars in the negative direction.

Type : string

error_y

OptionalAdvanced parameter

str: Values from this column are used to size y-axis error bars

Type : string

error_y_minus

OptionalAdvanced parameter

str: Values from this column or array_like are used to size x-axis error bars in the negative direction.

Type : string

text

Optional

str: Values from this column or array_like appear in the figure as text labels.

Type : string

trendline

OptionalAdvanced parameter

Add a trendline to the plot, see the plotlydoc : plotly.express.trendline_functions

Type : stringAllowed values : ols  lowess  rolling  expanding  ewm 

trendline_color_override

OptionalAdvanced parameter

all trendlines will be drawn in this color rather than in the same color as the traces from which they draw their inputs.

Type : stringAllowed values : black  white  red  green  blue  yellow  orange  pink  purple  brown  gray  cyan  magenta  lime  teal  navy 

trendline_scope

OptionalAdvanced parameter

If 'trace', then one trendline is drawn per trace (i.e. per color, symbol, facet, animation frame etc) and if 'overall' then one trendline is computed for the entire dataset, and replicated across all facets.

Type : stringAllowed values : trace  overall  Default value : trace

custom_data

Optional

str: Values from this column are displayed on the graph

Type : string