Class MemoryMap

source code

Represents a map of memory regions with various highlighting.

Memory maps are divided into rows with constant number of cells, each
with individual highlighting rules (mostly coloring).

Attributes:
==========
column_headers: As table headers.
row_headers: (Optional) First column with row headers.
caption: (Optional) Should describe relationship between headers
         and row headers. Rendering is up to the renderer.
greyscale: If False (default) heatmap intensity values will be translated
           into colors with increasing hue. If True, shades of grey will
           be used instead with varying luminosity.

           Some subclasses may enforce this to be True or False.
legend: Instance of MapLegend explaining the map.
rows: Rows of constant number of cells each.
cells (read-only): All the cells.

Cell format:
============
Each cell is a dict with the following public keys:

heat (optional): Number between 0 and 1.0 signifying the relative heat.
                 Will be converted to color at rendering.
                 If not given, rgb must be given.
bg (optional): The actual desired color of the cell, given as tuple of
               (red, green, blue) with values of each in the 0-255 range.
               If not given, heat must be given.
fg (optional): Foreground color. Better not specified, will be derived
               from background.
value (optional): String contents of the cell. Usually something like
                  a number of hits in that part of the heatmap.

Cells may also end up containing non-public keys that are implementation
specific; they'll always be prefixed with an underscore, in the great
Pythonic tradition.