HotSpotting summarizes a general technique in {{UBIK}}, that allows to overlay data on the visual representation of other {{UBIK}} objects. The overlaid data can be of quite a variety, starting from Annotations Annotation (also known as Redlining redlining or Inkinginking) over Links/Cross-references between objects, to {{UBIK}} Properties in all their different is a type of visual marking on documents. It is currently possible types on PDF and appearancesimage documents with the [[SYSCLS_ANNOTATION|annotation classificatioin]]. While HotSpotting is an abstract approach that could be applied to any kind The typical types of {{UBIK}} objectdifferent annotations include inking, the client currently only supports displaying free text, text markup and interacting with HotSpots on Document objectsshape.
==Overview==HotSpotting consists of 3 main elementssummarizes a general technique in {{UBIK}}, that allows to overlay data on the Targetvisual representation of other {{UBIK}} objects. The overlaid data can be of quite a variety, the Layerstarting from annotations (salso known as Redlining or Inking) over Links/Cross-references between objects, to {{UBIK}} Properties in all their different possible types and appearances. While HotSpotting is an abstract approach that could be applied to any kind of {{UBIK}} object, the client currently only supports displaying and interacting with HotSpots:on PDF document objects.
===Target=Annotations==A HotSpotting target can be basically any {{UBIK}} object that holds All annotations overlay on top of the classification documents. Technically speaking, they are separately stored in dedicated [[SYSCLS HOTSPOTSYSCLS_ANNOTATION|HotSpotting targetANNOTATIONS]]properties. In most of When an annotation is created, the use cases, this target will be [[FILEDOCUMENT|file document]] or a derivative of that classcurrent user is remembered as the owner who is allowed to edit it afterwards.
===LayerMerge/Flatten===A layer Annotations on a document can be envisioned as a transparent film merged/flattened/burnt in. After that is overlaid on , the target and contains annotations become a part of the actual HotSpots. Technically their document file and can be viewed in applications other than {{UBIK}} as many layers as desiredwell. However, overlaying each othersyou also lose the possibility to edit or interact with them.A layer covers the whole physical area of its target* For image documents, i.eit is only possible to merge annotations on the clients and it is the default behavior. But you can turn it off through the dimensions of [[XAML#UBIKImageEditor|MergeAnnotationsOnSave (XAML)]] configuration.* For PDF documents, it is only possible to merge annotations on the page of a documentserver.
===HotSpot/Annotation===A HotSpot is a single data object that sits on a layer and typically has a visual representation, such as the value of a property it represents{{Hint|Since server 3. 7.0 Build 15424 free text annotations support Chinese characters when flattening them into pdf.}}
Since 3===Known issues=== ====Can not select free texts and text markups on UWP====On the UWP/WinX client, there is currently an issue with the PDF control we use which causes the the user information to be lost on free text and text markup annotations during saving.7* Because of that, you can't select/edit such annotations once they are saved.0 Build 15424 Freetext Annotations support Chinese characters * Unfortunately, this also affects already existing annotations of such types. To clarify, simply viewing the annotations will not cause the lost of the user information. It happens as soon as you save all annotations (after either editing/deleting existing ones or adding new ones).We will be in contact with our PDF control provider and try to find a fix for it. ====Can not select older annotations on Xamarin===={{Version/XamarinSince|4.9}} We changed the way we uniquely identify annotations on the Xamarin client, in order to avoid using slightly different colors for ink annotations, which proved to be problematic when flattening you have many annotations of the same chosen color. This means, if you use the new Xamarin client to view annotations created on older clients, you will not be able to select or edit them into pdf.
==HotSpots==
All HotSpots have in common that they know
* on which layer they sit
A scan spot is a HotSpot that scans the area it covers using OCR. So when the user moves it around a document or resizes it, it will write the recognized OCR text to its value.
==Annotations==An Annotation is a collection of Ink strokes that sits on a layer and typically represents redlining or additional information to a document, like a diagram or a photo.{{UnderConstructionStart}}
HotSpotting consists of 3 main elements, the Target, the Layer(s) and the HotSpots:
----===Target===A HotSpotting target can be basically any {{UBIK}} object that holds the classification [[SYSCLS HOTSPOT|HotSpotting target]]. In most of the use cases, this target will be [[FILEDOCUMENT|file document]] or a derivative of that class.
===Layer===
A layer can be envisioned as a transparent film that is overlaid on the target and contains the actual HotSpots. Technically their can be as many layers as desired, overlaying each others.
A layer covers the whole physical area of its target, i.e. the dimensions of the page of a document.
===HotSpots===
A HotSpot is a single data object that sits on a layer and typically has a visual representation, such as the value of a property it represents.
==How to enable Hotspotting in the UI==
</source>
{{UnderConstructionEnd}}
==See also==
* [[SYSCLS HOTSPOT]]
* [[HotSpotting (Plugin)]]
[[Category:Client|Annotation and HotSpot]]
[[Category:WinX|Annotation and HotSpot]]
[[Category:Xamarin|Annotation and HotSpot]]
