#ctx.collection

현재 RunJS 실행 컨텍스트와 연결된 컬렉션(Collection) 인스턴스로, 컬렉션의 메타데이터, 필드 정의 및 기본 키(Primary Key) 등의 설정에 접근하는 데 사용됩니다. 일반적으로 ctx.blockModel.collection 또는 ctx.collectionField?.collection에서 가져옵니다.

#적용 시나리오

주의: ctx.collection은 데이터 블록, 폼 블록, 테이블 블록 등 컬렉션이 바인딩된 시나리오에서 사용할 수 있습니다. 컬렉션이 바인딩되지 않은 독립적인 JSBlock의 경우 null일 수 있으므로, 사용 전 null 체크를 권장합니다.

#타입 정의

collection: Collection | null | undefined;

#주요 속성

#주요 메서드

#ctx.collectionField, ctx.blockModel과의 관계

하위 테이블 등의 시나리오에서 ctx.collection은 관계 대상 컬렉션일 수 있습니다. 일반적인 폼/테이블에서는 보통 블록에 바인딩된 컬렉션입니다.

#예시

#기본 키 가져오기 및 팝업 열기

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

#필드를 순회하며 유효성 검사 또는 연동 수행

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}은(는) 필수 항목입니다`);
    return;
  }
}

#관계 필드 가져오기

const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
// 하위 테이블, 관계 리소스 등을 구성하는 데 사용

#주의사항

• filterTargetKey는 컬렉션의 기본 키 필드명입니다. 일부 컬렉션은 string[] 형태의 복합 키를 가질 수 있으며, 설정되지 않은 경우 보통 'id'를 기본값으로 사용합니다.
• 하위 테이블, 관계 필드 등의 시나리오에서 ctx.collection은 관계 대상 컬렉션을 가리킬 수 있으며, 이는 ctx.blockModel.collection과 다를 수 있습니다.
• getFields()는 상속된 컬렉션의 필드를 병합하며, 자신의 필드가 동일한 이름의 상속된 필드를 덮어씁니다.

#관련 정보

• ctx.collectionField: 현재 필드의 컬렉션 필드 정의
• ctx.blockModel: 현재 JS를 포함하는 부모 블록, collection 포함
• ctx.model: 현재 모델, collection을 포함할 수 있음