属性
定义和用法
“属性”组件是一个小组件，用于显示名称值对。值始终显示在名称下方。可以显示不同数据类型的值。可以使用组名称，将一个属性集显示为一个组。
下面的示例图像显示“属性”组件：
选定部件或文档的属性显示在界面右侧的预览窗格中，如下图所示。
可通过以下方式配置“属性”组件：
• 定义要显示的属性。
• 设置布局和相关的显示设置。
• 定义属性组的标题；这仅适用于具有垂直布局的属性组。
• 使用修饰器为属性添加某一预设任务的链接。目前，仅支持在修饰器列表中找到的第一个修饰器。
要将链接添加到属性，请在配置中向属性添加修饰器，包括 appId 和 thingName (PTC.Nav.LinkToAppDecoratorThing)。例如：
 | 从 Windchill Navigate 9.4.0 开始 ，decoratedType 键被移到 decoration 配置部分中的 metadata 键之下。 |
metadata: {
Number: {
"label": "Number",
"type": "STRING",
"decoration": {
"decoratedType": "HTML",
"decorators": [{
"thingName": "PTC.Nav.LinkToAppDecoratorThing",
"parameters": {
"appId": "PTC.Nav.ViewDesignFiles"
}
}]
}
Number: {
"label": "Number",
"type": "STRING",
"decoration": {
"decoratedType": "HTML",
"decorators": [{
"thingName": "PTC.Nav.LinkToAppDecoratorThing",
"parameters": {
"appId": "PTC.Nav.ViewDesignFiles"
}
}]
}
可以使用下列 App ID 导航至相应的任务：
任务 | App ID |
|---|---|
部件任务集合 | |
查看设计文件 | PTC.Nav.ViewDesignFiles |
查看绘图 | PTC.Nav.ViewDrawing |
在 3D 中查看和测量 | PTC.Nav.ViewAndMeasureIn3D |
查看部件特性 | PTC.Nav.ViewPartProperties |
查看部件列表 | PTC.Nav.ViewPartList |
查看部件结构 | PTC.Nav.ViewPartStructure |
文档任务集合 | |
查看文档 | PTC.Nav.ViewDocument |
查看文档结构 | PTC.Nav.ViewDocumentStructure |
属性通用是适用于“属性”组件的通用预定义配置。
绑定特性
输入 | ||
|---|---|---|
特性名称 | 说明 | 特性类型 |
Input | 用于标识要从后端系统中获取的数据。 JSON 示例： { "version":"1.0.0", "data":[ { "adapter":{ "thingName":"PTC.WCAdapter", "instanceName":"windchill" }, "itemListsData":[ { "objectType":"PTC.ChangeMgmt.ChangeRequest", "items":[ { "id":{ "value":"OR:wt.change2.WTChangeRequest2:439476" } } ] } ] } ] } | CCO 格式的 JSON |
TailoringName | 用于唯一标识“属性”组件的实例。此值在内部使用，可供查找此特定实例的定制信息。 只有在自定义任务存在专用的定制页面时，才使用此绑定特性。 | 字符串 |
SubComponentConfiguration | 将此组件用作另一组件内或内置混搭内的一个子组件时，会将配置绑定到此特性。 JSON 示例： { "implementationThingName":"PTC.Nav.AttributesGenericBusinessLogicThing", "configuration":{ "layout":{ "selectedKey":"horizontal", "additionalData":{ }, "version":"1.0.0" }, "attributes":{ "sets":[ { "data":{ "selectedValues":{ "data":[ { "itemListsData":[ { "items":[ { "id":"Role#Display", "ordinal":0 }, { "id":"Activity|Deadline", "ordinal":5 }, { "id":"Status#Display", "ordinal":4 } ], "objectType":"PTC.Workflow.WorkItem" }, { "items":[ { "id":"Category#Display", "ordinal":1 }, { "id":"RequestPriority#Display", "ordinal":3 } ], "objectType":"PTC.ChangeMgmt.ChangeRequest" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ] } } } ] } } } | JSON |
配置特性
以下表格和图像显示用于配置此组件的 JSON 特性。
有关详情，请参阅组件配置结构。
有关子特性的详情，请参阅子特性和容器键。
特性名称 | 说明 | 特性类型 | 默认值 | 必需或可选 | |||
|---|---|---|---|---|---|---|---|
attributes | 需要从后端系统获取其数据的特性的列表。 对于 Windchill，这些特性名称必须与 Windchill REST Services EDM 所定义的特性名称匹配。 此外，还接受具有 PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter 对象类型的 DefaultPDFRepresentation 属性。如果配置中包含 DefaultPDFRepresentation 属性，用户界面中会显示“表示”属性。“表示”属性包含一个链接，通过该链接可以查看项的表示 (如有)。
| 不适用 | 必需 | ||||
isMultiLine | 用于控制：内容是否应换行。选项：true 和 false。 此特性为 layout 的子特性，只有在 layout 设置为 vertical 时，此特性才相关。其容器键为 isMultilineDefinition。 | 不适用 | 必需 | ||||
layout | 用于确定属性在用户界面中的排列方式。可用选项如下： • vertical：属性纵向堆叠。 • horizontal：属性横向排列。 | 不适用 | 必需 | ||||
maxHeight | 用户界面中属性的名称和值的最大高度。 如果内容超出 maxHeight 特性的值，系统会提供“显示更多/显示更少”链接或按钮。 此特性仅与以下两种情况有关： • layout 设置为 horizontal。在这种情况下，此特性为 layout 的子特性。 • layout 设置为 vertical，而 isMultiLine 设置为 true。在这种情况下，此特性为 isMultiLine 的子特性。 其容器键为 dimensionDefinition。 | 不适用 | 必需 | ||||
maxWidth | 用户界面中属性的名称和值的最大宽度。 此特性仅与以下两种情况有关： • layout 设置为 horizontal。在这种情况下，此特性为 layout 的子特性。 • layout 设置为 vertical，而 isMultiLine 设置为 false。在这种情况下，此特性为 isMultiLine 的子特性。 其容器键为 dimensionDefinition。 | 不适用 | 必需 | ||||
messageWhenNoAttributes | 允许在没有可用属性时显示消息。 该值可留空。在这种情况下，不会显示任何消息，也不会保留任何特殊占位符。 | 不适用 | 可选 | ||||
hideLabel | 用于控制属性标签的可见性。 • 将此特性设置为 true 时，可以隐藏属性标签。 • 将此特性设置为 false 时，可以显示属性标签。 | false | 可选 | ||||
示例配置
有关“属性”组件的示例配置，请参阅属性通用配置。
自定义服务
除了配置外，每个组件还支持通过扩展其业务逻辑来自定义组件。每个组件的业务逻辑在事物模板中都包含可改写的服务，您可以对这些服务进行扩展和改写。下表对此组件的可改写服务进行了详细说明。
有关每个服务的返回值和参数的示例，请参阅自定义服务的输入/输出示例。
名称 | 说明 |
|---|---|
GetConfigurations | 返回组件实现的可用配置。 参数：无 返回：JSON |
GetImplementationLabel | 返回此组件的本地化名称，或返回可用于获取此本地化名称的标记。此本地化名称显示在 Mashup Builder 用户界面中。 参数：无 返回：字符串 |
ProcessAttributesConfiguration | 处理属性配置，并将属性分为预设属性和附加属性。 返回 JSON，其中包含下列形式的键值对： • OOTBAttributes : OOTB Attributes configuration CCO JSON • additionalAttributes : Additional Attributes configuration CCO JSON 系统会根据对象类型将属性拆分为预设属性和附加属性。对象类型以 .Custom.Adapter 或 Custom.Implementation 结尾的属性将被视为附加属性。而所有其他属性都将被视为预设属性。 参数： attributes (必需) - JSON，其中包含预设属性和附加属性的列表。 configuration (可选) - JSON，其中包含从“定制管理器”资源获得的最终合并配置。 返回：CCO 格式的 JSON |
GetAttributesValues | 返回具有属性及其值的 JSON。 参数： input (必需) - CCO 格式的 JSON，其中包含要从后端系统获取的数据的输入 ID，以及后端系统的适配器信息。 configuration (可选) - JSON，其中包含从“定制管理器”资源获得的最终合并配置。 attributes (必需) - JSON，其中包含预设属性和附加属性的列表。 返回：CCO 格式的 JSON |
GetAdditionalAttributesValues | 返回具有其他属性值的 JSON。此服务应通过组件实现来实现。 参数： input (必需) - CCO 格式的 JSON，其中包含要从后端系统获取的数据的输入 ID，以及后端系统的适配器信息。 configuration (可选) - JSON，其中包含从“定制管理器”资源获得的最终合并配置。 attributes (必需) - JSON，其中包含附加属性的列表。 返回：CCO 格式的 JSON |
GetAdditionalAttributes | 返回要添加至可用预设属性列表中的附加属性的列表。 参数：无 返回：JSON |
UpdateAvailableAttributes | 更新属性列表中的一个或多个属性，并返回最终列表。 参数： attributes (必需) - JSON，其中包含预设属性和附加属性的列表。 返回：JSON |
实施定义
有关“属性”组件的实施定义，请参阅属性通用配置。