Printity framework API reference

This is a documentation of how you can call Printityframework API server to create your own custom PDFs
Included in this documentation the objects of PFW (Printity framework) and their properties and a complete JSON Examples of how you can call the API server.

Section 1: Main document {PFW_Document}

This is the main object which defines the document itself, These are the properties in this object
Paper size
Enum {A4, A5}
This will define the pages dimensions of the document, currently we support A4, and A5 paper sizes
Tables
PFW_Table[]
This is an array of table objects, this will allow you to add tables to the document, we support multiple tables definitions to the documents.
Labels
PFW_PlaceLabel[]
This is an array of label objects, this type of objects will allow you to add labels / captions / titles to your documents that will repeat with every page
PlaceHeaderValues
PFW_PlaceHeaderValue[]
This is an array of header value objects, they're much like labels, but each object contains a header and a value objects, this type is suitable for adding sums / avgs / and other titled objects

Section 2: Font {PFW_Font}

This is the main holder of the font related properties, and other text decoration properties
FontName
String
A string holder for the font-family name, default is Arial.
Bold
Boolean
A boolean holder for the text bold property, default is false.
Italic
Boolean
A boolean holder for the text italic property, default is false.
Underline
Boolean
A boolean holder for the text underline property, default is false.
Size
Integer
An integral holder for the text size property.
Color
Color
A color holder for the text color property.

Section 3: Border {PFW_Border}

This is the main holder of the border related properties.
BorderColor
Color
The main color of the borders.
TopBorderColor
Color
The top border color.
LeftBorderColor
Color
The left border color.
BottomBorderColor
Color
The bottom border color.
RightBorderColor
Color
The right border color.
BorderSize
float
The main border size.
TopBorderSize
float
The top border size.
LeftBorderSize
float
The left border size.
BottomBorderSize
float
The bottom border size.
RightBorderSize
float
The right border size.

Section 4: Font {PFW_Font}

This is the main holder of font and writing related properties.
FontName
String
The font (family) name for the writing object.
Bold
Boolean
Is the writing text bold or normal (regular).
Italic
Boolean
Is the writing text italic or normal (regular).
Underline
Boolean
Is the writing text underlined or not.
Size
Integer
To set the font size of the writing text.
Color
Color
Set the color of the writing text.

Section 5: Label {PFW_PlaceLabel}

This is a drawable object to place a label on the printed document, and repeating it in every page.
BackgroundColor
Color
Sets the background color of the label.
Bounds
RectangleF
Sets the bounds (Top, Left, Height, Width) of the label.
BoundsUnit
Enum {Percent, Dot (Currently represented as Millimeter)}
The unit of the bounds.
Text
String
The text that will be written on the label.
Font
PFW_Font
The label text font properties.
HAlign
Enum {Left, Center, Right}
The horizontal alignment for text written in the label.
VAlign
Not implemented yet
The vertical alignment for text written in the label.
Border
PFW_Border
The properties of the label's border

Section 6: Header value {PFW_PlaceHeaderValue}

This is a drawable object combines two labels, one for the header and one for the value (AKA: master detail).
Bounds
RectangleF
The bounds of the value label.
BoundsUnit
Enum {Percent, Dot (Currently represented as Millimeter)}
The measuring unit of the bounds of the value label
HeaderBounds
RectangleF
The bounds of the header label
HeaderBoundsUnit
Enum {Percent, Dot (Currently represented as Millimeter)}
The measuring unit of the bounds of the header label.
Header
String
The text of the header label.
Text
String
The text of the value label
Font
PFW_Font
The font of the value text.
HeaderFont
PFW_Font
The font of the header text
HeaderHAlign
Enum {Left, Center, Right}
The horizontal alignment of the header text.
HeaderVAlien
Not implemented yet
The vertical alignment of the header text.
HAlign
Enum {Left, Center, Right}
The horizontal alignment of the value text.
VAlien
Not implemented yet
The vertical alignment of the header text.
BackGroundColor
Color
The background color of the value label
HeaderBackgroundColor
Color
The background color of the header label
Border
PFW_Border
The border of the value label
HeaderBorder
PFW_Border
The border of the value label

Section 7: Table column {PFW_TableColumn}

This is a container for the properties and functions of a single column in any table.
PropertyName
String
Sets the property name in the data set to be displayed in the column.
HeaderText
String
Sets the column's header text.
Width
Float
Sets the column's width
WidthUnit
Enum {Percent, Dot (Currently represented as Millimeter)}
The measuring unit of the column's width.
HeaderFont
PFW_Font
Sets the font and writing attributes of the header.
Font
PFW_Font
Sets the font and writing attributes of the data rows.
AlternatingFont
PFW_Font
Sets the font and writing attributes of the data alternate rows.
HeaderHAlign
Enum {Left, Center, Right}
The horizontal alignment of the header text.
HeaderHAlign
Enum {Left, Center, Right}
The horizontal alignment of the header text.
HeaderVAlien
Not implemented yet
The vertical alignment of the header text.
HAlign
Enum {Left, Center, Right}
The horizontal alignment of the row data text.
VAlien
Not implemented yet
The vertical alignment of the row data text.
BackGroundColor
Color
The background color of the row cells.
HeaderBackgroundColor
Color
The background color of the header cell.
AlternateBackgroundColor
Color
The background color of the alternate row cell.
Border
PFW_Border
The border of the rows cells
HeaderBorder
PFW_Border
The border of the header cell.

Section 8: Table {PFW_Table}

This is the main drawable object for tables and grids.
Columns
Collection<PFW_TableColumn>
A collection of columns for this table.
RowHeaderHeight
Float
Sets the column's header cell height.
RowHeight
Float
Sets the column's data cells height
Bounds
RectangleF
The boundaries of the table.
BoundsUnit
Enum {Percent, Dot (Currently represented as Millimeter)}
The measurement unit of the table's bounds.
BackgroundColor
Color
Sets the background color of the data rows, this will be overridden by the column's background color property if set.
HeaderBackgroundColor
Color
Sets the background color of the header rows, this will be overridden by the column's header background color property if set.
AlternateBackgroundColor
Color
Sets the background color of the alternate rows, this will be overridden by the column's alternate background color property if set.
Data
Collection
An array or collection of objects define the data to be displayed on the table, the generic data type of this collection is the class that will be turned into columns.
An error has occurred. This application may no longer respond until reloaded. Reload 🗙