Method dictTable

SLiCAP/SLiCAPrst.py:165–199

Creates a table from a dictionary; optionally with a header. If no label AND no caption are given this method returns a LaTeX tabular snippet. Else it returns a table snippet. :param dct: Dictionary with key-value pairs. :type circuitObject: dict

(self, dct, head=None, label="", caption="")

        return Snippet(RST, self.format)

    def dictTable(self, dct, head=None, label="", caption=""):
        """
        Creates a table from a dictionary; optionally with a header.
        If no label AND no caption are given this method returns a LaTeX
        tabular snippet. Else it returns a table snippet.

        :param dct: Dictionary with key-value pairs.
        :type circuitObject: dict
        
        :param head: List with names for the key column and the value column, respectively.
                     List items will be converted to string.
        :type head: list
        
        :param label: Reference label for the table. Defaults to an empty string.
        :type label: str
        
        :param caption: Text that will used as table caption.
        :type caption: str
        
        :return: SLiCAP Snippet object
        :rtype: SLiCAP.SLiCAPprotos.Snippet
        """
        RST = None
        if len(dct.keys()) > 0:
            if type(head) == list and len(head) == 2:
                headerList = [str(head[0]), str(head[1])]
            else: 
                headerList  = ["", ""]
            linesList   = []
            for key in dct.keys():
                line = [key, ":math:`" + sp.latex(roundN(dct[key])) + "`" ]
                linesList.append(line)
            RST = _RSTcreateCSVtable(caption, headerList, linesList, 
                                     label=label)
        return Snippet(RST, self.format)
    
    def params(self, circuitObject, label="", caption=""):
        """