mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-09-28 23:50:46 +00:00
8f531ef622
Summary: Previously, ref/reflist columns were formatted entirely based on their visible column, since they received values from the visible or display columns rather than the actual row IDs. This creates `ReferenceFormatter` and `ReferenceListFormatter` which still delegate most of the formatting work to a visible column formatter but fix a few issues: - ReferenceList columns now actually use the options (e.g. date format) of the visible column to format their elements. Previously they were formatted generically because the visible column formatter wasn't expecting a list. - Invalid references aren't formatted with an `#Invalid Ref` prefix. - When the ref column displays the Row ID, it doesn't have a visible or display column. Previously this led to the references being formatted as just numbers in most cases, with special code in the widget to display them like `Table1[2]`. Now they are consistently formatted in that style throughout. Test Plan: Updated existing tests. Reviewers: jarek Reviewed By: jarek Subscribers: dsagal Differential Revision: https://phab.getgrist.com/D3212
55 lines
1.9 KiB
TypeScript
55 lines
1.9 KiB
TypeScript
import {DocData} from 'app/client/models/DocData';
|
|
import {ColumnRec} from 'app/client/models/entities/ColumnRec';
|
|
import {ViewFieldRec} from 'app/client/models/entities/ViewFieldRec';
|
|
import {TableData} from 'app/client/models/TableData';
|
|
import {getReferencedTableId, isRefListType} from 'app/common/gristTypes';
|
|
import {BaseFormatter} from 'app/common/ValueFormatter';
|
|
|
|
/**
|
|
* Utilities for common operations involving Ref[List] fields.
|
|
*/
|
|
export class ReferenceUtils {
|
|
public readonly refTableId: string;
|
|
public readonly tableData: TableData;
|
|
public readonly visibleColFormatter: BaseFormatter;
|
|
public readonly visibleColModel: ColumnRec;
|
|
public readonly visibleColId: string;
|
|
public readonly isRefList: boolean;
|
|
|
|
constructor(public readonly field: ViewFieldRec, docData: DocData) {
|
|
const colType = field.column().type();
|
|
const refTableId = getReferencedTableId(colType);
|
|
if (!refTableId) {
|
|
throw new Error("Non-Reference column of type " + colType);
|
|
}
|
|
this.refTableId = refTableId;
|
|
|
|
const tableData = docData.getTable(refTableId);
|
|
if (!tableData) {
|
|
throw new Error("Invalid referenced table " + refTableId);
|
|
}
|
|
this.tableData = tableData;
|
|
|
|
this.visibleColFormatter = field.visibleColFormatter();
|
|
this.visibleColModel = field.visibleColModel();
|
|
this.visibleColId = this.visibleColModel.colId() || 'id';
|
|
this.isRefList = isRefListType(colType);
|
|
}
|
|
|
|
public idToText(value: unknown) {
|
|
if (typeof value === 'number') {
|
|
return this.visibleColFormatter.formatAny(this.tableData.getValue(value, this.visibleColId));
|
|
}
|
|
return String(value || '');
|
|
}
|
|
|
|
public autocompleteSearch(text: string) {
|
|
const acIndex = this.tableData.columnACIndexes.getColACIndex(this.visibleColId, this.visibleColFormatter);
|
|
return acIndex.search(text);
|
|
}
|
|
}
|
|
|
|
export function nocaseEqual(a: string, b: string) {
|
|
return a.trim().toLowerCase() === b.trim().toLowerCase();
|
|
}
|