@openremote/or-attribute-picker 1.8.0-snapshot.20250725070921 → 1.8.0-snapshot.20250725120000

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,31 +1,31 @@
1
- # @openremote/or-attribute-picker \<or-attribute-picker\>
2
- [![NPM Version][npm-image]][npm-url]
3
- [![Linux Build][travis-image]][travis-url]
4
- [![Test Coverage][coveralls-image]][coveralls-url]
5
-
6
- Web Component for displaying a dialog to select an attribute.
7
-
8
- ## Install
9
- ```bash
10
- npm i @openremote/or-attribute-picker
11
- yarn add @openremote/or-attribute-picker
12
- ```
13
-
14
- ## Usage
15
- For a full list of properties, methods and options refer to the TypeDoc generated [documentation]().
16
-
17
-
18
- ## Supported Browsers
19
- The last 2 versions of all modern browsers are supported, including Chrome, Safari, Opera, Firefox, Edge. In addition,
20
- Internet Explorer 11 is also supported.
21
-
22
-
23
- ## License
24
- [GNU AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
25
-
26
- [npm-image]: https://img.shields.io/npm/v/live-xxx.svg
27
- [npm-url]: https://npmjs.org/package/@openremote/or-attribute-picker
28
- [travis-image]: https://img.shields.io/travis/live-js/live-xxx/master.svg
29
- [travis-url]: https://travis-ci.org/live-js/live-xxx
30
- [coveralls-image]: https://img.shields.io/coveralls/live-js/live-xxx/master.svg
31
- [coveralls-url]: https://coveralls.io/r/live-js/live-xxx?branch=master
1
+ # @openremote/or-attribute-picker \<or-attribute-picker\>
2
+ [![NPM Version][npm-image]][npm-url]
3
+ [![Linux Build][travis-image]][travis-url]
4
+ [![Test Coverage][coveralls-image]][coveralls-url]
5
+
6
+ Web Component for displaying a dialog to select an attribute.
7
+
8
+ ## Install
9
+ ```bash
10
+ npm i @openremote/or-attribute-picker
11
+ yarn add @openremote/or-attribute-picker
12
+ ```
13
+
14
+ ## Usage
15
+ For a full list of properties, methods and options refer to the TypeDoc generated [documentation]().
16
+
17
+
18
+ ## Supported Browsers
19
+ The last 2 versions of all modern browsers are supported, including Chrome, Safari, Opera, Firefox, Edge. In addition,
20
+ Internet Explorer 11 is also supported.
21
+
22
+
23
+ ## License
24
+ [GNU AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
25
+
26
+ [npm-image]: https://img.shields.io/npm/v/live-xxx.svg
27
+ [npm-url]: https://npmjs.org/package/@openremote/or-attribute-picker
28
+ [travis-image]: https://img.shields.io/travis/live-js/live-xxx/master.svg
29
+ [travis-url]: https://travis-ci.org/live-js/live-xxx
30
+ [coveralls-image]: https://img.shields.io/coveralls/live-js/live-xxx/master.svg
31
+ [coveralls-url]: https://coveralls.io/r/live-js/live-xxx?branch=master
@@ -8,7 +8,7 @@
8
8
  "declarations": [
9
9
  {
10
10
  "kind": "class",
11
- "description": "Custom Event that is dispatched upon closing the dialog.\nContains a list of AttributeRef of the selected attributes.",
11
+ "description": "Custom Event that is dispatched upon closing the dialog.\r\nContains a list of AttributeRef of the selected attributes.",
12
12
  "name": "OrAssetAttributePickerPickedEvent",
13
13
  "members": [
14
14
  {
@@ -170,7 +170,7 @@
170
170
  }
171
171
  }
172
172
  ],
173
- "description": "Event callback function that is triggered once a user selects an asset.\nIt fetches the attributes of that specific asset, and caches these to be displayed later.\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set."
173
+ "description": "Event callback function that is triggered once a user selects an asset.\r\nIt fetches the attributes of that specific asset, and caches these to be displayed later.\r\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set."
174
174
  },
175
175
  {
176
176
  "kind": "method",
@@ -464,7 +464,7 @@
464
464
  "kind": "method",
465
465
  "name": "_updateDialogContent",
466
466
  "privacy": "protected",
467
- "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.",
467
+ "description": "Convenient function to update the dialog content manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
468
468
  "inheritedFrom": {
469
469
  "name": "AttributePicker",
470
470
  "module": "src/attribute-picker.ts"
@@ -474,7 +474,7 @@
474
474
  "kind": "method",
475
475
  "name": "_updateDialogActions",
476
476
  "privacy": "protected",
477
- "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.",
477
+ "description": "Convenient function to update the dialog actions manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
478
478
  "inheritedFrom": {
479
479
  "name": "AttributePicker",
480
480
  "module": "src/attribute-picker.ts"
@@ -523,7 +523,7 @@
523
523
  }
524
524
  }
525
525
  ],
526
- "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
526
+ "description": "Function that creates the HTML template for selecting attributes.\r\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
527
527
  "inheritedFrom": {
528
528
  "name": "AttributePicker",
529
529
  "module": "src/attribute-picker.ts"
@@ -642,7 +642,7 @@
642
642
  "declarations": [
643
643
  {
644
644
  "kind": "class",
645
- "description": "Custom Event that is dispatched upon closing the dialog.\nContains a map that is keyed by AssetDescriptor.name, with an array of AttributeDescriptors of the selected attributes.",
645
+ "description": "Custom Event that is dispatched upon closing the dialog.\r\nContains a map that is keyed by AssetDescriptor.name, with an array of AttributeDescriptors of the selected attributes.",
646
646
  "name": "OrAssetTypeAttributePickerPickedEvent",
647
647
  "members": [
648
648
  {
@@ -740,7 +740,7 @@
740
740
  "text": "AssetDescriptor[]"
741
741
  }
742
742
  },
743
- "description": "Function that will load and update the available asset types up for selection.\nAlso applies the filtering such as assetTypeFilter if set."
743
+ "description": "Function that will load and update the available asset types up for selection.\r\nAlso applies the filtering such as assetTypeFilter if set."
744
744
  },
745
745
  {
746
746
  "kind": "method",
@@ -759,7 +759,7 @@
759
759
  }
760
760
  }
761
761
  ],
762
- "description": "Function that will load and update the available attributes up for selection.\nThe descriptor parameter is usually the selected asset type.\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set."
762
+ "description": "Function that will load and update the available attributes up for selection.\r\nThe descriptor parameter is usually the selected asset type.\r\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set."
763
763
  },
764
764
  {
765
765
  "kind": "method",
@@ -848,7 +848,7 @@
848
848
  }
849
849
  }
850
850
  ],
851
- "description": "Function that maps the AssetDescriptors to the formatted ListItems.\nUses helpers like Util.getAssetTypeLabel and sorts by descriptorType so that agents show up first."
851
+ "description": "Function that maps the AssetDescriptors to the formatted ListItems.\r\nUses helpers like Util.getAssetTypeLabel and sorts by descriptorType so that agents show up first."
852
852
  },
853
853
  {
854
854
  "kind": "method",
@@ -1148,7 +1148,7 @@
1148
1148
  "kind": "method",
1149
1149
  "name": "_updateDialogContent",
1150
1150
  "privacy": "protected",
1151
- "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.",
1151
+ "description": "Convenient function to update the dialog content manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
1152
1152
  "inheritedFrom": {
1153
1153
  "name": "AttributePicker",
1154
1154
  "module": "src/attribute-picker.ts"
@@ -1158,7 +1158,7 @@
1158
1158
  "kind": "method",
1159
1159
  "name": "_updateDialogActions",
1160
1160
  "privacy": "protected",
1161
- "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.",
1161
+ "description": "Convenient function to update the dialog actions manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
1162
1162
  "inheritedFrom": {
1163
1163
  "name": "AttributePicker",
1164
1164
  "module": "src/attribute-picker.ts"
@@ -1207,7 +1207,7 @@
1207
1207
  }
1208
1208
  }
1209
1209
  ],
1210
- "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
1210
+ "description": "Function that creates the HTML template for selecting attributes.\r\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
1211
1211
  "inheritedFrom": {
1212
1212
  "name": "AttributePicker",
1213
1213
  "module": "src/attribute-picker.ts"
@@ -1624,13 +1624,13 @@
1624
1624
  "kind": "method",
1625
1625
  "name": "_updateDialogContent",
1626
1626
  "privacy": "protected",
1627
- "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog."
1627
+ "description": "Convenient function to update the dialog content manually,\r\nsince updating the UI is handled different for OrMwcDialog."
1628
1628
  },
1629
1629
  {
1630
1630
  "kind": "method",
1631
1631
  "name": "_updateDialogActions",
1632
1632
  "privacy": "protected",
1633
- "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog."
1633
+ "description": "Convenient function to update the dialog actions manually,\r\nsince updating the UI is handled different for OrMwcDialog."
1634
1634
  },
1635
1635
  {
1636
1636
  "kind": "method",
@@ -1675,7 +1675,7 @@
1675
1675
  }
1676
1676
  }
1677
1677
  ],
1678
- "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text."
1678
+ "description": "Function that creates the HTML template for selecting attributes.\r\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text."
1679
1679
  },
1680
1680
  {
1681
1681
  "kind": "method",
@@ -2009,7 +2009,7 @@
2009
2009
  }
2010
2010
  }
2011
2011
  ],
2012
- "description": "Event callback function that is triggered once a user selects an asset.\nIt fetches the attributes of that specific asset, and caches these to be displayed later.\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set.",
2012
+ "description": "Event callback function that is triggered once a user selects an asset.\r\nIt fetches the attributes of that specific asset, and caches these to be displayed later.\r\nAlso applies the filtering such as showOnlyDatapointAttrs, showOnlyRuleStateAttrs and attributeFilter if set.",
2013
2013
  "inheritedFrom": {
2014
2014
  "name": "OrAssetAttributePicker",
2015
2015
  "module": "src/asset-attribute-picker.ts"
@@ -2311,7 +2311,7 @@
2311
2311
  "kind": "method",
2312
2312
  "name": "_updateDialogContent",
2313
2313
  "privacy": "protected",
2314
- "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.",
2314
+ "description": "Convenient function to update the dialog content manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
2315
2315
  "inheritedFrom": {
2316
2316
  "name": "AttributePicker",
2317
2317
  "module": "src/attribute-picker.ts"
@@ -2321,7 +2321,7 @@
2321
2321
  "kind": "method",
2322
2322
  "name": "_updateDialogActions",
2323
2323
  "privacy": "protected",
2324
- "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.",
2324
+ "description": "Convenient function to update the dialog actions manually,\r\nsince updating the UI is handled different for OrMwcDialog.",
2325
2325
  "inheritedFrom": {
2326
2326
  "name": "AttributePicker",
2327
2327
  "module": "src/attribute-picker.ts"
@@ -2370,7 +2370,7 @@
2370
2370
  }
2371
2371
  }
2372
2372
  ],
2373
- "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
2373
+ "description": "Function that creates the HTML template for selecting attributes.\r\nCurrently uses OrMwcList with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.",
2374
2374
  "inheritedFrom": {
2375
2375
  "name": "AttributePicker",
2376
2376
  "module": "src/attribute-picker.ts"