Skip to main content
To create an instance of the PitchPrint class, here are the possible options you can pass in:
The parameters value is a key-value object and are defined as follows:
​
string
required
The API Key generated from the admin portal and assigned to your domain. This identifies each domain from the other, not the domain name which can be renamed at any time. You can generate your apiKey from here.
​
string
The ID of the design you intend to load for new projects. To get a listing of all designs under your account, you can call up this endpoint URL from the admin.
​
string
The mode in which the app should load. Default value should be new. When a user has finished creating a design but has not left the page, they may decide they want to edit again. Set this to edit just before loading up the editor for editing.
​
object
The product details passed in as a value-pair object. Useful when reading through the project design file or when you need to identify each project design against your products. It can contain any values you desire, but we normally use Id and title, so it looks like: {id: 'xyz', title: 'Purple Phamplets'}
​
string
Language code the editor should use. If omitted, ‘en’ English will be used. Here is the list of all languages to which PitchPrint has been translated:
  • bg – Bulgarian
  • ca – Catalan
  • cs – Czech
  • da – Danish
  • nl – Dutch
  • fi – Finnish
  • fr – French
  • de – German
  • el – Greek
  • he – Hebrew
  • hu – Hungarian
  • id – Indonesian
  • it – Italian
  • lv – Latvian
  • lt – Lithuanian
  • no – Norwegian
  • pl – Polish
  • pt – Portuguese
  • pt-br – Portuguese (Brazilian)
  • ru – Russian
  • es – Spanish
  • sl – Slovak
  • sv – Swedish
  • tr – Turkish
  • vi – Vietnamese
This is different from the lang property.
​
string
A unique code we use to reference each user. For every user that instantiates the app, a folder is created on the server so their pictures and design projects can be saved and referenced anytime.
If this value is omitted, we will use ‘guest’. When the user reloads the app on a different browser their images and assets are lost. Provide a unique ID to identify each user and store their assets separately and safely.
​
string
A key-value pair of the user’s additional information like email, address, phone etc that you want attached to the particular project and shown on the projects page in our admin.
​
string
A unique code used to save the project on the server. We advise you leave it blank, which gives the server the ease to generate a unique ID of its own.After a project has been saved, this ID is passed down to you via the onSave function as stated above. You can subsequently pass it in as an ID if you want to edit the same project or retrieve the PDF file.
​
string
Always set this to true. It allows the class to prevent some default actions which we have baked in for popular frameworks.

Events

Listen for and fire events on the PitchPrint client.

Designer ready method

Hook your custom code into the editor once the designer is ready.