RegionVisual

class regions.RegionVisual(seq=None, **kwargs)[source]

Bases: Meta

A dictionary subclass which holds the visual attributes of the region.

Attributes Summary

key_mapping

valid_keys

Methods Summary

define_mpl_kwargs(artist)

Define a dictionary of matplotlib keywords for the input artist from the region's visual properties.

Attributes Documentation

key_mapping = {'point': 'symbol', 'width': 'linewidth'}
valid_keys = ['color', 'dash', 'dashlist', 'fill', 'font', 'fontname', 'fontsize', 'fontstyle', 'fontweight', 'labeloff', 'labelpos', 'labelcolor', 'line', 'linestyle', 'linewidth', 'marker', 'markersize', 'symbol', 'symsize', 'symthick', 'textangle', 'textrotate', 'usetex', 'default_style', 'dashes', 'markeredgewidth', 'rotation', 'facecolor', 'edgecolor']

Methods Documentation

define_mpl_kwargs(artist)[source]

Define a dictionary of matplotlib keywords for the input artist from the region’s visual properties.

Parameters:
artist{‘Text’, ‘Line2D’, ‘Patch’}

The matplotlib artist type.

Returns:
resultdict

A dictionary of matplotlib keyword arguments.