| Table of Contents |
|---|
...
| Excerpt |
|---|
Print Template Editor allows for creating and editing of templates used for printing. Templates are represented in a specific paper size and consist of viewports designated for drawing content, legend windows, macros and additional texts or icons. |
...
You can edit some of the existing templates or add entirely new one.
...
To add new template, hit the New Button and a new Print Template form will appear:
...
Fill in the form with the information as follows:
Name: Select any meaningful name for the template. This name will be visible to the user.
Units: Select from available units in which the template will be expressed. This will influence margins.
Orientation: Select between Landscape and Portrait orientations. Dual orientation templates are not supported.
Format: Select paper format to be used. Print formats are defined in Printing → Print Formats
In the Margins section, define desired margins. Value 5 in this example, corresponds to 5 millimeters.
You should keep in mind that not all printers support margin-less printouts. A value that should be safe for most printers would be at least 0.25" (6.35 mm).
Editing Template Elements
...
When your new template is loaded, you can select and resize the viewport if needed, and also adjust default settings on the Edit Viewport panel. 
...
A new Viewport can be added with Add Viewport funtion available on the toolbar:
...
Viewport Information
...
This section contains an id and name of the selected viewport. It is created automatically and cannot be edited.
...
If the Scale parameter is required, the input field will become active and a proper value must be selected before continuing.
Available values:
Mode Name | API Code | Explanation | Resulting Scale on Printout | Scale Parameter Required |
|---|---|---|---|---|
Fit Drawing | 0 | Fit entire drawing to given window. | Exact scale will be used that will provide best fit to window. | No |
Match Drawing | 1 | Fit entire drawing to given window. | Closest possible scale from standard scales list will be used. | No |
Fit View | 2 | Fit selected view (spot view) to given window. | Exact scale will be used that will provide best fit to window. | No |
Match View | 3 | Fit selected view (spot view) to given window. | Closest possible scale from standard scales list will be used. | No |
Scale Drawing | 4 | Apply given scale and position the center of drawing in center of window. | Scale according to given value in "scale" parameter. | Yes |
Scale View | 5 | Apply given scale and position center of view in center of window. | Scale according to given value in "scale" parameter. | Yes |
Target Object Settings
...
This property can only be set for non-master viewports (with ID greater then 1). It allows you to specify a new target (context object) for that viewport in relation to master viewport.
...
Describes if for the context object the system should look for a target document linked to that object or if it should follow spot links
Document for spot | links to follow |
|---|---|
YES | If the object has a spot (vector element, icon) that is located on any drawing, then use this drawing |
NO | Follow a default link to document for a API perspective (See Hopa settings). If there is no default link, follow a link to first document. |
It is important to note, that the object will be discovered using provided perspective, but the actual document will be discovered by using HOPA system perspective.
...
sides and the image was filled in to match viewport vertically (top/bottom).
...
Mask Mode
Available only for Document for spot mode. Determines if the space outside of spot (element representing an object) is visible. 
...
Legends
Each template can contain a single legend window that can be added using Add Legend Window function from the toolbar:
...
Content of the legend window will be filled in dynamically with legend corresponding to an applied filter in master viewport.
Legend window will not expand dynamically, so make sure it is capable of holding a typical legend size.
...
If the legend content will overflow, information about number of missing elements will be shown on the legend as indicated by the red arrow:
...
Scale ruler
Rectangle for scale ruler can be added to template choosing Add Scale Ruler button from Viewport toolbar.
...
Template can have more that one scale ruler if needed. Ruler do not have any parameter but width, that influence how many units will be shown on printout.
...
Ruler units will be taken from composite drawing and number of values will depend on ruler width.
...
Additional static template elements like lines, texts or polygons can be added to create a desired look. Use Shapes toolbar to select elements:
...
Icons
A static Icon can be placed on the template using Insert Icon function. Please note that new icons can be added to the system by using Icons manager (Administration → Icons)
Once added, Icon can be selected from a list:
...
Macros
Print templates can use macros to display print properties like Scale, Date but also metadata values of document itself and other linked object.
An examples would include:
name or other properties of the document being printed out
name of the floor, building, property
| Warning |
|---|
Macros are resolved only against master viewport (ID 1). |
...
To enter macro, use a Text function and ten select Macro checkbox to activate dynamic text:
...
Multi viewport example
This example will demonstrate how to setup a template that will display
a context document found for Room
floor drawing overview
a building view (facade)
and a document connected to property, containing placement of Building
Let's take a look at configuration of the template and corresponding structure in the system itself.
Object used in this example is a Room. It has it's representation on the document connected to Floor:
...
This content will be displayed in the main viewport. It does not require any specific settings as this context will be selected by the user before entering Print Preview:
...
The same drawing but in a full extents view can be shown in a second viewport. We can navigate to Floor class object and display the default document in a Fit Drawing or other modes.
(NOTE: A possibility to display the same contextual drawing as in viewport 1 by default is under development)
...
The buidling has a document with illustration of a facade connected to it:
...
We would like to see that drawing in a third viewport. To achieve that, we can select a "Fit Drawing" scale mode,
as well as use All Perspective Set and a proper "struct" (Building) class:
...
At last, the Bulding also has a vector element (spot) located on a document connected to Property object indicating a building location on a situation plan.
...
To obtain that view, we will use similar configuration as for Viewport 3, but with Document for spot option set. The difference will be that instead of showing default document for Building,
system will follow Building spot, that is located on a document connected to Property object:
...
The result will look as follows:
...
The benefit of predefined templates is such that they can be used in Print Preview mode and all viewports will be filled in automatically.
...
While printing primary document in main viewport, we can add additional viewports that will either contain the same document or navigate to a new target, like Building for example.
The navigation is performed according to chosen Perspective set and Target class in viewport settings:
...
When this object is found, in this case Building, we will lookup for document:
If Document for Spot option is checked and a spot link exists, it will be used to get document and new parameters will be used only if there are multiply spot links.
If DFS mode is not used (or there is no spot link), document to display is taken based on Document Perspective and Document Class (preferring default links if there are multiply documents for chosen class). Before introducing new parameters, document presented in viewport was chosen based on default HOPA settings in System Settings.
So the new parameters will allow to overwrite default setting for each of templates viewports. If they are left empty, default values from HOPA settings will be used as before.
HOPA usage
HopaGetView4Object parameter DefObjectClassId (DOC) - will overwrite new Document Class parameter from viewport settings therefore it will now support viewport suffix.
new param Perspective set from viewport settings will have a HOPA representation in docperspectivesetid (dpsetid) param.
Order of taking parameters
HOPA params in url: DefObjectClassId and docperspectivesetid.
Viewport's params Document Class and Document Perspective in template.
Default HOPA settings from System Settings.