ScatterConfig

class pyopenms_viz._config.ScatterConfig(*, kind: ~typing.Literal['line', 'vline', 'scatter', 'chromatogram', 'mobilogram', 'spectrum', 'peakmap', 'complex'] | None = None, x: str | None = None, y: str | None = None, z: str | None = None, by: str | None = None, canvas: ~typing.Any = None, height: int = 500, width: int = 500, grid: bool = True, toolbar_location: str = 'above', title: str = '', xlabel: str = '', ylabel: str = '', zlabel: str = '', title_font_size: int = 18, xaxis_label_font_size: int = 16, yaxis_label_font_size: int = 16, zaxis_label_font_size: int = 16, xaxis_labelpad: int = 16, yaxis_labelpad: int = 16, zaxis_labelpad: int = 9, xaxis_tick_font_size: int = 14, yaxis_tick_font_size: int = 14, zaxis_tick_font_size: int = 14, y_axis_location: ~typing.Literal['left', 'right'] = 'left', x_axis_location: ~typing.Literal['above', 'below'] = 'below', annotation_font_size: int = 12, color: str | ~typing.Iterator[str] = <factory>, plot_3d: bool = False, min_border: int = 0, show_plot: bool = True, relative_intensity: bool = False, aggregate_duplicates: bool = False, legend_config: ~pyopenms_viz._config.LegendConfig | dict = <factory>, opacity: float = 1.0, bin_peaks: ~typing.Literal['auto'] | bool = 'auto', num_x_bins: int = 50, num_y_bins: int = 50, z_log_scale: bool = False, fill_by_z: bool = True, marker_size: int = 30, marker: ~typing.Iterator[str] | ~pyopenms_viz._misc.MarkerShapeGenerator = <factory>)

Bases: BasePlotConfig

Configuration for a scatter plot.

bin_peaks

Whether to bin peaks. Default is “auto”, can also be set to True or False.

Type:

Union[Literal[“auto”], bool]

num_x_bins

Number of bins along the X-axis. Default is 50. Ignored if bin_peaks is False or “auto”.

Type:

int

num_y_bins

Number of bins along the Y-axis. Default is 50. Ignored if bin_peaks is False or “auto”.

Type:

int

z_log_scale

Whether to use logarithmic scale for Z-axis. Default is False.

Type:

bool

fill_by_z

Whether to fill markers by Z value. Default is True.

Type:

bool

marker_size

Size of the markers. Default is 30.

Type:

int

marker

Marker shapes. Default is a MarkerShapeGenerator instance.

Type:

Iterator[str] | MarkerShapeGenerator

__eq__(other)

Return self==value.

__hash__ = None

__init__(*, kind: ~typing.Literal['line', 'vline', 'scatter', 'chromatogram', 'mobilogram', 'spectrum', 'peakmap', 'complex'] | None = None, x: str | None = None, y: str | None = None, z: str | None = None, by: str | None = None, canvas: ~typing.Any = None, height: int = 500, width: int = 500, grid: bool = True, toolbar_location: str = 'above', title: str = '', xlabel: str = '', ylabel: str = '', zlabel: str = '', title_font_size: int = 18, xaxis_label_font_size: int = 16, yaxis_label_font_size: int = 16, zaxis_label_font_size: int = 16, xaxis_labelpad: int = 16, yaxis_labelpad: int = 16, zaxis_labelpad: int = 9, xaxis_tick_font_size: int = 14, yaxis_tick_font_size: int = 14, zaxis_tick_font_size: int = 14, y_axis_location: ~typing.Literal['left', 'right'] = 'left', x_axis_location: ~typing.Literal['above', 'below'] = 'below', annotation_font_size: int = 12, color: str | ~typing.Iterator[str] = <factory>, plot_3d: bool = False, min_border: int = 0, show_plot: bool = True, relative_intensity: bool = False, aggregate_duplicates: bool = False, legend_config: ~pyopenms_viz._config.LegendConfig | dict = <factory>, opacity: float = 1.0, bin_peaks: ~typing.Literal['auto'] | bool = 'auto', num_x_bins: int = 50, num_y_bins: int = 50, z_log_scale: bool = False, fill_by_z: bool = True, marker_size: int = 30, marker: ~typing.Iterator[str] | ~pyopenms_viz._misc.MarkerShapeGenerator = <factory>) → None

__repr__()

Return repr(self).