Login
Introduction
Technical Documentation
Tasks
Version

Histogram Plotly

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

Histogram plot from plotly(px)

Base class

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

opacity

OptionalAdvanced parameter

float: Value between 0 and 1. Sets the opacity for markers.

Type : float

barmode

OptionalAdvanced parameter

Bar mode for stacked or grouped histograms

Type : stringAllowed values : stack  group  overlay  relative 

marginal

OptionalAdvanced parameter

if set, a subplot is drawn alongside the main plot, visualising the distribution

Type : stringAllowed values : rug  box  violin  histogram 

barnorm

OptionalAdvanced parameter

If 'fraction', the value of each bar is divided by the sum of all values at that location coordinate. 'percent' is the same but multiplied by 100 to show percentages. None will stack up all values at each location coordinate.

Type : stringAllowed values : fraction  percent 

histnorm

OptionalAdvanced parameter

Histogram normalization

Type : stringAllowed values : percent  probability  density  probability density 

histfunc

Optional

Function used to aggregate values for summarization

Type : stringAllowed values : count  sum  avg  min  max  Default value : count

cumulative

Optional

cumulative or not

Type : bool

nbins

OptionalAdvanced parameter

Sets the number of bins

Type : int