PaperConfig

class PaperConfig(name, y_axis_up, origin_location, paper_size=None, paper_orientation=None, x_range=None, y_range=None, origin_location_reference='topleft', info='', rotate_180=False, set_ps=None, final_pu_params=None, aka_names=<factory>)

Data class containing configuration for a give plotter type/paper size combinations.

Methods

from_config

rtype: PaperConfig

Attributes

`final_pu_params`	if not None, these params are added to the final PU command
`info`	information printed to the user when paper is used
`origin_location_reference`	reference for `origin_location`
`paper_orientation`	orientation of the plotter coordinate system on paper
`paper_size`	X/Y axis convention of the plotter
`rotate_180`	if True, the geometries are rotated by 180 degrees on the page
`set_ps`	if not None, call PS with corresponding value
`x_range`	admissible range of X coordinates
`y_range`	admissible range of Y coordinates
`name`	name of the paper format
`y_axis_up`	if True, the Y axis point upwards instead of downwards
`origin_location`	location on paper of the (0, 0) plotter unit coordinates
`aka_names`	alternative paper names (will be found by `paper_config()`

Methods

classmethod PaperConfig.from_config(data)

Return type: PaperConfig

Attributes

PaperConfig.final_pu_params: Optional[str] = None: if not None, these params are added to the final PU command

PaperConfig.info: str = '': information printed to the user when paper is used

PaperConfig.origin_location_reference: Optional[str] = 'topleft': reference for origin_location

PaperConfig.paper_orientation: Optional[str] = None: orientation of the plotter coordinate system on paper

PaperConfig.paper_size: Optional[Tuple[float, float]] = None: X/Y axis convention of the plotter

PaperConfig.rotate_180: bool = False: if True, the geometries are rotated by 180 degrees on the page

PaperConfig.set_ps: Optional[int] = None: if not None, call PS with corresponding value

PaperConfig.x_range: Optional[Tuple[int, int]] = None: admissible range of X coordinates

PaperConfig.y_range: Optional[Tuple[int, int]] = None: admissible range of Y coordinates

PaperConfig.name: str: name of the paper format

PaperConfig.y_axis_up: bool: if True, the Y axis point upwards instead of downwards

PaperConfig.origin_location: Tuple[float, float]: location on paper of the (0, 0) plotter unit coordinates

PaperConfig.aka_names: List[str]: alternative paper names (will be found by paper_config()