fordocumentation for option formulas

Author: RafaelGB

docs/docs/features/Formulas.md

@@ -25,6 +25,22 @@ If you are using a column formula, you can also use the following variables:
 In case you are using a footer formula, you can also use the following variables:
 - `values` : An Array of cell values in the column
 
+#### Options Formula
+The options formula is a special case. It is used to generate the options for a column with the type `select` or `tag`. The formula must return an array of objects with the following structure:
+
+```javascript
+{
+    value: "value",
+    label: "label"
+    color: "color" // HSL, RGB, HEX, or color name but with string representation
+}
+```
+Due the nature of the formula, the variables are called directly instead of using the `${}` syntax. For example, to get a value of the `db`, you can use `db.js.myOptionsFormula()`.
+
+You can also use the following variables:
+- `column` : Object with the column information
+
+
 ### Exposed Functions
 
 The root object `db` has the following functions:

docs/examples/optionFormulas/tagsAsOptions.js

@@ -0,0 +1,19 @@
+/**
+ * Generate a list of options in function of the tags of Obsidian
+ * 
+ * Formula: ${db.js.tagsAsOptions(db)}
+ */
+function tagsAsOptions(db) {
+    options = [];
+    tagArray = app.metadataCache.getTags(); // Record<string, number>
+    Object.keys(tagArray).forEach(tag => {
+        options.push({
+            value: tag,
+            label: tag.slice(1),
+            color: db.colors.randomColor()
+        })
+    });
+    return options;
+}
+
+module.exports = tagsAsOptions

src/components/modals/columnSettings/handlers/selects/FormulaColumnOptionsHandler.ts

@@ -4,6 +4,7 @@ import { c } from "helpers/StylesHelper";
 import { t } from "lang/helpers";
 import { Notice, Setting } from "obsidian";
 import { AbstractHandlerClass } from "patterns/chain/AbstractHandler";
+import { Db } from "services/CoreService";
 import { FormulaService } from "services/FormulaService";
 
 export class FormulaColumnOptionsHandler extends AbstractHandlerClass<ColumnSettingsHandlerResponse> {
@@ -36,6 +37,7 @@ export class FormulaColumnOptionsHandler extends AbstractHandlerClass<ColumnSett
                         .setTooltip("column_settings_modal_formula_option_source_placeholder")
                         .onClick(async (): Promise<void> => {
                             try {
+                                column.config.formula_option_source = currentFormula;
                                 columnHandlerResponse.column.options = FormulaService.evalOptionsWith(column, automationState.info.getFormulas());
                             } catch (e) {
                                 new Notice("Error in formula: " + e);
@@ -79,6 +81,7 @@ export class FormulaColumnOptionsHandler extends AbstractHandlerClass<ColumnSett
                 const tr = tbody.createEl("tr");
                 tr.addClass(c("center-cell"));
                 tr.style.backgroundColor = option.color;
+                tr.style.color = Db.coreFns.colors.getContrast(option.color);
                 // td centering text
                 tr.createEl("td", {
                     text: option.label,

src/services/CoreService.ts

@@ -33,7 +33,7 @@ class CoreService {
 
     /**
      * Singleton instance
-     * @returns {VaultManager}
+     * @returns {CoreService}
      */
     public static getInstance(): CoreService {
         if (!this.instance) {