From 4dbb19f7bcd6fdb98d70be2ad303ca2ea101f09e Mon Sep 17 00:00:00 2001
From: Dushusir <1414556676@qq.com>
Date: Mon, 3 Mar 2025 21:06:36 +0800
Subject: [PATCH] feat(facade): get custom meta data

---
 packages/sheets/src/facade/f-worksheet.ts | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/packages/sheets/src/facade/f-worksheet.ts b/packages/sheets/src/facade/f-worksheet.ts
index c6f702cf5e0..91050a3e4fa 100644
--- a/packages/sheets/src/facade/f-worksheet.ts
+++ b/packages/sheets/src/facade/f-worksheet.ts
@@ -2389,6 +2389,21 @@ export class FWorksheet extends FBaseInitialable {
         return this;
     }
 
+    /**
+     * Get custom metadata of worksheet
+     * @returns {CustomData | undefined} custom metadata
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const custom = fWorkSheet.getCustomMetadata();
+     * console.log(custom);
+     * ```
+     */
+    getCustomMetadata(): CustomData | undefined {
+        return this._worksheet.getCustomMetadata();
+    }
+
     /**
      * Set custom metadata of row
      * @param {number} index - row index