#ctx.collection

La instancia de la colección (Collection) asociada al contexto de ejecución actual de RunJS, utilizada para acceder a los metadatos de la colección, definiciones de campos, claves primarias y otras configuraciones. Generalmente proviene de ctx.blockModel.collection o ctx.collectionField?.collection.

#Escenarios de uso

Nota: ctx.collection está disponible en escenarios donde un bloque de datos, bloque de formulario o bloque de tabla está vinculado a una colección. En un JSBlock independiente que no esté vinculado a una colección, puede ser null. Se recomienda realizar una comprobación de valores nulos antes de su uso.

#Definición de tipo

collection: Collection | null | undefined;

#Propiedades comunes

#Métodos comunes

#Relación con ctx.collectionField y ctx.blockModel

En escenarios como subtablas, ctx.collection podría ser la colección de destino de la asociación; en formularios o tablas estándar, suele ser la colección vinculada al bloque.

#Ejemplos

#Obtener la clave primaria y abrir una ventana emergente

const primaryKey = ctx.collection?.filterTargetKey ?? 'id';
await ctx.openView(popupUid, {
  mode: 'dialog',
  params: {
    filterByTk: ctx.record?.[primaryKey],
    record: ctx.record,
  },
});

#Iterar a través de los campos para validación o vinculación

const fields = ctx.collection?.getFields() ?? [];
const requiredFields = fields.filter((f) => f.options?.required);
for (const f of requiredFields) {
  const v = ctx.form?.getFieldValue(f.name);
  if (v == null || v === '') {
    ctx.message.warning(`${f.title} es obligatorio`);
    return;
  }
}

#Obtener campos de asociación

const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
// Se utiliza para construir subtablas, recursos asociados, etc.

#Notas

• filterTargetKey es el nombre del campo de la clave primaria de la colección. Algunas colecciones pueden usar un string[] para claves primarias compuestas. Si no está configurado, comúnmente se utiliza 'id' como alternativa.
• En escenarios como subtablas o campos de asociación, ctx.collection puede apuntar a la colección de destino de la asociación, lo cual difiere de ctx.blockModel.collection.
• getFields() fusiona los campos de las colecciones heredadas; los campos locales sobrescriben a los campos heredados con el mismo nombre.

#Relacionado

• ctx.collectionField: La definición del campo de la colección del campo actual
• ctx.blockModel: El bloque padre que aloja el JS actual, contiene collection
• ctx.model: El modelo actual, que puede contener collection