SINCE 4.1

Introduction

Dynamic labels can be generated on the drawing to display object metadata, similar to macros but placed automatically for every object that is represented on the drawing. 

Labels can be shaped according to user needs - from simple, single text value to more complex table with labels and header.

Data within the label can be fetched directly form a selected object or from other objects based on data perspectives, e.g. from upper floor or rental unit.

Labels are defined in similar way as visual, color based presentations and follow similar rules:

• they are displayed as read only element on the drawing

• they are printed together with the drawing

• they can be controlled through API, e.g. for HOPA integration calls, for CopyView etc.

Administration

Defining Labels

Before dynamic labels can be used, a definition must be configure in the Administration panel under Presentations → Dynamic Labels section.

From Labels grid (top), one can add, edit or delete Label definition. You can define label Name to be used when choosing labeling system (and optionally displayed in each label instance),

label Description and declare optionally object class to be used when searching for spots linked to objects of chosen class where labels are to be placed.

This is optional because alternatively individual classes could be assigned to each detail separately, allowing objects of multiple classes to be labeled within one labeling system.

On drawings where each object, e.g. space, has several spots linked and placed on different layers, one can choose singular layer from where spots should be used for labeling, similarly as in Presentation Filters system.
Set of flags can define final graphical shape of label - using of label name as a title for label, using of field name as description of each detail, using separating grid lines or rectangular frame lines,

finally usage of background that can obscure drawing beneath allowing label to be more readable.

To accept values entered in Label form when defining new or editing existing label, use Save button; use Close button instead to reject changes without saving.

Basic Label options:

• Name - any name that will optionally be used on top of each label box

• Description - internal description of label, not visible to end users

• Class - specific object class that the label will be applied to

• Layer - preferred global layer that should be used for object spot selection. 
  Note: labels will not be part of this layer, but spots from this layer will be used to determine size and position of the label. 

Label style options description:

1. Label name - Should the label name be displayed or not

2. Frame Lines - should the outer lines (frame) of the label be displayed

3. Field name - should field names be displayed

4. Grid lines - should the inner grid lines be displayed

5. Background - should the label use background. Common color for all labels can be set in system settings. 

Label Details

Each Label can have several associated Details (values) to be displayed within the Label. From Details grid (bottom), one can add, edit or delete Detail definition.

Label Detail parameters:

• Name - You can define detail name to be used as field name optionally displayed in each label instance

• Source class - class of objects to be used when searching for spots where labels are to be placed. If source class is defined in parent label, it becomes a default one for each detail. 
  However, one can freely define individual source class for each detail, allowing labels with different content to be displayed on spots linked to objects of various classes within the same labeling system.

• Target field - to point out what value is to be displayed in label detail, Target Field has to be chosen. In simplest case, it will be one of the fields chosen from metadata definition for object of chosen Source class. 
  However, it is possible to use more advanced scenario, when displayed value is to be taken from object of some other class that is linked to source class object along some perspective chain.
  To complete such scenario, it is necessary to select applicable Perspective set and then desired Target class that can be reached from source class along it.
  After such steps, Target Field is to be chosen among fields available for this class.

To accept values entered in Detail form when defining new or editing existing detail, use Save button; use Close button instead to reject changes without saving.

It is possible to define desired sequence of fields to be used when constructing a label, using standard drag'n'drop technique in Details grid:

Changed succession can be approved or discarded using Save or Cancel buttons in grid title bar. In case of any inconsistency, use Set Sequence button to renumber details.

Label Style

Graphical details regarding color, opacity and font size and family one can define in Administration → System → System Settings on Labels tab.

Administrator can set style for label Frame (Frame style tab) and for the text - in Text tab. 

Fill color defined in Layer tab is of use only when flag Background is set. Use appropriate opacity of background if you want not to obscure drawing beneath completely. It has to be mentioned also that font size suggested in Text sub-tab has only relative meaning. Actual size of label is calculated dynamically taking into account medium size of all spots to be labeled, so as to fit inside them with some arbitrary percentage. One can obtain greater or smaller effective size of labels using greater or smaller font size. The same scale used to generate final actual font size is used also when defining relative line width; alternatively, one can use fixed line width to have it constant independently on label and view scale.

Size and positioning of the labels

Label size must be determined based on element size that it is bound to. The font size is relative to average drawing element size.

Position of the label for complex shapes might differ from drawing to drawing. There might be some small differences between rendering of labels in view/preview as compared to printout.

Client Usage

In Document View window, it is possible to activate labels on drawing.
In Tools section of Drawing Toolbar, there is an Apply Dynamic Labels button. After activating this button, small form titled Dynamic Labels with Show Object Labels check-button and Labels combo box is displayed:

From Labels combo box, user can choose which labeling system is to be activated in Document View window.

List of labeling systems defined in Administration part is displayed. To activate it, select desired one and wait a moment until it will be loaded, calculated and displayed.

Labels are displayed on top of current overlay drawing and placed in separate temporary layer.

Layer with labels can be temporarily hidden to reveal obscured places in drawing beneath labels.

Use Show Object Labels check button on Dynamic Labels form to hide labels layer off and momentarily reveal it back on.

Labeling system once chosen remains active after reloading drawing or switching to another drawing, without need to activate it on each drawing separately.

Drawing with labels can be printed with the same content and appearance as presented in Document View. To switch off labeling system at all, choose None item.

Using labels for visual filter

On right-side Presentation pane, in the filter options there is additional Show presentation labels button:

After activating it, simple labels containing filter name are displayed inside each spot together with presentation filter applied.

It may be used as additional illustrative tool to enhance presentation readability and made it self-explanatory, especially where there are a lot of values available and colors might be hard to distinguish. 

HOPA usage

Two new parameters are introduced for HOPA.