plotoptions.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Contains the PlotOption class."""


class PlotOptions:
    """
    Container objects which include all plot options provided by plotid.

    Methods
    -------
    __init__figs : figure object
        Figure that will be tagged.
    prefix : str
        Prefix that is placed before the ID.
    id_method : int
        Method that decides which method is used to generate the ID.
    rotation : int
        Rotation angle for the ID.
    position : tuple
        Relative position of the ID on the plot (x,y).
    """

    def __init__(self, figs, prefix, id_method, rotation, position):

        self.figs = figs
        self.prefix = prefix
        self.id_method = id_method
        self.rotation = rotation
        self.position = position