Location Details

Displays the properties of a location in a details box.

Location Details

Template Syntax

Below you can find some examples of how to use the component within a template.


<location-details-widget title="Location Info">
    <property name="name"></property>
    <property name="properties.address"></property>

    <property.....></property>
</location-details-widget>

Component Reference

Here is a comprehensive list of all the elements and properties that can be used to configure the component.

Location Details <location-details-widget>
PROPERTIES
Collapse / Expand	The flag indicating whether the widget is collaspible. Type: BOOLEAN \| Optional \| Values: true false [collapsible]="true"
Column Span	The number of columns the widget must span its sub-elements (default 1). Type: INTEGER \| Optional [columns]="2"
CSS Class	The name(s) of the CSS class used to customize the widget layout. Type: STRING \| Optional class="my-custom-class"
Layout	The layout used to display properties in the widget: TABLE: Displays one column for the label and another for the property value. ALTERNATE_ROWS: Displays a gray row for the label and a white row for the property value. Type: ENUM \| Optional \| Values: TABLE ALTERNATE_ROWS layout="ALTERNATE_ROWS"
Title	The title displayed on the top part of the widget box. Type: STRING \| Optional [title]="'Details'"
Visibility Condition	The expression that allows you to reduce the visibility of the element. Type: STRING \| Optional *ngIf="getUser().organizationId != null"
SUB-ELEMENTS
Property	The property whose label and current value must be rendered as a widget row. Multiple \| Optional <property name="serialNumber"></property>
Metric	The location metric whose label and current value must be rendered as a widget row. Multiple \| Optional <metric name="Temperature"></metric>
Composite Part	The widget part combining multiple properties. Multiple \| Optional <composite-part> <metric name="Temperature"></metric> <metric name="Humidity"></metric> <property name="properties.type"></property> </composite-part>
Widget Title	Compose the widget title by using properties. Single \| Optional <widget-title> <property name="name"></property> <property name="connectionStatus" filter="connectionStatus"></property> </widget-title>

Property <property>
PROPERTIES
Description	The property description. Type: STRING \| Optional description="fooBar"
Filter	The name of the filter used to transform and display values. Type: FILTER \| Multiple value \| Optional filter="fooBarFilter"
Label	The property alternative label. Type: STRING \| Optional label="Temperature"
Name	The property whose value must be loaded by the widget. Type: PROPERTY \| Required name="serialNumber"
Show Label	The flag indicated whether the label is visible. Type: BOOLEAN \| Optional \| Values: true false [showLabel]="true"
Visibility Condition	The expression that allows you to reduce the visibility of the element. Type: STRING \| Optional *ngIf="getUser().organizationId != null"

Metric <metric>
PROPERTIES
Aggregation	The aggregation to apply on the retrieved value. Type: ENUM \| Optional \| Values: MIN MIN_HOURS_1 MIN_DAYS_1 MIN_MONTHS_1 MAX MAX_HOURS_1 MAX_DAYS_1 MAX_MONTHS_1 AVG AVG_HOURS_1 AVG_DAYS_1 AVG_MONTHS_1 DELTA DELTA_HOURS_1 DELTA_DAYS_1 DELTA_MONTHS_1 aggregation="MAX"
Filter	The name of the filter used to transform and display values. Type: FILTER \| Multiple value \| Optional filter="fooBarFilter"
Label	The metric alternative label. Type: STRING \| Optional label="Temperature"
Name	The metric whose value(s) must be loaded by the widget. Type: METRIC \| Required name="Temperature"
Quick History	The flag enabling the quick history popup used to access the metric historical data. Type: BOOLEAN \| Optional \| Values: true false [quickHistory]="true"
Resettable	The flag enabling the reset button. The reset is enabled only for counters and algorithms metrics, moreover, the user must have the WRITE_METRIC_VALUE permission. Type: BOOLEAN \| Optional \| Values: true false [resettable]="true"
Show Label	The flag indicated whether the label is visible. Type: BOOLEAN \| Optional \| Values: true false [showLabel]="true"
Unit	The unit of measurement to be displayed along the value. Type: STRING \| Optional unit="°C"
Visibility Condition	The expression that allows you to reduce the visibility of the element. Type: STRING \| Optional *ngIf="getUser().organizationId != null"

Composite Part <composite-part>

PROPERTIES

Description

The composite-part description.
Type: STRING | Optional
description="fooBar"

Filter

The filter applied on the composite-part to transform or display its value.
Type: FILTER | Optional
filter="fooBarFilter"

Label

The label displayed by the widget.
Type: STRING | Optional
label="fooBar"

Name

The composite-part name.
Type: STRING | Optional
name="fooBar"

Show Label

The flag indicated whether the label is visible.
Type: BOOLEAN | Optional | Values:

true

false

[showLabel]="true"

Visibility Condition

The expression that allows you to reduce the visibility of the element.
Type: STRING | Optional
*ngIf="getUser().organizationId != null"

SUB-ELEMENTS

Metric

The metric whose value must be loaded within the composite-part.
Multiple | Optional

<metric name="Temperature"></metric>

PROPERTIES
Name	The metric whose value(s) must be loaded by the widget. Type: METRIC \| Required name="Temperature"

Property

The property whose value must be loaded within the composite-part.
Multiple | Optional

<property name="serialNumber"></property>

PROPERTIES
Name	The property whose value must be loaded by the widget. Type: PROPERTY \| Required name="serialNumber"