Since 4.1

Introduction

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

These labels can be customized according to user preferences – from simple, single text values to more complex tables with labels and headers.

The data within the label can be retrieved directly from a selected object or from other objects based on data perspectives, such as those from upper floors or rental units.

Labels are defined in a similar manner as visual, color-based presentations and adhere to these rules:

• They are displayed as read-only elements on the drawing.

• They are printed together with the drawing.

• They can be controlled through API, for HOPA integration calls, CopyView operations, etc.

Administration

Defining Labels

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

Open

From the Labels grid (top), you can perform actions such as adding, editing, or deleting Label definitions. You have the flexibility to specify a label Name for use in selecting a labeling system (and optionally display it in each label instance). Moreover, you can input a label Description and optionally designate an object class for searching spots linked to objects of the chosen class where labels are to be positioned.

This is optional since alternatively, individual classes could be assigned to each detail separately, enabling labeling of objects from multiple classes within one labeling system.

On drawings where each object, e.g. space, has several spots linked and placed on different layers, one can choose a singular layer from which spots should be used for labeling, similarly to the Presentation Filters system. A set of flags can define the final graphical shape of the label - using the label name as a title for the label, using the field name as a description for each detail, utilizing separating grid lines or rectangular frame lines, and finally employing a background that can obscure the drawing beneath it to allow the label to be more readable.

Open

To accept values entered in the Label form when defining a new label or editing an existing one, use the Save button. Use the Close button to reject changes without saving.

Basic Label Options:

• Name: Any name that will optionally be used on top of each label box.

• Description: An internal description of the label, not visible to end users.

• Class: A specific object class that the label will be applied to.

• Layer: The preferred global layer that should be used for object spot selection. Please note that labels will not be part of this layer, but spots from this layer will be used to determine the 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 a background? A common color for all labels can be set in system settings.

Label Details

Each label can have multiple associated details (values) to be displayed within the label. Within the details grid (bottom), you can add, edit, or delete detail definitions.

Label Detail parameters:

• Name - This allows you to define the detail name, which can be used as a field name and optionally displayed in each label instance.

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

• Target field - This is used to specify the value to be displayed in the label detail. The target field needs to be chosen. In its simplest case, it will be one of the fields selected from metadata definition for an object of a chosen source class. However, a more advanced scenario is also possible where the displayed value is taken from an object of some other class that is linked to a source-class object along some perspective chain. To complete such scenarios, it's necessary to select applicable Perspective set and then choose desired Target class that can be reached from the source class along this perspective set. After these steps, a suitable Target Field needs to be selected among fields available for this class.

When defining new details or editing existing ones, use Save button to accept entered values in Detail form; use Close button instead if changes need to be rejected without saving them.

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, such as color, opacity, font size, and family can be defined in the Administration → System → System Settings under the Labels tab.

Administrators have the ability to set the style for label Frame (Frame style tab) and for the text within the Text tab.

Fill color defined in the Layer tab is only used when the Background flag is set. If you don't want to completely obscure the drawing beneath, make sure to use an appropriate opacity for the background. It's important to note that the suggested font size in the Text sub-tab is relative. The actual label size is dynamically calculated based on the average size of all spots to be labeled, ensuring it fits within them with a certain arbitrary percentage.

To achieve a larger or smaller effective label size, adjust the font size accordingly. The same scale used for determining the final actual font size also applies when defining relative line width. Alternatively, one can use a fixed line width to maintain consistency regardless of label and view scale.

Size and positioning of the labels

The size of the label should be based on the size of the element it is associated with. The font size should be relative to the average drawing element size.

For complex shapes, the position of the label may vary from one drawing to another. There could be minor variations in how labels are rendered in a view or preview compared to when they are printed.

Client Usage

When using the Document View window, you have the option to activate labels on drawings. In the Tools section of the Drawing Toolbar, look for the "Apply Dynamic Labels" button. Once this button is activated, a small form titled "Dynamic Labels" will appear. It includes a "Show Object Labels" check-button and a "Labels" combo box.

From the Labels combo box, users can choose which labeling system to activate in the Document View window.

A list of labeling systems defined in the Administration section is displayed. To activate one, simply select the desired option and wait a moment for it to load, calculate, and be displayed.

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

The layer with labels can be temporarily hidden to reveal obscured places in the drawing beneath the labels.

To hide the labels layer and momentarily reveal it back on, use the "Show Object Labels" check button on Dynamic Labels form.

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

Drawings with labels can be printed with the same content and appearance as presented in Document View. To deactivate the labeling system completely, choose the "None" item.

Using labels for visual filter

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

After activation, simple labels containing the filter name are displayed within each spot alongside the applied presentation filter.

This feature can be used as an additional illustrative tool to improve presentation readability and make it self-explanatory, particularly in cases where numerous values are available and colors might be difficult to distinguish.

HOPA usage

Two new parameters are introduced for HOPA.