Merge pull request #348 from SandroHc/expose-column-info

Expose column data in Column API
fiduswriter · Nov 20, 2023 · 9943c24 · 9943c24
2 parents a50b924 + 55ea34e
commit 9943c24
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 2 deletions.
diff --git a/docs/demos/dist/module.js b/docs/demos/dist/module.js
diff --git a/docs/demos/dist/module.js.map b/docs/demos/dist/module.js.map
diff --git a/docs/demos/dist/umd.js b/docs/demos/dist/umd.js
diff --git a/docs/documentation/columns-API.md b/docs/documentation/columns-API.md
@@ -12,6 +12,18 @@ You can then chain the following methods.
 
 ---
 
+### `get(column [integer])`
+
+Fetch read-only data about the column at index `column`. The `column` parameter should be a non-zero-based integer.
+
+---
+
+### `size()`
+
+Fetch the number of columns.
+
+---
+
 ### `sort(column [integer], direction [string])`
 
 Sort the selected column. The `column` parameter should be a non-zero-based integer. The `direction` parameter is optional.

diff --git a/src/columns.ts b/src/columns.ts
@@ -20,6 +20,17 @@ export class Columns {
         [this.settings, this._state] = readColumnSettings(this.dt.options.columns, this.dt.options.type, this.dt.options.format)
     }
 
+    get(column: number) {
+        if (column < 0 || column >= this.size()) {
+            return null
+        }
+        return {...this.settings[column]}
+    }
+
+    size() {
+        return this.settings.length
+    }
+
     /**
      * Swap two columns
      */