:py:mod:`vspyx.Reporting`
=========================

.. py:module:: vspyx.Reporting


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   vspyx.Reporting.Image
   vspyx.Reporting.Module
   vspyx.Reporting.Paragraph
   vspyx.Reporting.Report
   vspyx.Reporting.Section
   vspyx.Reporting.Table
   vspyx.Reporting.TestResultBuilder




.. py:class:: Image

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Image
      :parts: 1
      :private-bases:

   Image
           

   .. py:class:: Alignments

      Bases: :py:obj:`enum.IntEnum`

      .. autoapi-inheritance-diagram:: vspyx.Reporting.Image.Alignments
         :parts: 1
         :private-bases:

      Enum where members are also (and must be) ints

      .. py:attribute:: Bottom
         :annotation: = 2

         

      .. py:attribute:: Center
         :annotation: = 4

         

      .. py:attribute:: Left
         :annotation: = 3

         

      .. py:attribute:: Middle
         :annotation: = 1

         

      .. py:attribute:: Right
         :annotation: = 5

         

      .. py:attribute:: Top
         :annotation: = 0

         


   .. py:attribute:: Alignment
      :annotation: :Any

      

   .. py:attribute:: Height
      :annotation: :Any

      

   .. py:attribute:: Path
      :annotation: :str

      

   .. py:attribute:: Scale
      :annotation: :Any

      

   .. py:attribute:: Target
      :annotation: :Any

      

   .. py:attribute:: Width
      :annotation: :Any

      

   .. py:method:: AlternateText(self) -> Any


   .. py:method:: SetAlternateText(self, set: str) -> Any



.. py:class:: Module

   Bases: :py:obj:`vspyx.Core.Module`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Module
      :parts: 1
      :private-bases:

   Module
           

   .. py:method:: NewReport(self) -> Report



.. py:class:: Paragraph

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Paragraph
      :parts: 1
      :private-bases:

   Paragraph
           

   .. py:attribute:: Text
      :annotation: :str

      


.. py:class:: Report

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Report
      :parts: 1
      :private-bases:

   Report
           

   .. py:attribute:: Author
      :annotation: :str

      

   .. py:attribute:: Copyright
      :annotation: :str

      

   .. py:attribute:: RootSection
      :annotation: :Section

      

   .. py:attribute:: Subtitle
      :annotation: :str

      

   .. py:attribute:: TableOfContents
      :annotation: :bool

      

   .. py:attribute:: Title
      :annotation: :str

      

   .. py:attribute:: TitleLogoPath
      :annotation: :str

      

   .. py:attribute:: TitlePage
      :annotation: :bool

      

   .. py:method:: BuildHTML(self, path: str) -> vspyx.Core.Task_ef25277eaf


   .. py:method:: BuildPDF(self, path: str) -> vspyx.Core.Task_ef25277eaf



.. py:class:: Section

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Section
      :parts: 1
      :private-bases:

   Section
           

   .. py:attribute:: Name
      :annotation: :str

      

   .. py:method:: NewImage(self, path: str) -> Image


   .. py:method:: NewParagraph(self) -> Paragraph


   .. py:method:: NewSection(self) -> Section


   .. py:method:: NewTable(self) -> Table



.. py:class:: Table

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.Table
      :parts: 1
      :private-bases:

   Table
           

   .. py:method:: AddRow(self, cells: List[str]) -> Any
               AddRow(self, cells: List[str], multiColumn: Any) -> Any


   .. py:method:: SetHeader(self, cells: List[str]) -> Any



.. py:class:: TestResultBuilder

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.Reporting.TestResultBuilder
      :parts: 1
      :private-bases:

   TestResultBuilder
           

   .. py:method:: End(self) -> Section


   .. py:method:: Fail(self, message: str) -> Any