Customer List

  • 3 minute(s) read

Displays the list of customers visible by the current user and navigation context.

Customer List

Template Syntax

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


<customer-list-widget-v2>
    <property [name]="'name'"></property>
    <property [name]="'country'"></property>
    <property [name]="'properties.thingCount'"></property>
</customer-list-widget-v2>

Component Reference

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

Customer List <customer-list-widget-v2>

Actions Enabled

The boolean flag indicating whether actions (e.g. Add button) are enabled on the widget.

Type: BOOLEAN | Optional

Default Value: true

[enableActions]="false"

Block Column Span

The number of columns on which to span the properties displayed in each list block (default 1).

Type: INTEGER | Optional

Default Value: 1

blockColumns="2"

Bulk Controls Enabled

The boolean flag indicating whether bulk selection and buttons (e.g. Tagging, Firmware Update) are enabled on the widget.

Type: BOOLEAN | Optional

Default Value: false

[bulkControlsEnabled]="true"

Controls Enabled

The boolean flag indicating whether controls (e.g. Search, Export) are enabled on the widget.

Type: BOOLEAN | Optional

Default Value: true

[controlsEnabled]="false"

Details Path

The path to navigate when a row is clicked.

Type: STRING | Optional

detailsPath="customer-productivity"

Empty Message

The blank message to be displayed in the widget in case no item was found. To manage translations, you can define a label and use the key as the value of the property.

Type: STRING | Optional

emptyMessage="No customer found"

Initial Sorting

The array of property names and criteria to use for sorting (e.g. ['name','asc','serialNumber','desc']).

Type: SORT_PROPERTIES | Optional

[sort]="['name','asc','serialNumber','desc']"

Page Size

The number of items to load on each page.

Type: INTEGER | Optional

Default Value: 50

pageSize="100"

Query

The array of conditions filtering out items. For instance: [query]='[{'property': 'connectionStatus', 'predicate': 'eq', 'value': '1'}]'  Predicates: eq, beginsWith, like, notLike, isEmpty, isNotEmpty, gt, gte, lt, lte.

Type: QUERY | Optional

Predicates: beginsWith, eq, neq, gt, gte, isEmpty, isNotEmpty, lt, lte, like, notLike

[query]="[{property:'prop1', predicate: 'eq', value: 'foo'}, {property:'prop2', predicate: 'in', value: ['bar', 'baz']}]"

Query Variable

The id of the page's <things-filter-field> used for searching.

Type: STRING | Optional

queryFieldRef="query-1"

Search Fields

The array of fields used to filter out the objects when searching by a generic key. For instance: [searchFields]='['name', 'serialNumber', 'customer.name', 'customer.code']'

Type: PROPERTY (multiple) | Optional

[searchFields]="['property1', 'property2']"

Title

The title displayed on the top part of the widget box.

Type: STRING | Optional

[title]="'Details'"

Rendering

CSS Class

The name(s) of the CSS class used to customize the widget layout.

Type: STRING | Optional

class="my-custom-class"

Advanced

Id

The id of the widget.

Type: STRING | Optional

id="abc"

Sub Elements

Property

The property whose label and current value must be rendered as a widget row.

Composite Part

The widget part combining multiple properties.

Property <property>

Description

The property description.

Type: STRING | Optional

description="abc"

Filter

The name of the filter used to transform and display values.

Type: FILTER | 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"

Advanced

Column CSS Class

The name(s) of the column CSS class used to customize the table column.

Type: COLUMN_CSS | Optional

columnClass="my-column-custom-class"

Display Mode

The way the column is displayed.

Type: ENUM | Optional

Values: VISIBLE, INITIALLY_HIDDEN, ALWAYS_HIDDEN

Default Value: VISIBLE

displayMode="VISIBLE"

Include in Export

The boolean flag indicating whether the property value should be included in the export even when not visible within the page.

Type: BOOLEAN | Optional

Default Value: false

[includeInExport]="true"

Show Header

The flag indicated whether the header is visible.

Type: BOOLEAN | Optional

Default Value: true

[showHeader]="false"

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>

Description

The composite-part description.

Type: STRING | Optional

description="abc"

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="abc"

Name

The composite-part name.

Type: STRING | Optional

name="abc"

Sorting Criteria

The comma seprated list of property names and criteria to use for sorting the list column associated to this composite-part (e.g. properties.p1,ASC,properties.p2,DESC).

Type: STRING | Optional

sortingCriteria="properties.p1,ASC,properties.p2,DESC"

Advanced

Column CSS Class

The name(s) of the column CSS class used to customize the table column.

Type: COLUMN_CSS | Optional

columnClass="my-column-custom-class"

Display Mode

The way the column is displayed.

Type: ENUM | Optional

Values: VISIBLE, INITIALLY_HIDDEN, ALWAYS_HIDDEN

Default Value: VISIBLE

displayMode="VISIBLE"

Show Header

The flag indicated whether the header is visible.

Type: BOOLEAN | Optional

Default Value: true

[showHeader]="false"

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 value must be loaded within the composite-part.

Property <property>

Name

The property whose value must be loaded by the widget.

Type: PROPERTY | Required

name="serialNumber"