{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/asset-attribute-picker.ts", "declarations": [ { "kind": "class", "description": "Custom Event that is dispatched upon closing the dialog.\nContains a list of AttributeRef of the selected attributes.", "name": "OrAssetAttributePickerPickedEvent", "members": [ { "kind": "field", "name": "NAME", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "\"or-asset-attribute-picker-picked\"" } ], "superclass": { "name": "AttributePickerPickedEvent", "module": "/src/attribute-picker" } }, { "kind": "class", "description": "The \"Attribute Picker\" component using the OrAssetTree component for selecting assets and its attributes.", "name": "OrAssetAttributePicker", "members": [ { "kind": "field", "name": "attributeFilter", "type": { "text": "(attribute: Attribute) => boolean | undefined" }, "privacy": "public", "attribute": "attributeFilter" }, { "kind": "field", "name": "_assetAttributes", "type": { "text": "Attribute[] | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "selectedAssets", "type": { "text": "string[]" }, "privacy": "public", "default": "[]" }, { "kind": "field", "name": "selectedAttributes", "type": { "text": "AttributeRef[]" }, "privacy": "public", "default": "[]" }, { "kind": "field", "name": "_asset", "type": { "text": "Asset | undefined" }, "privacy": "protected" }, { "kind": "method", "name": "setAttributeFilter", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "attributeFilter", "type": { "text": "((attribute: Attribute) => boolean) | undefined" } } ], "type": { "text": "setAttributeFilter(attributeFilter: ((attribute: Attribute) => boolean) | undefined) => this" } }, { "kind": "method", "name": "setSelectedAssets", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "selectedAssets", "type": { "text": "string[]" } } ], "type": { "text": "setSelectedAssets(selectedAssets: string[]) => this" } }, { "kind": "method", "name": "setSelectedAttributes", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "selectedAttributes", "type": { "text": "AttributeRef[]" } } ], "type": { "text": "setSelectedAttributes(selectedAttributes: AttributeRef[]) => this" } }, { "kind": "method", "name": "_setDialogActions", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_setDialogContent", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_onAssetSelectionChanged", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "OrAssetTreeSelectionEvent" } } ], "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." }, { "kind": "method", "name": "_onAttributesSelect", "privacy": "protected", "parameters": [ { "name": "attrNames", "type": { "text": "string[]" } } ], "description": "HTML Callback function when the selected attributes have been updated." }, { "kind": "field", "name": "multiSelect", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "addBtn", "type": { "text": "OrVaadinButton" }, "privacy": "protected", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "setShowOnlyDatapointAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyDatapointAttrs(showOnlyDatapointAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowOnlyRuleStateAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyRuleStateAttrs(showOnlyRuleStateAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowPredictedDataAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowPredictedDataAttrs(showPredictedDataAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setMultiSelect", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "multiSelect", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setMultiSelect(multiSelect: boolean | undefined) => this" } }, { "kind": "method", "name": "setOpen", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "isOpen", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setOpen(isOpen: boolean) => this" } }, { "kind": "method", "name": "setHeading", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "heading", "type": { "text": "TemplateResult | string | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setHeading(heading: TemplateResult | string | undefined) => this" } }, { "kind": "method", "name": "setContent", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_content", "type": { "text": "TemplateResult | (() => TemplateResult) | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setContent(_content: TemplateResult | (() => TemplateResult) | undefined) => this" } }, { "kind": "method", "name": "setActions", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_actions", "type": { "text": "DialogAction[] | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setActions(_actions: DialogAction[] | undefined) => this" } }, { "kind": "method", "name": "setDismissAction", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_action", "type": { "text": "DialogActionBase | null | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setDismissAction(_action: DialogActionBase | null | undefined) => this" } }, { "kind": "method", "name": "setStyles", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_styles", "type": { "text": "string | TemplateResult | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setStyles(_styles: string | TemplateResult | undefined) => this" } }, { "kind": "method", "name": "setAvatar", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_avatar", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setAvatar(_avatar: boolean | undefined) => this" } }, { "kind": "method", "name": "_updateDialogContent", "privacy": "protected", "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_updateDialogActions", "privacy": "protected", "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getAttributesTemplate", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "attributes", "optional": true, "type": { "text": "Attribute[]" } }, { "name": "descriptors", "optional": true, "type": { "text": "AttributeDescriptor[]" } }, { "name": "selectedNames", "optional": true, "type": { "text": "string[]" } }, { "name": "multi", "default": "false" }, { "name": "onSelect", "optional": true, "type": { "text": "(attrNames: string[]) => void" } } ], "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrVaadinListBox with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getStyles", "privacy": "protected", "return": { "type": { "text": "string" } }, "description": "Simple function that creates the CSS styles for this component", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "events": [ { "type": { "text": "OrAssetAttributePickerPickedEvent" } } ], "attributes": [ { "type": { "text": "(attribute: Attribute) => boolean | undefined" }, "description": "Callback method for consumers to filter the attribute list shown. Returning true will make the attribute visible, returning false hides it.", "name": "attributeFilter", "fieldName": "attributeFilter" }, { "type": { "text": "boolean | undefined" }, "description": "Whether selecting multiple attributes is allowed or not.", "name": "multiSelect", "default": "false", "fieldName": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'STORE_DATAPOINT' meta item should be shown.", "name": "showOnlyDatapointAttrs", "default": "false", "fieldName": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'RULE_STATE' meta item should be shown.", "name": "showOnlyRuleStateAttrs", "default": "false", "fieldName": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether attributes with the 'HAS_PREDICTED_DATA_POINTS' meta item should be shown. Composes additively with the other flags.", "name": "showPredictedDataAttrs", "default": "false", "fieldName": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "superclass": { "name": "AttributePicker", "module": "/src/attribute-picker" }, "tagName": "or-asset-attribute-picker", "customElement": true, "modulePath": "src/asset-attribute-picker.ts", "definitionPath": "src/asset-attribute-picker.ts" } ], "exports": [ { "kind": "js", "name": "OrAssetAttributePickerPickedEvent", "declaration": { "name": "OrAssetAttributePickerPickedEvent", "module": "src/asset-attribute-picker.ts" } }, { "kind": "js", "name": "OrAssetAttributePicker", "declaration": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "custom-element-definition", "name": "or-asset-attribute-picker", "declaration": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/assettype-attribute-picker.ts", "declarations": [ { "kind": "class", "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.", "name": "OrAssetTypeAttributePickerPickedEvent", "members": [ { "kind": "field", "name": "NAME", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "\"or-asset-type-attribute-picker-picked\"" } ], "superclass": { "name": "AttributePickerPickedEvent", "module": "/src/attribute-picker" } }, { "kind": "class", "description": "The \"Attribute Picker\" component using the OrAssetTree component for selecting assets and its attributes.", "name": "OrAssetTypeAttributePicker", "members": [ { "kind": "field", "name": "assetTypeFilter", "type": { "text": "(descriptor: AssetDescriptor) => boolean | undefined" }, "privacy": "public", "attribute": "assetTypeFilter" }, { "kind": "field", "name": "attributeFilter", "type": { "text": "(descriptor: AttributeDescriptor) => boolean | undefined" }, "privacy": "public", "attribute": "attributeFilter" }, { "kind": "field", "name": "selectedAttributes", "type": { "text": "Map" }, "privacy": "public", "default": "new Map()" }, { "kind": "field", "name": "_selectedAssetType", "type": { "text": "string | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "_loadedAttributeTypes", "type": { "text": "AttributeDescriptor[] | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "_loadedAssetTypes", "type": { "text": "AssetDescriptor[] | undefined" }, "privacy": "protected" }, { "kind": "method", "name": "setSelectedAttributes", "privacy": "public", "parameters": [ { "name": "selectedAttributes", "type": { "text": "Map" } } ], "type": { "text": "setSelectedAttributes(selectedAttributes: Map) => void" } }, { "kind": "method", "name": "_loadAssetTypes", "privacy": "protected", "return": { "type": { "text": "AssetDescriptor[]" } }, "description": "Function that will load and update the available asset types up for selection.\nAlso applies the filtering such as assetTypeFilter if set." }, { "kind": "method", "name": "_loadAttributeTypes", "privacy": "protected", "return": { "type": { "text": "AttributeDescriptor[]" } }, "parameters": [ { "name": "descriptor", "type": { "text": "AssetDescriptor" } } ], "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." }, { "kind": "method", "name": "_setDialogContent", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_setDialogActions", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_onAssetTypeItemClick", "privacy": "protected", "parameters": [ { "name": "listItem", "type": { "text": "ListItem" } } ], "description": "HTML Callback function when the selected asset type has been updated." }, { "kind": "method", "name": "_onAttributesSelect", "privacy": "protected", "parameters": [ { "name": "attrNames", "type": { "text": "string[]" } } ], "description": "HTML callback function when the selected attributes have been updated." }, { "kind": "method", "name": "_getAssetTypeDescriptors", "privacy": "protected", "return": { "type": { "text": "ListItem[]" } }, "parameters": [ { "name": "descriptors", "type": { "text": "AssetDescriptor[]" } }, { "name": "selected", "optional": true, "type": { "text": "AssetDescriptor[]" } }, { "name": "withNoneValue", "optional": true, "type": { "text": "ListItem" } } ], "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." }, { "kind": "method", "name": "_getAssetDescriptorByName", "privacy": "protected", "return": { "type": { "text": "AssetDescriptor | undefined" } }, "parameters": [ { "name": "name", "optional": true, "type": { "text": "string" } } ], "description": "Utility method to get the cached AssetDescriptor by its name" }, { "kind": "field", "name": "multiSelect", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "addBtn", "type": { "text": "OrVaadinButton" }, "privacy": "protected", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "setShowOnlyDatapointAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyDatapointAttrs(showOnlyDatapointAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowOnlyRuleStateAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyRuleStateAttrs(showOnlyRuleStateAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowPredictedDataAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowPredictedDataAttrs(showPredictedDataAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setMultiSelect", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "multiSelect", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setMultiSelect(multiSelect: boolean | undefined) => this" } }, { "kind": "method", "name": "setOpen", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "isOpen", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setOpen(isOpen: boolean) => this" } }, { "kind": "method", "name": "setHeading", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "heading", "type": { "text": "TemplateResult | string | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setHeading(heading: TemplateResult | string | undefined) => this" } }, { "kind": "method", "name": "setContent", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_content", "type": { "text": "TemplateResult | (() => TemplateResult) | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setContent(_content: TemplateResult | (() => TemplateResult) | undefined) => this" } }, { "kind": "method", "name": "setActions", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_actions", "type": { "text": "DialogAction[] | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setActions(_actions: DialogAction[] | undefined) => this" } }, { "kind": "method", "name": "setDismissAction", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_action", "type": { "text": "DialogActionBase | null | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setDismissAction(_action: DialogActionBase | null | undefined) => this" } }, { "kind": "method", "name": "setStyles", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_styles", "type": { "text": "string | TemplateResult | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setStyles(_styles: string | TemplateResult | undefined) => this" } }, { "kind": "method", "name": "setAvatar", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_avatar", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setAvatar(_avatar: boolean | undefined) => this" } }, { "kind": "method", "name": "_updateDialogContent", "privacy": "protected", "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_updateDialogActions", "privacy": "protected", "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getAttributesTemplate", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "attributes", "optional": true, "type": { "text": "Attribute[]" } }, { "name": "descriptors", "optional": true, "type": { "text": "AttributeDescriptor[]" } }, { "name": "selectedNames", "optional": true, "type": { "text": "string[]" } }, { "name": "multi", "default": "false" }, { "name": "onSelect", "optional": true, "type": { "text": "(attrNames: string[]) => void" } } ], "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrVaadinListBox with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getStyles", "privacy": "protected", "return": { "type": { "text": "string" } }, "description": "Simple function that creates the CSS styles for this component", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "events": [ { "type": { "text": "OrAssetTypeAttributePickerPickedEvent" } } ], "attributes": [ { "type": { "text": "(descriptor: AssetDescriptor) => boolean | undefined" }, "description": "-Callback method for consumers to filter the asset type list shown. Returning true will make the asset type visible, returning false hides it.", "name": "assetTypeFilter", "fieldName": "assetTypeFilter" }, { "type": { "text": "(descriptor: AttributeDescriptor) => boolean | undefined" }, "description": "Callback method for consumers to filter the attribute list shown. Returning true will make the attribute visible, returning false hides it.", "name": "attributeFilter", "fieldName": "attributeFilter" }, { "type": { "text": "boolean | undefined" }, "description": "Whether selecting multiple attributes is allowed or not.", "name": "multiSelect", "default": "false", "fieldName": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'STORE_DATAPOINT' meta item should be shown.", "name": "showOnlyDatapointAttrs", "default": "false", "fieldName": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'RULE_STATE' meta item should be shown.", "name": "showOnlyRuleStateAttrs", "default": "false", "fieldName": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether attributes with the 'HAS_PREDICTED_DATA_POINTS' meta item should be shown. Composes additively with the other flags.", "name": "showPredictedDataAttrs", "default": "false", "fieldName": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "superclass": { "name": "AttributePicker", "module": "/src/attribute-picker" }, "tagName": "or-assettype-attribute-picker", "customElement": true, "modulePath": "src/assettype-attribute-picker.ts", "definitionPath": "src/assettype-attribute-picker.ts" } ], "exports": [ { "kind": "js", "name": "OrAssetTypeAttributePickerPickedEvent", "declaration": { "name": "OrAssetTypeAttributePickerPickedEvent", "module": "src/assettype-attribute-picker.ts" } }, { "kind": "js", "name": "OrAssetTypeAttributePicker", "declaration": { "name": "OrAssetTypeAttributePicker", "module": "src/assettype-attribute-picker.ts" } }, { "kind": "custom-element-definition", "name": "or-assettype-attribute-picker", "declaration": { "name": "OrAssetTypeAttributePicker", "module": "src/assettype-attribute-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/attribute-picker.ts", "declarations": [ { "kind": "class", "description": "", "name": "AttributePickerPickedEvent", "superclass": { "name": "CustomEvent", "module": "src/attribute-picker.ts" } }, { "kind": "class", "description": "", "name": "AttributePicker", "members": [ { "kind": "method", "name": "_setDialogContent", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setDialogActions", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "multiSelect", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "multiSelect" }, { "kind": "field", "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyDatapointAttrs" }, { "kind": "field", "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyRuleStateAttrs" }, { "kind": "field", "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showPredictedDataAttrs" }, { "kind": "field", "name": "addBtn", "type": { "text": "OrVaadinButton" }, "privacy": "protected" }, { "kind": "method", "name": "setShowOnlyDatapointAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "setShowOnlyRuleStateAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "setShowPredictedDataAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "setMultiSelect", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "multiSelect", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "setOpen", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "isOpen", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "setHeading", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "heading", "type": { "text": "TemplateResult | string | undefined" } } ] }, { "kind": "method", "name": "setContent", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_content", "type": { "text": "TemplateResult | (() => TemplateResult) | undefined" } } ] }, { "kind": "method", "name": "setActions", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_actions", "type": { "text": "DialogAction[] | undefined" } } ] }, { "kind": "method", "name": "setDismissAction", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_action", "type": { "text": "DialogActionBase | null | undefined" } } ] }, { "kind": "method", "name": "setStyles", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_styles", "type": { "text": "string | TemplateResult | undefined" } } ] }, { "kind": "method", "name": "setAvatar", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_avatar", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "_updateDialogContent", "privacy": "protected", "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog." }, { "kind": "method", "name": "_updateDialogActions", "privacy": "protected", "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog." }, { "kind": "method", "name": "_getAttributesTemplate", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "attributes", "optional": true, "type": { "text": "Attribute[]" } }, { "name": "descriptors", "optional": true, "type": { "text": "AttributeDescriptor[]" } }, { "name": "selectedNames", "optional": true, "type": { "text": "string[]" } }, { "name": "multi", "default": "false" }, { "name": "onSelect", "optional": true, "type": { "text": "(attrNames: string[]) => void" } } ], "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrVaadinListBox with or without checkboxes, and uses Util.getAttributeLabel to formulate the text." }, { "kind": "method", "name": "_getStyles", "privacy": "protected", "return": { "type": { "text": "string" } }, "description": "Simple function that creates the CSS styles for this component" } ], "attributes": [ { "type": { "text": "boolean | undefined" }, "description": "Whether selecting multiple attributes is allowed or not.", "name": "multiSelect", "default": "false", "fieldName": "multiSelect" }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'STORE_DATAPOINT' meta item should be shown.", "name": "showOnlyDatapointAttrs", "default": "false", "fieldName": "showOnlyDatapointAttrs" }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'RULE_STATE' meta item should be shown.", "name": "showOnlyRuleStateAttrs", "default": "false", "fieldName": "showOnlyRuleStateAttrs" }, { "type": { "text": "boolean | undefined" }, "description": "Whether attributes with the 'HAS_PREDICTED_DATA_POINTS' meta item should be shown. Composes additively with the other flags.", "name": "showPredictedDataAttrs", "default": "false", "fieldName": "showPredictedDataAttrs" } ], "superclass": { "name": "OrMwcDialog", "package": "@openremote/or-mwc-components/or-mwc-dialog" }, "summary": "Abstract implementation of the Attribute Picker UI. Wraps around OrMwcDialog and provides some utility properties and functions to inherit." } ], "exports": [ { "kind": "js", "name": "AttributePickerPickedEvent", "declaration": { "name": "AttributePickerPickedEvent", "module": "src/attribute-picker.ts" } }, { "kind": "js", "name": "AttributePicker", "declaration": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [ { "kind": "class", "description": "CustomEvent that triggers once attributes have been selected, and the user closes the dialog.", "name": "OrAttributePickerPickedEvent", "superclass": { "name": "OrAssetAttributePickerPickedEvent", "module": "/src/asset-attribute-picker" }, "deprecated": "Replaced this class with an abstract {@link OrAssetAttributePickerPickedEvent}, that is inherited by other classes like {@link OrAssetAttributePicker} and {@link OrAssetTypeAttributePicker}.", "members": [ { "kind": "field", "name": "NAME", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "\"or-asset-attribute-picker-picked\"", "inheritedFrom": { "name": "OrAssetAttributePickerPickedEvent", "module": "src/asset-attribute-picker.ts" } } ] }, { "kind": "class", "description": "Dialog to pick attributes of supplied asset(s).", "name": "OrAttributePicker", "superclass": { "name": "OrAssetAttributePicker", "module": "/src/asset-attribute-picker" }, "deprecated": "Replaced this class with {@link OrAssetAttributePicker}.", "tagName": "or-attribute-picker", "customElement": true, "attributes": [ { "type": { "text": "(attribute: Attribute) => boolean | undefined" }, "description": "Callback method for consumers to filter the attribute list shown. Returning true will make the attribute visible, returning false hides it.", "name": "attributeFilter", "fieldName": "attributeFilter", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether selecting multiple attributes is allowed or not.", "name": "multiSelect", "default": "false", "fieldName": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'STORE_DATAPOINT' meta item should be shown.", "name": "showOnlyDatapointAttrs", "default": "false", "fieldName": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether only attributes with the 'RULE_STATE' meta item should be shown.", "name": "showOnlyRuleStateAttrs", "default": "false", "fieldName": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "type": { "text": "boolean | undefined" }, "description": "Whether attributes with the 'HAS_PREDICTED_DATA_POINTS' meta item should be shown. Composes additively with the other flags.", "name": "showPredictedDataAttrs", "default": "false", "fieldName": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "members": [ { "kind": "field", "name": "attributeFilter", "type": { "text": "(attribute: Attribute) => boolean | undefined" }, "privacy": "public", "attribute": "attributeFilter", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "field", "name": "_assetAttributes", "type": { "text": "Attribute[] | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "field", "name": "selectedAssets", "type": { "text": "string[]" }, "privacy": "public", "default": "[]", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "field", "name": "selectedAttributes", "type": { "text": "AttributeRef[]" }, "privacy": "public", "default": "[]", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "field", "name": "_asset", "type": { "text": "Asset | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "method", "name": "setAttributeFilter", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "attributeFilter", "type": { "text": "((attribute: Attribute) => boolean) | undefined" } } ], "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" }, "type": { "text": "setAttributeFilter(attributeFilter: ((attribute: Attribute) => boolean) | undefined) => this" } }, { "kind": "method", "name": "setSelectedAssets", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "selectedAssets", "type": { "text": "string[]" } } ], "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" }, "type": { "text": "setSelectedAssets(selectedAssets: string[]) => this" } }, { "kind": "method", "name": "setSelectedAttributes", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "selectedAttributes", "type": { "text": "AttributeRef[]" } } ], "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" }, "type": { "text": "setSelectedAttributes(selectedAttributes: AttributeRef[]) => this" } }, { "kind": "method", "name": "_setDialogActions", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_setDialogContent", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_onAssetSelectionChanged", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "OrAssetTreeSelectionEvent" } } ], "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.", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "method", "name": "_onAttributesSelect", "privacy": "protected", "parameters": [ { "name": "attrNames", "type": { "text": "string[]" } } ], "description": "HTML Callback function when the selected attributes have been updated.", "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } }, { "kind": "field", "name": "multiSelect", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "multiSelect", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyDatapointAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showOnlyRuleStateAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "attribute": "showPredictedDataAttrs", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "field", "name": "addBtn", "type": { "text": "OrVaadinButton" }, "privacy": "protected", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "setShowOnlyDatapointAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyDatapointAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyDatapointAttrs(showOnlyDatapointAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowOnlyRuleStateAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showOnlyRuleStateAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowOnlyRuleStateAttrs(showOnlyRuleStateAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setShowPredictedDataAttrs", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "showPredictedDataAttrs", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setShowPredictedDataAttrs(showPredictedDataAttrs: boolean | undefined) => this" } }, { "kind": "method", "name": "setMultiSelect", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "multiSelect", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setMultiSelect(multiSelect: boolean | undefined) => this" } }, { "kind": "method", "name": "setOpen", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "isOpen", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setOpen(isOpen: boolean) => this" } }, { "kind": "method", "name": "setHeading", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "heading", "type": { "text": "TemplateResult | string | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setHeading(heading: TemplateResult | string | undefined) => this" } }, { "kind": "method", "name": "setContent", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_content", "type": { "text": "TemplateResult | (() => TemplateResult) | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setContent(_content: TemplateResult | (() => TemplateResult) | undefined) => this" } }, { "kind": "method", "name": "setActions", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_actions", "type": { "text": "DialogAction[] | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setActions(_actions: DialogAction[] | undefined) => this" } }, { "kind": "method", "name": "setDismissAction", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_action", "type": { "text": "DialogActionBase | null | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setDismissAction(_action: DialogActionBase | null | undefined) => this" } }, { "kind": "method", "name": "setStyles", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_styles", "type": { "text": "string | TemplateResult | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setStyles(_styles: string | TemplateResult | undefined) => this" } }, { "kind": "method", "name": "setAvatar", "privacy": "public", "return": { "type": { "text": "this" } }, "parameters": [ { "name": "_avatar", "type": { "text": "boolean | undefined" } } ], "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" }, "type": { "text": "setAvatar(_avatar: boolean | undefined) => this" } }, { "kind": "method", "name": "_updateDialogContent", "privacy": "protected", "description": "Convenient function to update the dialog content manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_updateDialogActions", "privacy": "protected", "description": "Convenient function to update the dialog actions manually,\nsince updating the UI is handled different for OrMwcDialog.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getAttributesTemplate", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "attributes", "optional": true, "type": { "text": "Attribute[]" } }, { "name": "descriptors", "optional": true, "type": { "text": "AttributeDescriptor[]" } }, { "name": "selectedNames", "optional": true, "type": { "text": "string[]" } }, { "name": "multi", "default": "false" }, { "name": "onSelect", "optional": true, "type": { "text": "(attrNames: string[]) => void" } } ], "description": "Function that creates the HTML template for selecting attributes.\nCurrently uses OrVaadinListBox with or without checkboxes, and uses Util.getAttributeLabel to formulate the text.", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } }, { "kind": "method", "name": "_getStyles", "privacy": "protected", "return": { "type": { "text": "string" } }, "description": "Simple function that creates the CSS styles for this component", "inheritedFrom": { "name": "AttributePicker", "module": "src/attribute-picker.ts" } } ], "events": [ { "type": { "text": "OrAssetAttributePickerPickedEvent" }, "inheritedFrom": { "name": "OrAssetAttributePicker", "module": "src/asset-attribute-picker.ts" } } ], "modulePath": "src/index.ts", "definitionPath": "src/index.ts" } ], "exports": [ { "kind": "js", "name": "OrAttributePickerPickedEvent", "declaration": { "name": "OrAttributePickerPickedEvent", "module": "src/index.ts" } }, { "kind": "js", "name": "OrAttributePicker", "declaration": { "name": "OrAttributePicker", "module": "src/index.ts" } }, { "kind": "custom-element-definition", "name": "or-attribute-picker", "declaration": { "name": "OrAttributePicker", "module": "src/index.ts" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/asset-attribute-picker" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/assettype-attribute-picker" } } ] } ] }