Lista de elementos
Definición y uso
El componente Lista de elementos es un widget que permite mostrar una lista de elementos de un conjunto de datos como una lista plana o como un árbol de estructura. Lista de elementos permite a los usuarios finales realizar acciones en la lista completa o en elementos de lista específicos. Cuando los datos están en una lista plana, Lista de elementos también permite a los usuarios finales buscar, clasificar y filtrar la lista.
 |
En ThingWorx Navigate versión 9.3 y anteriores, el componente Lista de elementos era un mashup contenido. Ahora Lista de elementos está disponible como widget y el mashup Lista de elementos está obsoleto.
|
A continuación se presentan dos imágenes de ejemplo en las que se muestra el componente Lista de elementos:
El componente Lista de elementos se puede configurar de las siguientes maneras:
• Activar o desactivar la búsqueda y el filtrado (solo para listas planas)
• Definir las opciones iniciales de filtrado y clasificación (solo para listas planas)
• Definir el número máximo de filas de la rejilla.
• Definir si se pueden seleccionar elementos de la lista y, si es así, si se pueden seleccionar uno o varios elementos.
• Definir el nivel de expansión inicial (solo para el árbol de estructura)
• Elija si se debe mostrar la acción Exportar y permitir a los usuarios seleccionar el formato de fichero exportado
• Elegir si se deben exportar todos los datos o solo los datos que coincidan con los criterios de filtro
• Configurar las acciones disponibles en la Barra de acciones integrada.
El usuario puede filtrar la lista de elementos o buscar en ella mediante el cuadro de filtro o el cuadro de búsqueda. Sin embargo, si el cuadro de filtro y el cuadro de búsqueda no se activan en la configuración, el filtrado y la búsqueda no están disponibles. Se puede pulsar en el título de una columna para clasificar la lista por esa columna. Para invertir el orden de clasificación, vuelva a pulsar en el título de columna.
En el componente Lista de elementos se incluye un componente Barra de acciones integrado. Al configurar la barra de acciones, se pueden activar funciones adicionales, como ejecutar una acción en uno o más elementos de la lista. Consulte Barra de acciones (BETA) para obtener más información. Por defecto, la Lista de elementos contiene una acción Exportar que permite exportar los elementos a un fichero CSV.
En la lista de elementos también se incluye un botón Restaurar a valores por defecto. El botón Restaurar a valores por defecto permite restaurar la configuración por defecto para el filtrado, la búsqueda y las operaciones de nivel de rejilla, incluida la clasificación, el intercambio y la visualización y ocultación de columnas.
Actividad, Elementos afectados, Adjuntos, Ficheros de diseño, Planos, Estructura de artículo y Tareas son las configuraciones predefinidas disponibles para el componente Lista de elementos.
Lista plana frente a árbol de estructura
Como se mencionó anteriormente, Lista de elementos soporta listas planas y árboles de estructura. El que la Lista de elementos aparezca como una lista plana o un árbol de estructura en la interfaz de usuario depende de cómo se formatee la entrada al servicio GetItems. Para obtener más información, consulte el servicio GetItems a continuación.
Cuando Lista de elementos es un árbol de estructura, no se soportan la búsqueda, la clasificación ni el filtro, aunque se configuren mediante las propiedades de configuración siguientes.
Cuando Lista de elementos es una lista plana, el nivel de expansión por defecto no es relevante.
Propiedades de enlace
Entrada | ||||
|---|---|---|---|---|
Nombre de la propiedad | Descripción | Tipo de propiedad | ||
input | Se utiliza para identificar los datos que se deben extraer del sistema back-end. Cuando se requiere la entrada, defina la propiedad de configuración waitForInput en true. JSON de ejemplo: { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | JSON en formato CCO | ||
selectedItems | Se utiliza para identificar y seleccionar elementos de la rejilla y sus atributos como entrada. Se puede enlazar la propiedad de enlace output de otros componentes a esta propiedad. JSON de ejemplo: { "data":[ { "itemListsData":[ { "items":[ { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143921" } }, { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143928" } } ], "objectType":"PTC.Workflow.WorkItem" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ], "version":"1.0.0", "statusMessage":"OK", "status":"200" }
| JSON en formato CCO | ||
tailoringName | Identifica de forma exclusiva una instancia del componente Lista de elementos. Este valor se utiliza internamente para buscar información de personalización de esa instancia específica. Utilice esta propiedad de enlace solo cuando haya una página de personalización dedicada para la tarea personalizada. | |||
Salida | ||||
|---|---|---|---|---|
Nombre de la propiedad | Descripción | Tipo de propiedad | ||
totalItemsNumber | Número de elementos de lista que coinciden con los criterios de búsqueda y filtro.
| Entero | ||
selectedItems | Se utiliza para identificar los elementos de la rejilla seleccionada y sus atributos. Esta propiedad se puede enlazar a la propiedad de enlace input de otros componentes. JSON de ejemplo: { "data":[ { "itemListsData":[ { "items":[ { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143921" } }, { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143928" } } ], "objectType":"PTC.Workflow.WorkItem" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ], "version":"1.0.0", "statusMessage":"OK", "status":"200" } | JSON en formato CCO | ||
Propiedades de configuración
En la tabla y las imágenes siguientes se muestran los campos JSON que se utilizan para configurar este componente.
Para obtener más información sobre la estructura de la configuración, consulte Estructura de configuración de componentes.
Para obtener más información sobre las subpropiedades, consulte Subpropiedades y claves de contenedor.
Nombre de la propiedad | Descripción | Tipo de propiedad | Valor por defecto | Obligatorio u opcional | |||
|---|---|---|---|---|---|---|---|
actionBarConfiguration | Configuración de la barra de acciones integrada. Consulte Barra de acciones (BETA) para obtener más información. | N/D | Opcional | ||||
attributes | Atributos que se deben mostrar. Aparecen como títulos de columna en la rejilla. Lista de elementos soporta la inclusión de la subpropiedad hidden para ocultar atributos específicos de la interfaz de usuario de Navigate. Para obtener más información, consulte Estructura para seleccionar atributos. Para obtener información sobre cómo incluir una acción en una columna de atributo, consulte la nota que aparece debajo de esta tabla. | N/D | Obligatorio | ||||
downloadFileName | Se utiliza para especificar un nombre personalizado para los ficheros descargados, incluidos: • Ficheros que se descargan directamente de la columna Nombre de Lista de elementos • Ficheros que se descargan individualmente de la columna Formatos • Ficheros que se descargan como un fichero.zip con el botón Descargar todo Por defecto, esta propiedad se define en <filename>.<ext>. En el momento de la descarga, <filename> es un token que se reemplaza por el nombre de fichero específico y el token <ext> se reemplaza por la extensión de fichero. Código de muestra: { "downloadFileName":{ "selectedValues":{ "data":[ { "itemListsData":[ ], "adapter":{ } } ] }, "pattern":"<filename>.<ext>" } } | N/D | Opcional | ||||
defaultExpansionLevel | Permite definir el nivel de expansión inicial del árbol de estructura. Acepta los números del 1 al 9 y -1 como entrada. Cuando la propiedad se define en -1, el árbol de estructura se expande completamente de manera inicial y se muestran todos los niveles.
| 3 | Opcional | ||||
defaultSelectedFilterValue | Valor o valores seleccionados iniciales por los que se debe filtrar. Si se deja en blanco, no hay filtrado por defecto. Esta propiedad es una subpropiedad de filterFields y solo es pertinente cuando filterFields se incluye en la configuración. Su clave de contenedor es itemListFilterFieldDefinition.
| N/D | Opcional | ||||
defaultSortDirection | La dirección de la clasificación por defecto. Opciones: asc, que indica el orden ascendente y dsc, que indica el orden descendente. Si se deja en blanco, la dirección de clasificación es ascendente. Esta propiedad es una subpropiedad de defaultSortField y solo es pertinente cuando defaultSortField se incluye en la configuración. Su clave de contenedor es itemListDefaultSortFieldDefinition.
| asc | Opcional | ||||
defaultSortField | La columna inicial por la que se debe clasificar. Si se deja en blanco, la lista de elementos se clasifica por la primera columna.
| N/D | Opcional | ||||
enableSearch | Si se debe presentar el campo de búsqueda. Opciones: true, false.
| true | Opcional | ||||
exportUnFilteredData | Si se deben incluir todos los datos o solo los datos filtrados al exportar los datos de Lista de elementos a un fichero. Opciones: true, false. Cuando se define en true, el fichero exportado incluye los datos, independientemente del filtrado. Si se define en false, el fichero exportado solo contiene los datos filtrados. Los datos que no están visibles en la rejilla de Lista de elementos debido al límite de propiedad maxNumberOfRowsInGrid todavía se incluyen en el fichero exportado. Esta propiedad es una subpropiedad de showExportAction y solo es pertinente cuando showExportAction se incluye en la configuración. Su clave de contenedor es itemListExportDefinition. | false | Opcional | ||||
exportTypes | Los tipos de exportación disponibles. Opciones: exportToCsv, exportToExcel. Se puede incluir una o ambas opciones. Cuando se incluye exportToCsv, el botón Exportar incluye la opción de exportar datos a un fichero CSV en formato estándar. Cuando se incluye exportToExcel, el botón Exportar incluye la opción de exportar datos formateados para Excel a un fichero CSV. Si solo se incluye una opción, el botón Exportar exporta automáticamente los datos en el formato seleccionado (CSV estándar o CSV con formato Excel). Cuando se incluyen ambas opciones, el botón Exportar aparece como un botón de menú, lo que permite al usuario seleccionar el formato de exportación deseado. Esta propiedad es una subpropiedad de showExportAction y solo es pertinente cuando showExportAction se incluye en la configuración. Su clave de contenedor es itemListExportDefinition. | exportToCsv, exportToExcel | Opcional | ||||
filterFields | Los ID en el sistema back-end de los campos por los que se deben filtrar los datos. Si se deja en blanco, no hay ninguna opción para filtrar los datos.
| N/D | Opcional | ||||
filterLabelOverride | Un rótulo del filtro que sustituye el valor mostrado que se ha devuelto del servicio GetItems. Esta propiedad es una subpropiedad de filterFields y solo es pertinente cuando filterFields se incluye en la configuración. Su clave de contenedor es itemListFilterFieldDefinition. | N/D | Opcional | ||||
implementationConfigurations | Punto de entrada para que el generador de la aplicación pase valores adicionales necesarios para su implementación, a fin de personalizar más el componente. | N/D | Opcional | ||||
label | El título de la lista de elementos. | [[PTC.ItemList]] | Opcional | ||||
maxNumberOfRowsInGrid | Número máximo de filas que se deben mostrar en el área de rejilla. Se recomienda introducir un valor inferior a 10.000.
| 500 | Opcional | ||||
searchHintText | El texto de sugerencia que se muestra en el cuadro de búsqueda. Esta propiedad es una subpropiedad de enableSearch y solo es pertinente cuando enableSearch se define en true. Su clave de contenedor es itemListSearchDefinition. | Find Item | Opcional | ||||
selectionType | Permite determinar el número de elementos de la rejilla que se pueden seleccionar al mismo tiempo. Opciones: • none: no se pueden seleccionar elementos de la rejilla • single: se puede seleccionar elementos de la rejilla de uno en uno • multi: se pueden seleccionar uno o más elementos de la rejilla a la vez | multi | Opcional | ||||
showExportAction | Permite activar o desactivar la acción Exportar. Opciones: true, false. | true | Opcional | ||||
showImplementationActions | Permite especificar acciones adicionales que se deben incluir en la barra de acciones integrada, como un botón Descargar todo en las configuraciones predefinidas de Ficheros de diseño, Planos y Adjuntos. | N/D | Opcional | ||||
waitForInput | Si se debe esperar en tiempo de ejecución a que se pase un valor al parámetro de mashup de entrada de Lista de elementos antes de activar la recuperación de los elementos que rellenan la rejilla. Opciones: true, false. | false | Opcional | ||||
| | Al incluir un atributo con valores de HTML que muestra un botón de menú en una columna de atributo, la acción debe estar bajo la clave PTCNav. Ejemplo: { "label":"", "icon":"", "PTCNav":{ "Action":{ "type":"openUrl", "data":{ "url":"http://www.linkTofile.pdf" } } } } |
Configuración de ejemplo
Para las configuraciones de ejemplo del componente Lista de elementos, consulte Actividad, Elementos afectados, Adjuntos, Ficheros de diseño, Planos, Estructura de artículo y Tareas.
Servicios de personalización
Además de la configuración, cada componente soporta la extensión de la lógica empresarial para personalizar el componente. En la lógica empresarial de cada componente se incluyen los servicios desestimables en una plantilla de cosa que se pueden extender y sustituir. En la tabla siguiente se describen los servicios desestimables de este componente.
Para obtener ejemplos de los valores de devolución y los parámetros de cada servicio, consulte Ejemplos de entrada/salida para servicios de personalización.
| | Al devolver un objeto JSON en formato CCO desde un componente de implementación de lógica empresarial al componente Lista de elementos, solo se incluyen los atributos de un único tipo de objeto. Actualmente, Lista de elementos no soporta la inclusión de atributos de diferentes tipos de objeto. |
Nombre | Descripción |
|---|---|
ComputeMessages | Calcula los mensajes deseados que se deben mostrar encima de la rejilla de lista de elementos en la interfaz de usuario. Recibe el JSON de mensajes actuales y el JSON de mensajes sugeridos, y devuelve un JSON de mensajes de notificación que contiene los mensajes que se deben mostrar en la lista de elementos. Parámetros: getItemsResponse (obligatorio): objeto JSON en formato CCO que contiene los elementos devueltos del servicio getItems. currentMessages (obligatorio): objeto JSON que contiene mensajes de notificación actuales que se muestran en la interfaz de usuario. suggestedMessages (obligatorio): objeto JSON que contiene un conjunto de mensajes sugeridos. Se recomienda utilizar los mensajes sugeridos. input (opcional): JSON en formato CCO que incluye el ID de entrada del elemento en la raíz de la estructura. configuration (opcional): JSON con la configuración. scope (opcional): JSON que indica el ámbito de los datos de getItemsResponse. El objeto JSON contiene una clave scope que acepta los valores root y child. Pertinente para datos jerárquicos. Ejemplo: { "scope": "root" } Devuelve: objeto JSON que contiene mensajes que se deben mostrar en la rejilla de lista de elementos. Ejemplo: "INFO":{ { "messages":[ "[[PTC.Nav.ItemList.HiddenItemsBecauseAccessRightMessage]]" ] } } |
DefHookGetImplementationActionsList | Permite devolver las acciones que figuran bajo la clave implementationActions del servicio GetImplementationSettings. Parámetros: ninguno Devuelve: JSON: matriz |
DefHookImplementationAttributesDefinition | Devuelve la definición específica de la implementación para los atributos seleccionados. Parámetros: ninguno Devuelve: JSON: matriz |
DefHookImplementationConfigurationDefinitionGroup | Devuelve la definición específica de la implementación con las configuraciones personalizadas para la implementación. Parámetros: ninguno Devuelve: JSON: matriz |
DefHookMaxRowsProperties | Devuelve las propiedades del número máximo de filas que se deben mostrar en el área de rejilla. Parámetros: ninguno Devuelve: JSON |
GetChildren | Recibe un elemento y devuelve un JSON en formato CCO que contiene los hijos de dicho elemento, lo que significa que todos los elementos se encuentran un nivel por debajo de ese elemento en la estructura de datos jerárquica. El JSON devuelto contiene los hijos como una lista plana, no como datos jerárquicos. Se llama a este servicio siempre que un usuario expande un elemento en la lista de elementos cuyos hijos no se han cargado. En la implementación por defecto de este servicio se supone que el servicio MapItemToInputObject se implementa para la conversión de elemento a entrada, si se requiere. Parámetros: input (opcional): JSON en formato CCO que incluye el ID de entrada del elemento en la raíz de la estructura. configuration (obligatorio): JSON con la configuración. item (obligatorio): JSON que incluye el elemento padre cuyos hijos se deben devolver. Devuelve: JSON en formato CCO |
GetConfigurations | Devuelve las configuraciones disponibles para la implementación de componentes. Parámetros: ninguno Devuelve: JSON |
GetImplementationLabel | Devuelve el nombre localizado del componente o el token que se puede utilizar para obtener el nombre localizado. Este nombre localizado se muestra en la interfaz de usuario de Mashup Builder. Parámetros: ninguno Devuelve: Cadena |
GetImplementationSettings | Devuelve los datos de configuración de la implementación. Las implementaciones pueden sustituir este servicio para proporcionar su propia configuración. Para obtener más información, consulte el tema Activación de la propiedad de enlace de entrada selectedItems para Lista de elementos. Este servicio soporta la inclusión de las siguientes claves: itemIdentifierKeys, itemExpansionKeys, hasChildrenKeys, overrideItemsDataForExport y implementationActions. Parámetros: ninguno Devuelve: objeto JSON |
GetItems | Devuelve la lista de elementos del sistema back-end. Para crear una implementación personalizada de Lista de elementos, sustituya este servicio para recuperar los datos personalizados. Parámetros: input (opcional): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end y la información del adaptador para el sistema back-end. Al utilizar este parámetro, asegúrese de que la propiedad de configuración waitForInput esté definida en true. configuration (opcional): JSON con la configuración. Devuelve: JSON en formato CCO |
GetItemsByExpansionPath | Devuelve un CCO de estructura jerárquica que contiene todos los elementos en la ruta desde la raíz al elemento solicitado, incluidos todos los atributos solicitados, itemIdentifierKeys y itemExpansionKeys, según se haya definido en el servicio GetImplementationSettings. El CCO de estructura jerárquica incluye todos los hermanos en la ruta. Se llama al servicio cuando la propiedad de enlace selectedItems recibe una entrada que especifica un elemento que no se ha cargado. Parámetros: input (opcional): JSON en formato CCO que incluye el ID de entrada del elemento en la raíz de la estructura. configuration (obligatorio): JSON con la configuración. itemExpansionValues (obligatorio): una matriz JSON que contiene itemExpansionKeys del elemento para el que se solicita la expansión. Los valores de la matriz se ordenan según la ruta del árbol, empezando por el elemento raíz. Devuelve: JSON en formato CCO |
GetItemsForExport | Procesa el JSON de configuración y el JSON de entrada en formato CCO, y devuelve un JSON en formato CCO que contiene todos los elementos necesarios para la exportación. Por defecto, este servicio devuelve un CCO vacío, pero las implementaciones pueden sustituir el servicio para devolver sus elementos para la exportación. En ese caso, los datos de la exportación son los elementos que devuelve este servicio. El resultado de este servicio se utiliza cuando la propiedad de enlace selectedItems recibe una entrada que especifica un elemento que no se ha cargado. Parámetros: input (opcional): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end. configuration (opcional): JSON con la configuración. Devuelve: JSON en formato CCO |
GetStructureSkeleton | Devuelve todos los niveles de una estructura jerárquica en formato CCO, donde cada elemento de la estructura incluye itemIdentifierKeys y itemExpansionKeys, según se haya definido en el servicio GetImplementationSettings. Parámetros: input (opcional): JSON en formato CCO que incluye el ID de entrada del elemento en la raíz de la estructura. configuration (opcional): JSON con la configuración. Devuelve: JSON en formato CCO |
InitializeFilters | Devuelve la definición de tipo de filtro de cada uno de los campos de filtro de la configuración. Parámetros: input (opcional): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end y la información del adaptador para el sistema back-end. configuration (opcional): JSON con la configuración. Devuelve: JSON en formato CCO |
MapItemToInputObject | Permite asignar un elemento a una entrada, que el servicio GetItems puede utilizar después. La implementación por defecto devuelve el elemento sin realizar cambios. Si los cambios son necesarios, por ejemplo, cambiar el tipo de objeto del elemento, sustituya este servicio. Solo la implementación por defecto del servicio GetChildren utiliza este servicio. Parámetros: input (opcional): JSON en formato CCO que incluye el ID de entrada del elemento en la raíz de la estructura. item (obligatorio): JSON en el que se incluye el elemento que se va a asignar a una entrada. |
PrepareDataForExport | Recibe datos en forma de infotable y los prepara para la exportación. La implementación por defecto devuelve los datos tal como están, pero las implementaciones pueden sustituir este servicio a fin de modificar los datos según sea necesario. Parámetros: configuration (obligatorio): JSON con la configuración. dataInfoTable (obligatorio): infotable en la que se incluyen los datos para la exportación. data (opcional): objeto JSON en formato CCO en el que se incluyen los datos para la exportación. gridQuery (opcional): objeto JSON que representa el tipo de datos QUERY, que contiene un filtro de consulta de la rejilla de lista de elementos. searchTerm (opcional): una cadena que se debe buscar en cada fila de la rejilla. filterOptions (opcional): una infotable que contiene opciones por las que se debe filtrar. Devuelve: infotable |
Definición de implementación
Para las definiciones de implementación del componente Lista de elementos, consulte Actividad, Elementos afectados, Adjuntos, Ficheros de diseño, Planos, Estructura de artículo y Tareas.