Skip to main content
Ctrl+K
The documentation pages are currently work-in-progress, if you have any suggestions for improvements please raise an issue on the caf.viz repository.

CAF.viz 0.0.1+79.g544b197

  • Quick Start
  • User Guide
  • API Reference
  • Changelog
    • Issues
    • CAF Handbook
  • GitHub
  • Quick Start
  • User Guide
  • API Reference
  • Changelog
  • Issues
  • CAF Handbook
  • GitHub

Section Navigation

  • caf.viz
    • caf.viz.subplots
      • grid_plot
      • subplotter
      • Any
      • Callable
    • caf.viz.utils
      • normalise_name
      • style_names
    • caf.viz.web
      • caf.viz.web.mapping
        • NamedTuple
        • check_mask
        • check_output_path
        • map_datasets
        • produce_map_set
        • Bounds
        • Element
        • ExploreOptions
        • MacroElement
        • MapData
        • Mapping
        • Template
    • caf.viz.xy_plot
      • axes_plot_xy
      • hexbin
      • plot_xy
      • scatter
      • BasicData
        • BasicData.__init__
      • CmapData
        • CmapData.__init__
        • CmapData.get_label
      • XYPlotType

Indices

  • General Index
  • Python Module Index
  • API Reference
  • caf.viz
  • caf.viz.xy_plot
  • CmapData

CmapData#

class caf.viz.xy_plot.CmapData(column, label=None, auto_label=True, cmap='viridis')[source]#

Bases: object

Colormap parameters.

Attributes

auto_label

cmap

label

column

Methods

__init__(*args, **kwargs)

get_label()

Return label for colorbar.

Attributes Documentation

Parameters:
  • column (str)

  • label (str | None)

  • auto_label (bool)

  • cmap (str)

auto_label: bool = True#
cmap: str = 'viridis'#
label: str | None = None#
column: str[source]#

previous

BasicData.__init__

next

CmapData.__init__

On this page
  • CmapData
    • CmapData.auto_label
    • CmapData.cmap
    • CmapData.label
    • CmapData.column
Edit on GitHub

© Copyright 2025, Transport for the North.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.