#ctx.collection

Instance collection (Collection) được liên kết với ngữ cảnh thực thi RunJS hiện tại, dùng để truy cập metadata, định nghĩa field và cấu hình primary key của collection. Thường đến từ ctx.blockModel.collection hoặc ctx.collectionField?.collection.

#Kịch bản áp dụng

Lưu ý: ctx.collection khả dụng trong các kịch bản block dữ liệu, block form, block table có liên kết collection; JSBlock độc lập nếu không liên kết collection có thể là null, khuyến nghị kiểm tra null trước khi sử dụng.

#Định nghĩa kiểu

collection: Collection | null | undefined;

#Thuộc tính thường dùng

#Phương thức thường dùng

#Quan hệ với ctx.collectionField, ctx.blockModel

Trong các kịch bản như sub-table, ctx.collection có thể là collection đích quan hệ; trong form/table thông thường, thường là collection liên kết với block.

#Ví dụ

#Lấy primary key và mở popup

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

#Duyệt field để validate hoặc liên kết

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;
  }
}

#Lấy field quan hệ

const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
// Dùng để xây dựng sub-table, resource quan hệ, v.v.

#Lưu ý

• filterTargetKey là tên field primary key của collection; một số collection có thể có primary key phức hợp dạng string[]; khi chưa cấu hình, thường dùng 'id' làm fallback.
• Trong các kịch bản như sub-table, field quan hệ, ctx.collection có thể trỏ đến collection đích quan hệ, khác với ctx.blockModel.collection.
• getFields() sẽ gộp các field của collection kế thừa, field của bản thân ghi đè field cùng tên kế thừa.

#Liên quan

• ctx.collectionField: Định nghĩa field collection của field hiện tại
• ctx.blockModel: Block cha chứa JS hiện tại, có chứa collection
• ctx.model: Model hiện tại, có thể chứa collection