Summary: Adding conditional formatting rules feature. Each column can have multiple styling rules which are applied in order when evaluated to a truthy value. - The creator panel has a new section: Cell Style - New user action AddEmptyRule for adding an empty rule - New columns in _grist_Table_columns and fields A new color picker will be introduced in a follow-up diff (as it is also used in choice/choice list/filters). Design document: https://grist.quip.com/FVzfAgoO5xOF/Conditional-Formatting-Implementation-Design Test Plan: new tests Reviewers: georgegevoian Reviewed By: georgegevoian Subscribers: alexmojaki Differential Revision: https://phab.getgrist.com/D3282pull/176/head
Jarosław Sadziński
2 years ago
parent
96a34122a5
commit
b1c3943bf4
@ -0,0 +1,19 @@
|
||||
export interface Style {
|
||||
textColor?: string;
|
||||
fillColor?: string;
|
||||
}
|
||||
|
||||
export class CombinedStyle implements Style {
|
||||
public readonly textColor?: string;
|
||||
public readonly fillColor?: string;
|
||||
constructor(rules: Style[], flags: any[]) {
|
||||
for (let i = 0; i < rules.length; i++) {
|
||||
if (flags[i]) {
|
||||
const textColor = rules[i].textColor;
|
||||
const fillColor = rules[i].fillColor;
|
||||
this.textColor = textColor || this.textColor;
|
||||
this.fillColor = fillColor || this.fillColor;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,239 @@
|
||||
import {GristDoc} from 'app/client/components/GristDoc';
|
||||
import {ColumnRec} from 'app/client/models/DocModel';
|
||||
import {ViewFieldRec} from 'app/client/models/entities/ViewFieldRec';
|
||||
import {KoSaveableObservable} from 'app/client/models/modelUtil';
|
||||
import {Style} from 'app/client/models/Styles';
|
||||
import {cssFieldFormula} from 'app/client/ui/FieldConfig';
|
||||
import {cssIcon, cssLabel, cssRow} from 'app/client/ui/RightPanel';
|
||||
import {textButton} from 'app/client/ui2018/buttons';
|
||||
import {colorSelect} from 'app/client/ui2018/ColorSelect';
|
||||
import {colors} from 'app/client/ui2018/cssVars';
|
||||
import {setupEditorCleanup} from 'app/client/widgets/FieldEditor';
|
||||
import {cssError, openFormulaEditor} from 'app/client/widgets/FormulaEditor';
|
||||
import {isRaisedException, isValidRuleValue} from 'app/common/gristTypes';
|
||||
import {RowRecord} from 'app/plugin/GristData';
|
||||
import {Computed, Disposable, dom, DomContents, fromKo, makeTestId, MultiHolder, Observable, styled} from 'grainjs';
|
||||
import debounce = require('lodash/debounce');
|
||||
|
||||
const testId = makeTestId('test-widget-style-');
|
||||
|
||||
export class CellStyle extends Disposable {
|
||||
protected textColor: Observable<string>;
|
||||
protected fillColor: Observable<string>;
|
||||
// Holds data from currently selected record (holds data only when this field has conditional styles).
|
||||
protected currentRecord: Computed<RowRecord | undefined>;
|
||||
// Helper field for refreshing current record data.
|
||||
protected dataChangeTrigger = Observable.create(this, 0);
|
||||
|
||||
constructor(
|
||||
protected field: ViewFieldRec,
|
||||
protected gristDoc: GristDoc,
|
||||
defaultTextColor: string = '#000000'
|
||||
) {
|
||||
super();
|
||||
this.textColor = Computed.create(
|
||||
this,
|
||||
use => use(this.field.textColor) || defaultTextColor
|
||||
).onWrite(val => this.field.textColor(val === defaultTextColor ? '' : val));
|
||||
this.fillColor = fromKo(this.field.fillColor);
|
||||
this.currentRecord = Computed.create(this, use => {
|
||||
if (!use(this.field.hasRules)) {
|
||||
return;
|
||||
}
|
||||
// As we are not subscribing to data change, we will monitor actions
|
||||
// that are sent from the server to refresh this computed observable.
|
||||
void use(this.dataChangeTrigger);
|
||||
const tableId = use(use(use(field.column).table).tableId);
|
||||
const tableData = gristDoc.docData.getTable(tableId)!;
|
||||
const cursor = use(gristDoc.cursorPosition);
|
||||
// Make sure we are not on the new row.
|
||||
if (!cursor || typeof cursor.rowId !== 'number') {
|
||||
return undefined;
|
||||
}
|
||||
return tableData.getRecord(cursor.rowId);
|
||||
});
|
||||
|
||||
// Here we will subscribe to tableActionEmitter, and update currentRecord observable.
|
||||
// We have 'dataChangeTrigger' that is just a number that will be updated every time
|
||||
// we received some table actions.
|
||||
const debouncedUpdate = debounce(() => {
|
||||
if (this.dataChangeTrigger.isDisposed()) {
|
||||
return;
|
||||
}
|
||||
this.dataChangeTrigger.set(this.dataChangeTrigger.get() + 1);
|
||||
}, 0);
|
||||
Computed.create(this, (use) => {
|
||||
const tableId = use(use(use(field.column).table).tableId);
|
||||
const tableData = gristDoc.docData.getTable(tableId);
|
||||
return tableData ? use.owner.autoDispose(tableData.tableActionEmitter.addListener(debouncedUpdate)) : null;
|
||||
});
|
||||
}
|
||||
|
||||
public buildDom(): DomContents {
|
||||
const holder = new MultiHolder();
|
||||
return [
|
||||
cssLabel('CELL STYLE', dom.autoDispose(holder)),
|
||||
cssRow(
|
||||
colorSelect(
|
||||
this.textColor,
|
||||
this.fillColor,
|
||||
// Calling `field.widgetOptionsJson.save()` saves both fill and text color settings.
|
||||
() => this.field.widgetOptionsJson.save()
|
||||
)
|
||||
),
|
||||
cssRow(
|
||||
{style: 'margin-top: 16px'},
|
||||
textButton(
|
||||
'Add conditional style',
|
||||
testId('add-conditional-style'),
|
||||
dom.on('click', () => this.field.addEmptyRule())
|
||||
),
|
||||
dom.hide(this.field.hasRules)
|
||||
),
|
||||
dom.domComputedOwned(
|
||||
use => use(this.field.rulesCols),
|
||||
(owner, rules) =>
|
||||
cssRuleList(
|
||||
dom.show(rules.length > 0),
|
||||
...rules.map((column, ruleIndex) => {
|
||||
const textColor = this._buildStyleOption(owner, ruleIndex, 'textColor');
|
||||
const fillColor = this._buildStyleOption(owner, ruleIndex, 'fillColor');
|
||||
const save = async () => {
|
||||
// This will save both options.
|
||||
await this.field.rulesStyles.save();
|
||||
};
|
||||
const currentValue = Computed.create(owner, use => {
|
||||
const record = use(this.currentRecord);
|
||||
if (!record) {
|
||||
return false;
|
||||
}
|
||||
const value = record[use(column.colId)];
|
||||
return value;
|
||||
});
|
||||
const hasError = Computed.create(owner, use => {
|
||||
return !isValidRuleValue(use(currentValue));
|
||||
});
|
||||
const errorMessage = Computed.create(owner, use => {
|
||||
const value = use(currentValue);
|
||||
return (!use(hasError) ? '' :
|
||||
isRaisedException(value) ? 'Error in style rule' :
|
||||
'Rule must return True or False');
|
||||
});
|
||||
return dom('div',
|
||||
testId(`conditional-rule-${ruleIndex}`),
|
||||
testId(`conditional-rule`), // for testing
|
||||
cssLineLabel('IF...'),
|
||||
cssColumnsRow(
|
||||
cssLeftColumn(
|
||||
this._buildRuleFormula(column.formula, column, hasError),
|
||||
cssRuleError(
|
||||
dom.text(errorMessage),
|
||||
dom.show(hasError),
|
||||
testId(`rule-error-${ruleIndex}`),
|
||||
),
|
||||
colorSelect(textColor, fillColor, save, true)
|
||||
),
|
||||
cssRemoveButton(
|
||||
'Remove',
|
||||
testId(`remove-rule-${ruleIndex}`),
|
||||
dom.on('click', () => this.field.removeRule(ruleIndex))
|
||||
)
|
||||
)
|
||||
);
|
||||
})
|
||||
)
|
||||
),
|
||||
cssRow(
|
||||
textButton('Add another rule'),
|
||||
testId('add-another-rule'),
|
||||
dom.on('click', () => this.field.addEmptyRule()),
|
||||
dom.show(this.field.hasRules)
|
||||
),
|
||||
];
|
||||
}
|
||||
|
||||
private _buildStyleOption(owner: Disposable, index: number, option: keyof Style) {
|
||||
const obs = Computed.create(owner, use => use(this.field.rulesStyles)[index]?.[option]);
|
||||
obs.onWrite(value => {
|
||||
const list = Array.from(this.field.rulesStyles.peek() ?? []);
|
||||
list[index] = list[index] ?? {};
|
||||
list[index][option] = value;
|
||||
this.field.rulesStyles(list);
|
||||
});
|
||||
return obs;
|
||||
}
|
||||
|
||||
private _buildRuleFormula(
|
||||
formula: KoSaveableObservable<string>,
|
||||
column: ColumnRec,
|
||||
hasError: Observable<boolean>
|
||||
) {
|
||||
return cssFieldFormula(
|
||||
formula,
|
||||
{maxLines: 1},
|
||||
dom.cls('formula_field_sidepane'),
|
||||
dom.cls(cssErrorBorder.className, hasError),
|
||||
{tabIndex: '-1'},
|
||||
dom.on('focus', (_, refElem) => {
|
||||
const vsi = this.gristDoc.viewModel.activeSection().viewInstance();
|
||||
const editorHolder = openFormulaEditor({
|
||||
gristDoc: this.gristDoc,
|
||||
field: this.field,
|
||||
column,
|
||||
editRow: vsi?.moveEditRowToCursor(),
|
||||
refElem,
|
||||
setupCleanup: setupEditorCleanup,
|
||||
});
|
||||
// Add editor to document holder - this will prevent multiple formula editor instances.
|
||||
this.gristDoc.fieldEditorHolder.autoDispose(editorHolder);
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const cssRemoveButton = styled(cssIcon, `
|
||||
flex: none;
|
||||
margin: 6px;
|
||||
margin-right: 0px;
|
||||
transform: translateY(4px);
|
||||
cursor: pointer;
|
||||
--icon-color: ${colors.slate};
|
||||
&:hover {
|
||||
--icon-color: ${colors.lightGreen};
|
||||
}
|
||||
`);
|
||||
|
||||
const cssLineLabel = styled(cssLabel, `
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0px;
|
||||
`);
|
||||
|
||||
const cssRuleList = styled('div', `
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 12px;
|
||||
margin-top: 16px;
|
||||
margin-bottom: 12px;
|
||||
`);
|
||||
|
||||
const cssErrorBorder = styled('div', `
|
||||
border-color: ${colors.error};
|
||||
`);
|
||||
|
||||
const cssRuleError = styled(cssError, `
|
||||
margin: 2px 0px 10px 0px;
|
||||
`);
|
||||
|
||||
const cssColumnsRow = styled(cssRow, `
|
||||
align-items: flex-start;
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0px;
|
||||
`);
|
||||
|
||||
const cssLeftColumn = styled('div', `
|
||||
overflow: hidden;
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 4px;
|
||||
`);
|
||||
@ -0,0 +1,192 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
import testutil
|
||||
import test_engine
|
||||
|
||||
|
||||
class TestRules(test_engine.EngineTestCase):
|
||||
sample = testutil.parse_test_sample({
|
||||
"SCHEMA": [
|
||||
[1, "Inventory", [
|
||||
[2, "Label", "Text", False, "", "", ""],
|
||||
[3, "Stock", "Int", False, "", "", ""],
|
||||
]],
|
||||
],
|
||||
"DATA": {
|
||||
"Inventory": [
|
||||
["id", "Label", "Stock"],
|
||||
[1, "A1", 0],
|
||||
[2, "A2", 2],
|
||||
[3, "A3", 5],
|
||||
# Duplicate
|
||||
[4, "A1", 10]
|
||||
],
|
||||
}
|
||||
})
|
||||
|
||||
# Helper for rules action
|
||||
def add_empty(self, col_id):
|
||||
return self.apply_user_action(['AddEmptyRule', "Inventory", 0, col_id])
|
||||
|
||||
def field_add_empty(self, field_id):
|
||||
return self.apply_user_action(['AddEmptyRule', "Inventory", field_id, 0])
|
||||
|
||||
def set_rule(self, col_id, rule_index, formula):
|
||||
rules = self.engine.docmodel.columns.table.get_record(col_id).rules
|
||||
rule = list(rules)[rule_index]
|
||||
return self.apply_user_action(['UpdateRecord', '_grist_Tables_column',
|
||||
rule.id, {"formula": formula}])
|
||||
|
||||
def field_set_rule(self, field_id, rule_index, formula):
|
||||
rules = self.engine.docmodel.view_fields.table.get_record(field_id).rules
|
||||
rule = list(rules)[rule_index]
|
||||
return self.apply_user_action(['UpdateRecord', '_grist_Tables_column',
|
||||
rule.id, {"formula": formula}])
|
||||
|
||||
def remove_rule(self, col_id, rule_index):
|
||||
rules = self.engine.docmodel.columns.table.get_record(col_id).rules
|
||||
rule = list(rules)[rule_index]
|
||||
return self.apply_user_action(['RemoveColumn', 'Inventory', rule.colId])
|
||||
|
||||
def field_remove_rule(self, field_id, rule_index):
|
||||
rules = self.engine.docmodel.view_fields.table.get_record(field_id).rules
|
||||
rule = list(rules)[rule_index]
|
||||
return self.apply_user_action(['RemoveColumn', 'Inventory', rule.colId])
|
||||
|
||||
def test_simple_rules(self):
|
||||
self.load_sample(self.sample)
|
||||
# Mark all records with Stock = 0
|
||||
out_actions = self.add_empty(3)
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["AddColumn", "Inventory", "gristHelper_ConditionalRule",
|
||||
{"formula": "", "isFormula": True, "type": "Any"}],
|
||||
["AddRecord", "_grist_Tables_column", 4,
|
||||
{"colId": "gristHelper_ConditionalRule", "formula": "", "isFormula": True,
|
||||
"label": "gristHelper_ConditionalRule", "parentId": 1, "parentPos": 3.0,
|
||||
"type": "Any",
|
||||
"widgetOptions": ""}],
|
||||
["UpdateRecord", "_grist_Tables_column", 3, {"rules": ["L", 4]}],
|
||||
]})
|
||||
out_actions = self.set_rule(3, 0, "$Stock == 0")
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["ModifyColumn", "Inventory", "gristHelper_ConditionalRule",
|
||||
{"formula": "$Stock == 0"}],
|
||||
["UpdateRecord", "_grist_Tables_column", 4, {"formula": "$Stock == 0"}],
|
||||
["BulkUpdateRecord", "Inventory", [1, 2, 3, 4],
|
||||
{"gristHelper_ConditionalRule": [True, False, False, False]}],
|
||||
]})
|
||||
|
||||
# Replace this rule with another rule to mark Stock = 2
|
||||
out_actions = self.set_rule(3, 0, "$Stock == 2")
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["ModifyColumn", "Inventory", "gristHelper_ConditionalRule",
|
||||
{"formula": "$Stock == 2"}],
|
||||
["UpdateRecord", "_grist_Tables_column", 4, {"formula": "$Stock == 2"}],
|
||||
["BulkUpdateRecord", "Inventory", [1, 2],
|
||||
{"gristHelper_ConditionalRule": [False, True]}],
|
||||
]})
|
||||
|
||||
# Add another rule Stock = 10
|
||||
out_actions = self.add_empty(3)
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["AddColumn", "Inventory", "gristHelper_ConditionalRule2",
|
||||
{"formula": "", "isFormula": True, "type": "Any"}],
|
||||
["AddRecord", "_grist_Tables_column", 5,
|
||||
{"colId": "gristHelper_ConditionalRule2", "formula": "", "isFormula": True,
|
||||
"label": "gristHelper_ConditionalRule2", "parentId": 1, "parentPos": 4.0,
|
||||
"type": "Any",
|
||||
"widgetOptions": ""}],
|
||||
["UpdateRecord", "_grist_Tables_column", 3, {"rules": ["L", 4, 5]}],
|
||||
]})
|
||||
out_actions = self.set_rule(3, 1, "$Stock == 10")
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["ModifyColumn", "Inventory", "gristHelper_ConditionalRule2",
|
||||
{"formula": "$Stock == 10"}],
|
||||
["UpdateRecord", "_grist_Tables_column", 5, {"formula": "$Stock == 10"}],
|
||||
["BulkUpdateRecord", "Inventory", [1, 2, 3, 4],
|
||||
{"gristHelper_ConditionalRule2": [False, False, False, True]}],
|
||||
]})
|
||||
|
||||
# Remove the last rule
|
||||
out_actions = self.remove_rule(3, 1)
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["RemoveRecord", "_grist_Tables_column", 5],
|
||||
["UpdateRecord", "_grist_Tables_column", 3, {"rules": ["L", 4]}],
|
||||
["RemoveColumn", "Inventory", "gristHelper_ConditionalRule2"]
|
||||
]})
|
||||
|
||||
# Remove last rule
|
||||
out_actions = self.remove_rule(3, 0)
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["RemoveRecord", "_grist_Tables_column", 4],
|
||||
["UpdateRecord", "_grist_Tables_column", 3, {"rules": None}],
|
||||
["RemoveColumn", "Inventory", "gristHelper_ConditionalRule"]
|
||||
]})
|
||||
|
||||
def test_duplicates(self):
|
||||
self.load_sample(self.sample)
|
||||
|
||||
# Create rule that marks duplicate values
|
||||
formula = "len(Inventory.lookupRecords(Label=$Label)) > 1"
|
||||
|
||||
# First add rule on stock column, to test naming - second rule column should have 2 as a suffix
|
||||
self.add_empty(3)
|
||||
self.set_rule(3, 0, "$Stock == 0")
|
||||
# Now highlight duplicates on labels
|
||||
self.add_empty(2)
|
||||
out_actions = self.set_rule(2, 0, formula)
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["ModifyColumn", "Inventory", "gristHelper_ConditionalRule2",
|
||||
{"formula": "len(Inventory.lookupRecords(Label=$Label)) > 1"}],
|
||||
["UpdateRecord", "_grist_Tables_column", 5,
|
||||
{"formula": "len(Inventory.lookupRecords(Label=$Label)) > 1"}],
|
||||
["BulkUpdateRecord", "Inventory", [1, 2, 3, 4],
|
||||
{"gristHelper_ConditionalRule2": [True, False, False, True]}]
|
||||
]})
|
||||
|
||||
def test_column_removal(self):
|
||||
# Test that rules are removed with a column.
|
||||
|
||||
self.load_sample(self.sample)
|
||||
self.add_empty(3)
|
||||
self.set_rule(3, 0, "$Stock == 0")
|
||||
before = self.engine.docmodel.columns.lookupOne(colId='gristHelper_ConditionalRule')
|
||||
self.assertNotEqual(before, 0)
|
||||
out_actions = self.apply_user_action(['RemoveColumn', 'Inventory', 'Stock'])
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["BulkRemoveRecord", "_grist_Tables_column", [3, 4]],
|
||||
["RemoveColumn", "Inventory", "Stock"],
|
||||
["RemoveColumn", "Inventory", "gristHelper_ConditionalRule"],
|
||||
]})
|
||||
|
||||
def test_column_removal_for_a_field(self):
|
||||
# Test that rules are removed with a column when attached to a field.
|
||||
|
||||
self.load_sample(self.sample)
|
||||
self.apply_user_action(['CreateViewSection', 1, 0, 'record', None])
|
||||
self.field_add_empty(2)
|
||||
self.field_set_rule(2, 0, "$Stock == 0")
|
||||
before = self.engine.docmodel.columns.lookupOne(colId='gristHelper_ConditionalRule')
|
||||
self.assertNotEqual(before, 0)
|
||||
out_actions = self.apply_user_action(['RemoveColumn', 'Inventory', 'Stock'])
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["RemoveRecord", "_grist_Views_section_field", 2],
|
||||
["BulkRemoveRecord", "_grist_Tables_column", [3, 4]],
|
||||
["RemoveColumn", "Inventory", "Stock"],
|
||||
["RemoveColumn", "Inventory", "gristHelper_ConditionalRule"],
|
||||
]})
|
||||
|
||||
def test_field_removal(self):
|
||||
# Test that rules are removed with a field.
|
||||
|
||||
self.load_sample(self.sample)
|
||||
self.apply_user_action(['CreateViewSection', 1, 0, 'record', None])
|
||||
self.field_add_empty(2)
|
||||
self.field_set_rule(2, 0, "$Stock == 0")
|
||||
rule_id = self.engine.docmodel.columns.lookupOne(colId='gristHelper_ConditionalRule').id
|
||||
self.assertNotEqual(rule_id, 0)
|
||||
out_actions = self.apply_user_action(['RemoveRecord', '_grist_Views_section_field', 2])
|
||||
self.assertPartialOutActions(out_actions, {"stored": [
|
||||
["RemoveRecord", "_grist_Views_section_field", 2],
|
||||
["RemoveRecord", "_grist_Tables_column", rule_id],
|
||||
["RemoveColumn", "Inventory", "gristHelper_ConditionalRule"]
|
||||
]})
|
||||
Binary file not shown.
Loading…
Reference in new issue