Back to bricks list
Introduction
Technical Documentation
Tasks
Histogram Plotly
Version

Histogram Plotly

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

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

Optional Advanced parameter

Plotly template to use

Type : string

animation_frame

Optional Advanced parameter

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

Type : string

animation_group

Optional Advanced 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

Optional Advanced parameter

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

Type : bool

log_y

Optional Advanced parameter

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

Type : bool

range_x

Optional Advanced parameter

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

Type : string

range_y

Optional Advanced parameter

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

Type : string

width

Optional Advanced parameter

int: The figure width in pixels.

Type : int

height

Optional Advanced parameter

int The figure height in pixels

Type : int

label_columns

Optional Advanced parameter

one column per line, and same line for the text

Type : list

label_text

Optional Advanced parameter

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

Type : list

facet_row

Optional Advanced parameter

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

Type : string

facet_col

Optional Advanced parameter

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

Type : string

facet_col_wrap

Optional Advanced parameter

int: Maximum number of facet columns.

Type : int

facet_row_spacing

Optional Advanced 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

Optional Advanced 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

Optional Advanced parameter

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

Type : list

hover_name

Optional Advanced parameter

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

Type : string

orientation

Optional Advanced parameter

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

Type : stringDefault value : v

opacity

Optional Advanced parameter

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

Type : float

barmode

Optional Advanced parameter

Bar mode for stacked or grouped histograms

Type : string

marginal

Optional Advanced parameter

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

Type : string

barnorm

Optional Advanced 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 : string

histnorm

Optional Advanced parameter

Histogram normalization

Type : string

histfunc

Optional

Function used to aggregate values for summarization

Type : stringDefault value : count

cumulative

Optional

cumulative or not

Type : bool

nbins

Optional Advanced parameter

Sets the number of bins

Type : int