#ctx.collectionField

A instância do campo da coleção (CollectionField) associada ao contexto de execução atual do RunJS, usada para acessar metadados do campo, tipos, regras de validação e informações de associação. Existe apenas quando o campo está vinculado a uma definição de coleção; campos personalizados/virtuais podem ser null.

#Cenários de Uso

Nota: ctx.collectionField está disponível apenas quando o campo está vinculado a uma definição de Coleção; geralmente é undefined em cenários como blocos independentes JSBlock ou eventos de ação sem vínculo de campo. Recomenda-se verificar valores nulos antes do uso.

#Definição de Tipo

collectionField: CollectionField | null | undefined;

#Propriedades Comuns

#Métodos Comuns

#Exemplos

#Renderização condicional baseada no tipo de campo

if (!ctx.collectionField) return null;
const { interface: iface } = ctx.collectionField;
if (['m2o', 'o2m', 'm2m'].includes(iface)) {
  // Campo de associação: exibe registros associados
  const target = ctx.collectionField.targetCollection;
  // ...
} else if (iface === 'select' || iface === 'radioGroup') {
  const options = ctx.collectionField.enum || [];
  // ...
}

#Determinar se é um campo de associação e acessar a coleção de destino

if (ctx.collectionField?.isAssociationField()) {
  const targetCol = ctx.collectionField.targetCollection;
  const titleField = targetCol?.titleCollectionField?.name;
  // Processar de acordo com a estrutura da coleção de destino
}

#Obter opções de enumeração

const options = ctx.collectionField?.enum ?? [];
const labels = options.map((o) => (typeof o === 'object' ? o.label : o));

#Renderização condicional baseada no modo apenas leitura/visualização

const { Input } = ctx.libs.antd;
if (ctx.collectionField?.readonly) {
  ctx.render(<span>{ctx.getValue?.() ?? '-'}</span>);
} else {
  ctx.render(<Input onChange={(e) => ctx.setValue?.(e.target.value)} />);
}

#Obter o campo de título da coleção de destino

// Ao exibir um campo de associação, use targetCollectionTitleField para obter o nome do campo de título
const titleField = ctx.collectionField?.targetCollectionTitleField;
const titleKey = titleField?.name ?? 'title';
const assocValue = ctx.getValue?.() ?? ctx.record?.[ctx.collectionField?.name];
const label = assocValue?.[titleKey];

#Relação com ctx.collection

ctx.collection geralmente representa a coleção vinculada ao bloco atual; ctx.collectionField representa a definição do campo atual na coleção. Em cenários como sub-tabelas ou campos de associação, os dois podem ser diferentes.

#Observações

• Em cenários como JSBlock ou JSAction (sem vínculo de campo), ctx.collectionField geralmente é undefined. Recomenda-se usar encadeamento opcional (optional chaining) antes do acesso.
• Se um campo JS personalizado não estiver vinculado a um campo de coleção, ctx.collectionField pode ser null.
• targetCollection existe apenas para campos do tipo associação (ex: m2o, o2m, m2m); enum existe apenas para campos com opções como select ou radioGroup.

#Relacionado

• ctx.collection: Coleção associada ao contexto atual
• ctx.model: Modelo onde o contexto de execução atual está localizado
• ctx.blockModel: Bloco pai que contém o JS atual
• ctx.getValue(), ctx.setValue(): Ler e escrever o valor do campo atual