Changes

Jump to: navigation, search

Report API

331 bytes added, 00:41, 28 April 2020
no edit summary
{{Out man note|The {{man label|Simple Document API interface}}|It is a report API([https://en.wikipedia.org/wiki/Application_programming_interface Application programming interface]) made for Gramps plugin/addon writers}} The [[Report_API|Simple Document API interface]] is for easy presentation of datethe data and can be used with [[Simple Access API]]. {{stub}}
In Gramps there are five different types of reports.
This common part is implemented in the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.basedoc.BaseDoc BaseDoc class], which contains among others basic document opening, closing, and stylesheet handling methods. It also stores the physical description of a page (sheet of paper in print).
'''{{man note|Note!''' |The <tt>BaseDoc.open</tt> and the <tt>BaseDoc.close</tt> methods have to be implemented by the subclassed document generators.}}
===Page===
==Text document API==
The specification of the Textdoc API is [https://pythonhostedgramps-project.org/Grampsdocs/gen/gen_plug.html#gramps.gen.plug.docgen.textdoc.TextDoc here]
The interface for adding media objects is as follows:
As at December 2014, output appears as follows:
{| {{Prettytable}} style="width:600px; font-size:100%;"
|-
! Format
==Draw document API==
{{stub}}
==Graph document API==
{{stub}}
[[Category:Developers/Reference]]
2,101
edits

Navigation menu