#ctx.collection

A instância da coleção (Collection) associada ao contexto de execução atual do RunJS, usada para acessar metadados da coleção, definições de campos, chaves primárias e outras configurações. Geralmente originada de ctx.blockModel.collection ou ctx.collectionField?.collection.

#Casos de Uso

Nota: ctx.collection está disponível em cenários onde um bloco de dados, bloco de formulário ou bloco de tabela está vinculado a uma coleção. Em um JSBlock independente que não esteja vinculado a uma coleção, ele pode ser null. Recomenda-se realizar uma verificação de valor nulo antes do uso.

#Definição de Tipo

collection: Collection | null | undefined;

#Propriedades Comuns

#Métodos Comuns

#Relação com ctx.collectionField e ctx.blockModel

Em cenários como sub-tabelas, ctx.collection pode ser a coleção de destino da associação; em formulários/tabelas padrão, geralmente é a coleção vinculada ao bloco.

#Exemplos

#Obter Chave Primária e Abrir Popup

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

#Iterar pelos Campos para Validação ou Vinculação (Linkage)

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} é obrigatório`);
    return;
  }
}

#Obter Campos de Associação

const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
// Usado para construir sub-tabelas, recursos associados, etc.

#Observações

• filterTargetKey é o nome do campo da chave primária da coleção. Algumas coleções podem usar um string[] para chaves primárias compostas. Se não estiver configurado, 'id' é comumente usado como fallback.
• Em cenários como sub-tabelas ou campos de associação, ctx.collection pode apontar para a coleção de destino da associação, o que difere de ctx.blockModel.collection.
• getFields() mescla campos de coleções herdadas; campos locais sobrescrevem campos herdados com o mesmo nome.

#Relacionados

• ctx.collectionField: A definição do campo de coleção do campo atual
• ctx.blockModel: O bloco pai que hospeda o JS atual, contendo collection
• ctx.model: O modelo atual, que pode conter collection