graphinglib.Heatmap.__init__#
- Heatmap.__init__(image: TypeAliasForwardRef('ArrayLike') | str, x_axis_range: tuple[float, float] | None = None, y_axis_range: tuple[float, float] | None = None, color_map: str | Colormap = 'default', show_color_bar: bool | Literal['default'] = 'default', alpha_value: float = 1.0, aspect_ratio: str | float = 'default', origin_position: str = 'default', interpolation: str = 'none') None[source]#
The class implements heatmaps.
- Parameters:
- imageArrayLike or str
Image to display as an array of values or from a file.
- x_axis_range, y_axis_rangetuple[float, float], optional
The range of x and y values used for the axes as tuples containing the start and end of the range.
- color_mapstr, Colormap
The color map to use for the
Heatmap. Can either be specified as a string (named colormap from Matplotlib) or a Colormap object. Default depends on thefigure_styleconfiguration.- show_color_barbool
Whether or not to display the color bar next to the plot. Defaults to
True.- alpha_valuefloat
Opacity value of the
Heatmap. Defaults to 1.0.- aspect_ratiostr or float
Aspect ratio of the axes. Default depends on the
figure_styleconfiguration.- origin_positionstr
Position of the origin of the axes (upper left or lower left corner). Default depends on the
figure_styleconfiguration.- interpolationstr
Interpolation method to be applied to the image. Defaults to
"none".See also
For other interpolation methods, refer to Interpolations for imshow.