Skip to content

TemplateDefinition.md

Latest commit

 

History

History
219 lines (168 loc) · 12 KB

TemplateDefinition.md

File metadata and controls

219 lines (168 loc) · 12 KB
Raw

pdf_generator_api_client.model.template_definition.TemplateDefinition

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict,

Dictionary Keys

Key Input Type Accessed Type Description Notes
id decimal.Decimal, int, decimal.Decimal, Unique identifier [optional]
name str, str, Template name [optional]
tags list, tuple, tuple, A list of tags assigned to a template [optional]
isDraft bool, BoolClass, Indicates if the template is a draft or published. [optional]
layout dict, frozendict.frozendict, frozendict.frozendict, Defines template layout (e.g page format, margins). [optional]
pages list, tuple, tuple, Defines page or label size, margins and components on page or label [optional]
dataSettings dict, frozendict.frozendict, frozendict.frozendict, Defines filter and sort option for root data set. [optional]
editor dict, frozendict.frozendict, frozendict.frozendict, Configuration preferences for the editor [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

tags

A list of tags assigned to a template

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple, A list of tags assigned to a template

Tuple Items

Class Name Input Type Accessed Type Description Notes
items str, str,

layout

Defines template layout (e.g page format, margins).

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Defines template layout (e.g page format, margins).

Dictionary Keys

Key Input Type Accessed Type Description Notes
format str, str, Defines template page size [optional] must be one of ["A4", "letter", "custom", ]
width decimal.Decimal, int, float, decimal.Decimal, Page width in units [optional]
height decimal.Decimal, int, float, decimal.Decimal, Page height in units [optional]
unit str, str, Measure unit [optional] must be one of ["cm", "in", ]
orientation str, str, Page orientation [optional] must be one of ["portrait", "landscape", ]
rotation decimal.Decimal, int, decimal.Decimal, Page rotation in degrees [optional] must be one of [0, 90, 180, 270, ]
margins dict, frozendict.frozendict, frozendict.frozendict, Page margins in units [optional]
repeatLayout dict, frozendict.frozendict, None, frozendict.frozendict, NoneClass, Defines page size if layout is repeated on the page e.g sheet labels [optional]
emptyLabels decimal.Decimal, int, decimal.Decimal, Defines how many pages or labels should be empty [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

margins

Page margins in units

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Page margins in units

Dictionary Keys

Key Input Type Accessed Type Description Notes
top decimal.Decimal, int, float, decimal.Decimal, [optional]
right decimal.Decimal, int, float, decimal.Decimal, [optional]
bottom decimal.Decimal, int, float, decimal.Decimal, [optional]
left decimal.Decimal, int, float, decimal.Decimal, [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

repeatLayout

Defines page size if layout is repeated on the page e.g sheet labels

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, None, frozendict.frozendict, NoneClass, Defines page size if layout is repeated on the page e.g sheet labels

Dictionary Keys

Key Input Type Accessed Type Description Notes
format str, str, Defines template page size [optional] must be one of ["A4", "letter", "custom", ]
width decimal.Decimal, int, float, decimal.Decimal, Page width in units [optional]
height decimal.Decimal, int, float, decimal.Decimal, Page height in units [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

pages

Defines page or label size, margins and components on page or label

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple, Defines page or label size, margins and components on page or label

Tuple Items

Class Name Input Type Accessed Type Description Notes
items dict, frozendict.frozendict, frozendict.frozendict,

items

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict,

Dictionary Keys

Key Input Type Accessed Type Description Notes
width decimal.Decimal, int, float, decimal.Decimal, Page width in units [optional]
height decimal.Decimal, int, float, decimal.Decimal, Page height in units [optional]
margins dict, frozendict.frozendict, frozendict.frozendict, [optional]
components list, tuple, tuple, [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

margins

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict,

Dictionary Keys

Key Input Type Accessed Type Description Notes
right decimal.Decimal, int, float, decimal.Decimal, Page or label margin from right [optional]
bottom decimal.Decimal, int, float, decimal.Decimal, Page or label margin from bottom [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

components

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple,

Tuple Items

Class Name Input Type Accessed Type Description Notes
Component Component Component

dataSettings

Defines filter and sort option for root data set.

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Defines filter and sort option for root data set.

Dictionary Keys

Key Input Type Accessed Type Description Notes
sortBy list, tuple, tuple, [optional]
filterBy list, tuple, tuple, [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

sortBy

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple,

Tuple Items

Class Name Input Type Accessed Type Description Notes
items dict, frozendict.frozendict, frozendict.frozendict,

items

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict,

filterBy

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple,

Tuple Items

Class Name Input Type Accessed Type Description Notes
items dict, frozendict.frozendict, frozendict.frozendict,

items

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict,

editor

Configuration preferences for the editor

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Configuration preferences for the editor

Dictionary Keys

Key Input Type Accessed Type Description Notes
heightMultiplier decimal.Decimal, int, float, decimal.Decimal, [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]