Status | ||||
---|---|---|---|---|
|
Table of Contents |
---|
...
Introduction
Dynamic labels can be automatically generated on the drawing to display object metadata, similar to macros but placed automatically for every object that is represented on the drawing.
Labels These labels can be shaped customized according to user needs - preferences – from simple, single text value values to more complex table tables with labels and headerheaders.
Data The data within the label can be fetched retrieved directly form from a selected object or from other objects based on data perspectives, e.g. such as those from upper floor floors or rental unitunits.
Labels are defined in a similar way manner as visual, color-based presentations and follow similar 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.
...
From the Labels grid (top), one can add, edit or delete Label definition. You can define label Name to be used when choosing 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 displayed display it in each label instance),. Moreover, you can input a label Description and declare optionally designate an object class to be used when for searching for spots linked to objects of the chosen class where labels are to be placedpositioned.
This is optional because since alternatively, individual classes could be assigned to each detail separately, allowing enabling labeling of objects of from 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 a singular layer from where which spots should be used for labeling, similarly as in to the Presentation Filters system.
Set A set of flags can define the final graphical shape of the label - using of the label name as a title for the label, using of the field name as a description of for each detail, using utilizing separating grid lines or rectangular frame lines, and finally usage of employing a background that can obscure the drawing beneath allowing it to allow the label to be more readable.
...
To accept values entered in the Label form when defining a new label or editing an existing labelone, use the Save button; use . Use the Close button instead to reject changes without saving.
Basic Label optionsOptions:
Name
- any: 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.
Note: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 descriptionStyle Options Description:
Label
...
Name: Should the label name be displayed or not?
Frame Lines
...
: Should the outer lines (frame) of the label be displayed?
Field
...
Name: Should field names be displayed?
Grid
...
Lines: Should the inner grid lines be displayed?
Background
...
: Should the label use a background
...
? A common color for all labels can be set in system settings.
...
...
Label Details
Each Label label can have several multiple associated Details details (values) to be displayed within the Label. From Details label. Within the details grid (bottom), one you can add, edit, or delete Detail definitiondetail definitions.
...
Label Detail parameters:
Name -
You can defineThis allows you to define the detail name
to, which can be used as a field name and optionally displayed in each label instance.
Source class - This refers to the class of objects
to beused when searching for spots where labels are
to beplaced. If the source class is defined in the parent label, it becomes
athe default one for each detail.
However,
oneindividual source classes can be freely
define individual source classdefined for each detail,
allowingenabling 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 isThis is used to specify the value to be displayed in the label detail
, Target Field has. The target field needs to be chosen. In its simplest case, it will be one of the fields
chosenselected from metadata definition for an object of a chosen
Sourcesource class.
However,
it is possible to usea more advanced scenario
, whenis also possible where the displayed value is
to betaken from an object of some other class that is linked to a source-class object along some perspective chain.
To complete such
scenarioscenarios, it
is's necessary to select applicable Perspective set and then choose desired Target class that can be reached from the source class along
itthis perspective set.
After
suchthese steps, a suitable Target Field
isneeds to be
chosenselected among fields available for this class.
To accept values entered in Detail form when When defining new details or editing existing detailones, use Save button to accept entered values in Detail form; use Close button instead to reject changes 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.
...
Note |
---|
If Labels are to show metadata from parent objects then configuration of Perspectives Set used for Dynamic Labels should contain reverse links logic. Example below: |
Label Style
Graphical details regarding , such as color, opacity and , font size, and family one can define in Administration → System → System Settings on can be defined in the Administration → System → System Settings under the Labels tab.
Administrator can set Administrators have the ability to set the style for label Frame (Frame style tab) and for the text - in within the Text tab.
Note |
---|
Recommended text style should have a very thin stroke line, e.g. 1 pixel or less. Alternatively, the opacity for text stroke should be set to zero, unless specifically other specific values are needed. Using a thick stroke line for text might produce unappealing results and render the font unreadable. |
Fill color defined in the Layer tab is of use only used when the Background 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 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 has only is relative meaning. Actual The actual label size of label is calculated dynamically taking into account medium dynamically calculated based on the average size of all spots to be labeled, so as to fit inside ensuring it fits within them with some a certain arbitrary percentage. One can obtain greater
To achieve a larger or smaller effective size of labels using greater or smaller label size, adjust the font size accordingly. The same scale used to generate for determining the final actual font size is used also applies when defining relative line width; alternatively. Alternatively, one can use a fixed line width to have it constant independently on maintain consistency regardless of label and view scale.
...
Size and positioning of the labels
Label size must be determined based on element size that it is bound toThe size of the label should be based on the size of the element it is associated with. The font size is should be relative to the average drawing element size.
Position For complex shapes, the position of the label for complex shapes might differ from may vary from one drawing to drawinganother. There might be some small differences between rendering of labels in view/preview as compared to printoutcould be minor variations in how labels are rendered in a view or preview compared to when they are printed.
Client Usage
In When using the Document View window, it is possible you have the option to activate labels on drawingdrawings.
In the Tools section of the Drawing Toolbar, there is an look for the "Apply Dynamic Labels" button. After activating Once this button is activated, a small form titled "Dynamic Labels with " will appear. It includes a "Show Object Labels" check-button and a "Labels" combo box is displayed:.
...
From the Labels combo box, user users can choose which labeling system is to be activated activate in the Document View window.
List A list of labeling systems defined in the Administration part section is displayed. To activate itone, simply select the desired one option and wait a moment until it will be loaded, calculated and 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.
Layer The layer with labels can be temporarily hidden to reveal obscured places in the drawing beneath the labels.
Use To hide the labels layer and momentarily reveal it back on, use the "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 the need to activate it on each drawing separately.
Drawing Drawings with labels can be printed with the same content and appearance as presented in Document View. To switch off deactivate the labeling system at allcompletely, 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 activating itactivation, simple labels containing the filter name are displayed inside within each spot together with alongside the applied presentation filter applied.
It may This feature can be used as an additional illustrative tool to enhance improve presentation readability and made make it self-explanatory, especially where there are a lot of values particularly in cases where numerous values are available and colors might be hard difficult to distinguish.
HOPA usage
Two new parameters are introduced for HOPA.
Parameter | Abbr. | Required | Default value | Description | viewport suffix? |
labelingId | LID | - | - | Applies Dynamic Label to the printout. Only one ID can be given. | - |
showPresentationLabels | SPL | - | 0 | Requires PresentationID given in call. When SPL=1 then labels of tools will added to a drawing hovering overs appropriate spots. | - |