mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
b1c3943bf4
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/D3282
91 lines
2.8 KiB
TypeScript
91 lines
2.8 KiB
TypeScript
/**
|
|
* NewAbstractWidget is equivalent to AbstractWidget for outside code, but is in typescript, and
|
|
* so is friendlier and clearer to derive TypeScript classes from.
|
|
*/
|
|
import {DocComm} from 'app/client/components/DocComm';
|
|
import {GristDoc} from 'app/client/components/GristDoc';
|
|
import {DocData} from 'app/client/models/DocData';
|
|
import {ViewFieldRec} from 'app/client/models/entities/ViewFieldRec';
|
|
import {SaveableObjObservable} from 'app/client/models/modelUtil';
|
|
import {CellStyle} from 'app/client/widgets/CellStyle';
|
|
import {BaseFormatter} from 'app/common/ValueFormatter';
|
|
import {
|
|
Disposable,
|
|
dom,
|
|
DomContents,
|
|
fromKo,
|
|
Observable,
|
|
} from 'grainjs';
|
|
|
|
export interface Options {
|
|
// A hex value to set the default widget text color. Default to '#000000' if omitted.
|
|
defaultTextColor?: string;
|
|
}
|
|
|
|
/**
|
|
* NewAbstractWidget - The base of the inheritance tree for widgets.
|
|
* @param {Function} field - The RowModel for this view field.
|
|
*/
|
|
export abstract class NewAbstractWidget extends Disposable {
|
|
/**
|
|
* Override the create() method to match the parameters of create() expected by FieldBuilder.
|
|
*/
|
|
public static create(field: ViewFieldRec) {
|
|
return Disposable.create.call(this as any, null, field);
|
|
}
|
|
|
|
protected options: SaveableObjObservable<any>;
|
|
protected valueFormatter: Observable<BaseFormatter>;
|
|
protected textColor: Observable<string>;
|
|
protected fillColor: Observable<string>;
|
|
protected readonly defaultTextColor: string;
|
|
|
|
constructor(protected field: ViewFieldRec, opts: Options = {}) {
|
|
super();
|
|
const {defaultTextColor = '#000000'} = opts;
|
|
this.defaultTextColor = defaultTextColor;
|
|
this.options = field.widgetOptionsJson;
|
|
this.valueFormatter = fromKo(field.formatter);
|
|
}
|
|
|
|
/**
|
|
* Builds the DOM showing configuration buttons and fields in the sidebar.
|
|
*/
|
|
public buildConfigDom(): DomContents {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Builds the transform prompt config DOM in the few cases where it is necessary.
|
|
* Child classes need not override this function if they do not require transform config options.
|
|
*/
|
|
public buildTransformConfigDom(): DomContents {
|
|
return null;
|
|
}
|
|
|
|
public buildColorConfigDom(gristDoc: GristDoc): DomContents {
|
|
return dom.create(CellStyle, this.field, gristDoc, this.defaultTextColor);
|
|
}
|
|
|
|
/**
|
|
* Builds the data cell DOM.
|
|
* @param {DataRowModel} row - The rowModel object.
|
|
*/
|
|
public abstract buildDom(row: any): Element;
|
|
|
|
/**
|
|
* Returns the DocData object to which this field belongs.
|
|
*/
|
|
protected _getDocData(): DocData {
|
|
// TODO: There should be a better way to access docData and docComm, or better yet GristDoc.
|
|
return this.field._table.tableData.docData;
|
|
}
|
|
|
|
/**
|
|
* Returns the docComm object for communicating with the server.
|
|
*/
|
|
protected _getDocComm(): DocComm {
|
|
return this._getDocData().docComm;
|
|
}
|
|
}
|