Typings Module
datachart.typings
Module containing the typings
.
The typings
module contains the typings for all chart components. The module
is intended to contain the typings for easier input value format checkup.
ATTRIBUTE | DESCRIPTION |
---|---|
ChartAttrs |
The union of all chart attributes.
|
CLASS | DESCRIPTION |
---|---|
ChartCommonAttrs |
The chart attributes common to all chart types. |
VLinePlotAttrs |
The vertical line plot attributes. |
HLinePlotAttrs |
The horizontal line plot attributes. |
LineChartAttrs |
The line chart attributes. |
LineSingleChartAttrs |
The single chart attributes for the line chart. |
LineDataPointAttrs |
The data point attributes for the line chart. |
BarChartAttrs |
The bar chart attributes. |
BarSingleChartAttrs |
The single chart attributes for the bar chart. |
BarDataPointAttrs |
The data point attributes for the bar chart. |
HistogramChartAttrs |
The histogram chart attributes. |
HistogramSingleChartAttrs |
The single chart attributes for the histogram chart. |
HistDataPointAttrs |
The data point attributes for the histogram chart. |
HeatmapChartAttrs |
The heatmap chart attributes. |
HeatmapSingleChartAttrs |
The single chart attributes for the heatmap chart. |
HeatmapColorbarAttrs |
The heatmap colorbar attributes. |
StyleAttrs |
The style typing. |
ColorGeneralStyleAttrs |
The typing for the general color style. |
FontStyleAttrs |
The typing for the font style. |
AxesStyleAttrs |
The typing for the axes style. |
LegendStyleAttrs |
The typing for the legend style. |
AreaStyleAttrs |
The typing for the area style. |
GridStyleAttrs |
The typing for the grid style. |
LineStyleAttrs |
The typing for the line style. |
BarStyleAttrs |
The typing for the bar style. |
HistStyleAttrs |
The typing for the histogram style. |
VLineStyleAttrs |
The typing for the vertical line style. |
HLineStyleAttrs |
The typing for the horizontal line style. |
HeatmapStyleAttrs |
The typing for the heatmap style. |
Chart Typings
Common Chart Typings
datachart.typings.ChartAttrs
The union of all chart attributes.
datachart.typings.ChartCommonAttrs
Bases: TypedDict
The chart attributes common to all chart types.
ATTRIBUTE | DESCRIPTION |
---|---|
title |
The title of the charts.
TYPE:
|
xlabel |
The xlabel of the charts.
TYPE:
|
ylabel |
The ylabel of the charts.
TYPE:
|
figsize |
The size of the figure.
TYPE:
|
xmin |
Determine the minimum x-axis value.
TYPE:
|
xmax |
Determine the maximum x-axis value.
TYPE:
|
ymin |
Determine the minimum y-axis value.
TYPE:
|
ymax |
Determine the maximum y-axis value.
TYPE:
|
show_legend |
Whether or not to show the legend.
TYPE:
|
show_grid |
Determine which grid lines to show.
TYPE:
|
aspect_ratio |
The aspect ratio of the charts.
TYPE:
|
subplots |
Whether or not to create a separate subplot for each chart.
TYPE:
|
max_cols |
The maximum number of columns in the subplots. Active only when
TYPE:
|
sharex |
Whether or not to share the x-axis in the subplots. Active only when
TYPE:
|
sharey |
Whether or not to share the y-axis in the subplots. Active only when
TYPE:
|
datachart.typings.VLinePlotAttrs
Bases: TypedDict
The vertical line plot attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
x |
The x-axis position of the line.
TYPE:
|
ymin |
The minimum y-axis position value.
TYPE:
|
ymax |
The maximum y-axis position value.
TYPE:
|
style |
The vertical line style attributes.
TYPE:
|
label |
The label of the vertical line.
TYPE:
|
datachart.typings.HLinePlotAttrs
Bases: TypedDict
The horizontal line plot attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
y |
The x-axis position of the line.
TYPE:
|
xmin |
The minimum y-axis position value.
TYPE:
|
xmax |
The maximum y-axis position value.
TYPE:
|
style |
The horizontal line style attributes.
TYPE:
|
label |
The label of the horizontal line.
TYPE:
|
Line Chart Typings
datachart.typings.LineChartAttrs
Bases: ChartCommonAttrs
The line chart attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
charts |
The line chart definitions.
TYPE:
|
show_yerr |
Whether or not to show the y-axis errors.
TYPE:
|
show_area |
Whether or not to show the area under the lines.
TYPE:
|
scalex |
The scale of the x-axis.
TYPE:
|
scaley |
The scale of the y-axis.
TYPE:
|
datachart.typings.LineSingleChartAttrs
Bases: TypedDict
The single chart attributes for the line chart.
ATTRIBUTE | DESCRIPTION |
---|---|
data |
The list of data points defining the line chart.
TYPE:
|
subtitle |
The subtitle of the line chart. Also used as the label in the legend.
TYPE:
|
xlabel |
The xlabel of the line chart.
TYPE:
|
ylabel |
The ylabel of the line chart.
TYPE:
|
style |
The style of the line chart.
TYPE:
|
xticks |
The xtick positions list.
TYPE:
|
xticklabels |
The xtick labels.
TYPE:
|
xtickrotate |
The xtick rotation value.
TYPE:
|
yticks |
the ytick position list.
TYPE:
|
yticklabels |
The ytick labels.
TYPE:
|
ytickrotate |
The ytick rotation value.
TYPE:
|
vlines |
The vertical lines to be plot.
TYPE:
|
hlines |
The horizontal lines to be plot.
TYPE:
|
x |
The key name in
TYPE:
|
y |
The key name in
TYPE:
|
yerr |
The key name in
TYPE:
|
datachart.typings.LineDataPointAttrs
Bases: TypedDict
The data point attributes for the line chart.
ATTRIBUTE | DESCRIPTION |
---|---|
x |
The x-axis value.
TYPE:
|
y |
The y-axis value.
TYPE:
|
yerr |
The y-axis error value.
TYPE:
|
Bar Chart Typings
datachart.typings.BarChartAttrs
Bases: ChartCommonAttrs
The bar chart attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
charts |
The bar chart definitions.
TYPE:
|
show_yerr |
Whether or not to show the y-axis errors.
TYPE:
|
orientation |
The orientation of the bar charts.
TYPE:
|
scaley |
The scale of the y-axis.
TYPE:
|
datachart.typings.BarSingleChartAttrs
Bases: TypedDict
The single chart attributes for the bar chart.
ATTRIBUTE | DESCRIPTION |
---|---|
data |
The list of data points defining the bar chart.
TYPE:
|
subtitle |
The subtitle of the bar chart. Also used as the label in the legend.
TYPE:
|
xlabel |
The xlabel of the bar chart.
TYPE:
|
ylabel |
The ylabel of the bar chart.
TYPE:
|
style |
The style of the bar chart.
TYPE:
|
xticks |
The xtick positions list.
TYPE:
|
xticklabels |
The xtick labels.
TYPE:
|
xtickrotate |
The xtick rotation value.
TYPE:
|
yticks |
the ytick position list.
TYPE:
|
yticklabels |
The ytick labels.
TYPE:
|
ytickrotate |
The ytick rotation value.
TYPE:
|
vlines |
The vertical lines to be plot.
TYPE:
|
hlines |
The horizontal lines to be plot.
TYPE:
|
label |
The key name in
TYPE:
|
y |
The key name in
TYPE:
|
yerr |
The key name in
TYPE:
|
datachart.typings.BarDataPointAttrs
Bases: TypedDict
The data point attributes for the bar chart.
ATTRIBUTE | DESCRIPTION |
---|---|
label |
The label.
TYPE:
|
y |
The y-axis value.
TYPE:
|
yerr |
The y-axis error value.
TYPE:
|
Histogram Typings
datachart.typings.HistogramChartAttrs
Bases: ChartCommonAttrs
The histogram chart attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
charts |
The histogram chart definitions.
TYPE:
|
orientation |
The orientation of the histogram charts.
TYPE:
|
num_bins |
The number of bins the data points are split in to create the histogram.
TYPE:
|
show_density |
Whether or not to plot the density histogram.
TYPE:
|
show_cumulative |
Whether or not to plot the cumulative histogram.
TYPE:
|
scaley |
The scale of the y-axis.
TYPE:
|
datachart.typings.HistogramSingleChartAttrs
Bases: TypedDict
The single chart attributes for the histogram chart.
ATTRIBUTE | DESCRIPTION |
---|---|
data |
The list of data points defining the histogram chart.
TYPE:
|
subtitle |
The subtitle of the histogram chart. Also used as the label in the legend.
TYPE:
|
xlabel |
The xlabel of the histogram chart.
TYPE:
|
ylabel |
The ylabel of the histogram chart.
TYPE:
|
style |
The style of the histogram chart.
TYPE:
|
xticks |
The xtick positions list.
TYPE:
|
xticklabels |
The xtick labels.
TYPE:
|
xtickrotate |
The xtick rotation value.
TYPE:
|
yticks |
the ytick position list.
TYPE:
|
yticklabels |
The ytick labels.
TYPE:
|
ytickrotate |
The ytick rotation value.
TYPE:
|
vlines |
The vertical lines to be plot.
TYPE:
|
hlines |
The horizontal lines to be plot.
TYPE:
|
x |
The key name in
TYPE:
|
datachart.typings.HistDataPointAttrs
Bases: TypedDict
The data point attributes for the histogram chart.
ATTRIBUTE | DESCRIPTION |
---|---|
x |
The x-axis value.
TYPE:
|
Heatmap Typings
datachart.typings.HeatmapChartAttrs
Bases: ChartCommonAttrs
The heatmap chart attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
charts |
The heatmap chart definitions.
TYPE:
|
show_colorbars |
Whether or not to plot the density histogram.
TYPE:
|
show_heatmap_values |
Whether or not to plot the heatmap values.
TYPE:
|
datachart.typings.HeatmapSingleChartAttrs
Bases: TypedDict
The single chart attributes for the heatmap chart.
ATTRIBUTE | DESCRIPTION |
---|---|
data |
The list of data points defining the heatmap chart.
TYPE:
|
subtitle |
The subtitle of the heatmap chart. Also used as the label in the legend.
TYPE:
|
xlabel |
The xlabel of the heatmap chart.
TYPE:
|
ylabel |
The ylabel of the heatmap chart.
TYPE:
|
style |
The style of the heatmap chart.
TYPE:
|
norm |
The value normalization.
TYPE:
|
vmin |
The minimum value to normalize the data points.
TYPE:
|
vmax |
The maximum value to normalize the data points.
TYPE:
|
xticks |
The xtick positions list.
TYPE:
|
xticklabels |
The xtick labels.
TYPE:
|
xtickrotate |
The xtick rotation value.
TYPE:
|
yticks |
the ytick position list.
TYPE:
|
yticklabels |
The ytick labels.
TYPE:
|
ytickrotate |
The ytick rotation value.
TYPE:
|
colorbar |
The heatmap colorbar attributes.
TYPE:
|
datachart.typings.HeatmapColorbarAttrs
Bases: TypedDict
The heatmap colorbar attributes.
ATTRIBUTE | DESCRIPTION |
---|---|
orientation |
The orientation.
TYPE:
|
Style Typings
datachart.typings.StyleAttrs
Bases: ColorGeneralStyleAttrs
, FontStyleAttrs
, AxesStyleAttrs
, LegendStyleAttrs
, AreaStyleAttrs
, GridStyleAttrs
, LineStyleAttrs
, BarStyleAttrs
, HistStyleAttrs
, VLineStyleAttrs
, HLineStyleAttrs
, HeatmapStyleAttrs
The style attributes. Combines all style typings.
datachart.typings.ColorGeneralStyleAttrs
Bases: TypedDict
The typing for the general color style.
ATTRIBUTE | DESCRIPTION |
---|---|
color_general_singular |
The general color for the singular-typed charts.
TYPE:
|
color_general_multiple |
The general color for the multiple-typed charts.
TYPE:
|
datachart.typings.FontStyleAttrs
Bases: TypedDict
The typing for the font style.
ATTRIBUTE | DESCRIPTION |
---|---|
font_general_family |
The general font family.
TYPE:
|
font_general_sansserif |
The general sans-serif font.
TYPE:
|
font_general_color |
The general font color.
TYPE:
|
font_general_size |
The general font size.
TYPE:
|
font_general_style |
The general font style.
TYPE:
|
font_general_weight |
The general font weight.
TYPE:
|
font_title_size |
The title font size.
TYPE:
|
font_title_color |
The title font color.
TYPE:
|
font_title_style |
The title font style.
TYPE:
|
font_title_weight |
The title font weight.
TYPE:
|
font_subtitle_size |
The subtitle font size.
TYPE:
|
font_subtitle_color |
The subtitle font color.
TYPE:
|
font_subtitle_style |
The subtitle font style.
TYPE:
|
font_subtitle_weight |
The subtitle font weight.
TYPE:
|
font_xlabel_size |
The xlabel font size.
TYPE:
|
font_xlabel_color |
The xlabel font color.
TYPE:
|
font_xlabel_style |
The xlabel font style.
TYPE:
|
font_xlabel_weight |
The xlabel font weight.
TYPE:
|
font_ylabel_size |
The ylabel font size.
TYPE:
|
font_ylabel_color |
The ylabel font color.
TYPE:
|
font_ylabel_style |
The ylabel font style.
TYPE:
|
font_ylabel_weight |
The ylabel font weight.
TYPE:
|
datachart.typings.AxesStyleAttrs
Bases: TypedDict
The typing for the axes style.
ATTRIBUTE | DESCRIPTION |
---|---|
axes_spines_top_visible |
Make the top plot spine visible.
TYPE:
|
axes_spines_right_visible |
Make the right plot spine visible.
TYPE:
|
axes_spines_bottom_visible |
Make the bottom plot spine visible.
TYPE:
|
axes_spines_left_visible |
Make the left plot spine visible.
TYPE:
|
axes_spines_width |
The width of the spines.
TYPE:
|
axes_spines_zorder |
The zorder of the spines.
TYPE:
|
axes_ticks_length |
The length of the ticks.
TYPE:
|
axes_ticks_label_size |
The size of the tick labels.
TYPE:
|
datachart.typings.LegendStyleAttrs
Bases: TypedDict
The typing for the legend style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_legend_shadow |
Show the legends shadow.
TYPE:
|
plot_legend_frameon |
Show the legends frame.
TYPE:
|
plot_legend_alignment |
The legend alignment.
TYPE:
|
plot_legend_font_size |
The font size within the legend.
TYPE:
|
plot_legend_title_size |
The title size of the legend.
TYPE:
|
plot_legend_label_color |
The label color of the legend.
TYPE:
|
datachart.typings.AreaStyleAttrs
Bases: TypedDict
The typing for the area style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_area_alpha |
The alpha value of the area.
TYPE:
|
plot_area_color |
The color of the area.
TYPE:
|
plot_area_linewidth |
The line width of the area.
TYPE:
|
plot_area_hatch |
The hatch style of the area.
TYPE:
|
plot_area_zorder |
The zorder of the area.
TYPE:
|
datachart.typings.GridStyleAttrs
Bases: TypedDict
The typing for the grid style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_grid_alpha |
The alpha value of the grid.
TYPE:
|
plot_grid_color |
The color of the grid.
TYPE:
|
plot_grid_linewidth |
The line width of the grid.
TYPE:
|
plot_grid_linestyle |
The line style of the grid.
TYPE:
|
plot_grid_zorder |
The zorder of the grid.
TYPE:
|
datachart.typings.LineStyleAttrs
Bases: TypedDict
The typing for the line chart style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_line_color |
The line color.
TYPE:
|
plot_line_alpha |
The alpha value of the line.
TYPE:
|
plot_line_style |
The line style.
TYPE:
|
plot_line_marker |
The line marker.
TYPE:
|
plot_line_width |
The line width.
TYPE:
|
plot_line_drawstyle |
The line draw style.
TYPE:
|
plot_line_zorder |
The zorder of the line.
TYPE:
|
plot_xticks_label_rotate |
The label rotation of the xticks in the line chart.
TYPE:
|
plot_yticks_label_rotate |
The label rotation of the yticks in the line chart.
TYPE:
|
datachart.typings.BarStyleAttrs
Bases: TypedDict
The typing for the bar chart style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_bar_color |
The bar color.
TYPE:
|
plot_bar_alpha |
The alpha value of the bar.
TYPE:
|
plot_bar_width |
The width of the bar.
TYPE:
|
plot_bar_zorder |
The zorder of the bar.
TYPE:
|
plot_bar_hatch |
The hatch style of the bar.
TYPE:
|
plot_bar_edge_width |
The edge width of the bar.
TYPE:
|
plot_bar_edge_color |
The edge color of the bar.
TYPE:
|
plot_bar_error_color |
The color of the error line of the bar.
TYPE:
|
plot_xticks_label_rotate |
The label rotation of the xticks in the bar chart.
TYPE:
|
plot_yticks_label_rotate |
The label rotation of the yticks in the bar chart.
TYPE:
|
datachart.typings.HistStyleAttrs
Bases: TypedDict
The typing for the histogram chart style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_hist_color |
The color of the histogram.
TYPE:
|
plot_hist_alpha |
The alpha value of the histogram.
TYPE:
|
plot_hist_zorder |
The zorder of the histogram.
TYPE:
|
plot_hist_fill |
The fill of the histogram.
TYPE:
|
plot_hist_hatch |
The hatch style in the histogram.
TYPE:
|
plot_hist_type |
The type of the histogram.
TYPE:
|
plot_hist_align |
The alignment of the histogram.
TYPE:
|
plot_hist_edge_width |
The edge width of the histogram.
TYPE:
|
plot_hist_edge_color |
The edge color of the histogram.
TYPE:
|
plot_xticks_label_rotate |
The label rotation of the xticks in the histogram chart.
TYPE:
|
plot_yticks_label_rotate |
The label rotation of the yticks in the histogram chart.
TYPE:
|
datachart.typings.VLineStyleAttrs
Bases: TypedDict
The typing for the vertical line style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_vline_color |
The color of the vertical line.
TYPE:
|
plot_vline_style |
The style of the vertical line.
TYPE:
|
plot_vline_width |
The width of the vertical line.
TYPE:
|
plot_vline_alpha |
The alpha value of the vertical line.
TYPE:
|
datachart.typings.HLineStyleAttrs
Bases: TypedDict
The typing for the horizontal line style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_hline_color |
The color of the horizontal line.
TYPE:
|
plot_hline_style |
The style of the horizontal line.
TYPE:
|
plot_hline_width |
The width of the horizontal line.
TYPE:
|
plot_hline_alpha |
The alpha value of the horizontal line.
TYPE:
|
datachart.typings.HeatmapStyleAttrs
Bases: TypedDict
The typing for the heatmap chart style.
ATTRIBUTE | DESCRIPTION |
---|---|
plot_heatmap_cmap |
The color map of the heatmap.
TYPE:
|
plot_heatmap_alpha |
The alpha value of the heatmap.
TYPE:
|
plot_heatmap_font_size |
The font size of the heatmap.
TYPE:
|
plot_heatmap_font_color |
The font color of the heatmap.
TYPE:
|
plot_heatmap_font_style |
The font style of the heatmap.
TYPE:
|
plot_heatmap_font_weight |
The font weight of the heatmap.
TYPE:
|