2022-07-04 14:14:55 +00:00
|
|
|
import BaseView from 'app/client/components/BaseView';
|
2022-01-27 17:51:37 +00:00
|
|
|
import {CursorPos} from 'app/client/components/Cursor';
|
|
|
|
import {FilterColValues, LinkingState} from 'app/client/components/LinkingState';
|
|
|
|
import {KoArray} from 'app/client/lib/koArray';
|
|
|
|
import {
|
|
|
|
ColumnRec,
|
|
|
|
DocModel,
|
|
|
|
FilterRec,
|
|
|
|
IRowModel,
|
|
|
|
recordSet,
|
2022-08-08 13:32:50 +00:00
|
|
|
refListRecords,
|
2022-01-27 17:51:37 +00:00
|
|
|
refRecord,
|
|
|
|
TableRec,
|
|
|
|
ViewFieldRec,
|
|
|
|
ViewRec
|
|
|
|
} from 'app/client/models/DocModel';
|
2020-10-02 15:10:00 +00:00
|
|
|
import * as modelUtil from 'app/client/models/modelUtil';
|
2022-01-27 17:51:37 +00:00
|
|
|
import {RowId} from 'app/client/models/rowset';
|
|
|
|
import {LinkConfig} from 'app/client/ui/selectBy';
|
|
|
|
import {getWidgetTypes} from 'app/client/ui/widgetTypes';
|
2022-01-12 13:30:51 +00:00
|
|
|
import {AccessLevel, ICustomWidget} from 'app/common/CustomWidget';
|
2022-01-27 17:51:37 +00:00
|
|
|
import {arrayRepeat} from 'app/common/gutil';
|
|
|
|
import {Sort} from 'app/common/SortSpec';
|
2022-02-08 15:23:14 +00:00
|
|
|
import {ColumnsToMap, WidgetColumnMap} from 'app/plugin/CustomSectionAPI';
|
|
|
|
import {ColumnToMapImpl} from 'app/client/models/ColumnToMap';
|
2022-08-08 13:32:50 +00:00
|
|
|
import {removeRule, RuleOwner} from 'app/client/models/RuleOwner';
|
2022-04-07 15:18:20 +00:00
|
|
|
import {Computed, Holder, Observable} from 'grainjs';
|
2020-10-02 15:10:00 +00:00
|
|
|
import * as ko from 'knockout';
|
|
|
|
import defaults = require('lodash/defaults');
|
|
|
|
|
|
|
|
// Represents a section of user views, now also known as a "page widget" (e.g. a view may contain
|
|
|
|
// a grid section and a chart section).
|
2022-08-08 13:32:50 +00:00
|
|
|
export interface ViewSectionRec extends IRowModel<"_grist_Views_section">, RuleOwner {
|
2020-10-02 15:10:00 +00:00
|
|
|
viewFields: ko.Computed<KoArray<ViewFieldRec>>;
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// All table columns associated with this view section, excluding hidden helper columns.
|
|
|
|
columns: ko.Computed<ColumnRec[]>;
|
|
|
|
|
2020-10-02 15:10:00 +00:00
|
|
|
optionsObj: modelUtil.SaveableObjObservable<any>;
|
|
|
|
|
|
|
|
customDef: CustomViewSectionDef;
|
|
|
|
|
|
|
|
themeDef: modelUtil.KoSaveableObservable<string>;
|
|
|
|
chartTypeDef: modelUtil.KoSaveableObservable<string>;
|
|
|
|
view: ko.Computed<ViewRec>;
|
|
|
|
|
|
|
|
table: ko.Computed<TableRec>;
|
|
|
|
|
2022-04-27 17:46:24 +00:00
|
|
|
// Widget title with a default value
|
2020-10-02 15:10:00 +00:00
|
|
|
titleDef: modelUtil.KoSaveableObservable<string>;
|
2022-04-27 17:46:24 +00:00
|
|
|
// Default widget title (the one that is used in titleDef).
|
|
|
|
defaultWidgetTitle: ko.PureComputed<string>;
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2022-02-07 14:02:26 +00:00
|
|
|
// true if this record is its table's rawViewSection, i.e. a 'raw data view'
|
|
|
|
// in which case the UI prevents various things like hiding columns or changing the widget type.
|
|
|
|
isRaw: ko.Computed<boolean>;
|
|
|
|
|
2020-10-02 15:10:00 +00:00
|
|
|
borderWidthPx: ko.Computed<string>;
|
|
|
|
|
|
|
|
layoutSpecObj: modelUtil.ObjObservable<any>;
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
_savedFilters: ko.Computed<KoArray<FilterRec>>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsaved client-side filters, keyed by original col ref. Currently only wiped when unsaved filters
|
|
|
|
* are applied or reverted.
|
|
|
|
*
|
|
|
|
* If saved filters exist for a col ref, unsaved filters take priority and are applied instead. This
|
|
|
|
* prevents disruption when changes are made to saved filters for the same field/column, but there
|
|
|
|
* may be some cases where we'd want to reset _unsavedFilters on some indirect change to the document.
|
|
|
|
*
|
|
|
|
* NOTE: See `filters`, where `_unsavedFilters` is merged with `savedFilters`.
|
|
|
|
*/
|
|
|
|
_unsavedFilters: Map<number, string>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter information for all fields/section in the section.
|
|
|
|
*
|
|
|
|
* Re-computed on changes to `savedFilters`, as well as any changes to `viewFields` or `columns`. Any
|
|
|
|
* unsaved filters saved in `_unsavedFilters` are applied on computation, taking priority over saved
|
|
|
|
* filters for the same field/column, if any exist.
|
|
|
|
*/
|
|
|
|
filters: ko.Computed<FilterInfo[]>;
|
|
|
|
|
|
|
|
// Subset of `filters` containing non-blank active filters.
|
|
|
|
activeFilters: Computed<FilterInfo[]>;
|
|
|
|
|
|
|
|
// Helper metadata item which indicates whether any of the section's fields/columns have unsaved
|
2020-10-02 15:10:00 +00:00
|
|
|
// changes to their filters. (True indicates unsaved changes)
|
|
|
|
filterSpecChanged: Computed<boolean>;
|
|
|
|
|
|
|
|
// Customizable version of the JSON-stringified sort spec. It may diverge from the saved one.
|
|
|
|
activeSortJson: modelUtil.CustomComputed<string>;
|
|
|
|
|
|
|
|
// is an array (parsed from JSON) of colRefs (i.e. rowIds into the columns table), with a
|
|
|
|
// twist: a rowId may be positive or negative, for ascending or descending respectively.
|
2021-11-03 11:44:28 +00:00
|
|
|
activeSortSpec: modelUtil.ObjObservable<Sort.SortSpec>;
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// Modified sort spec to take into account any active display columns.
|
2021-11-03 11:44:28 +00:00
|
|
|
activeDisplaySortSpec: ko.Computed<Sort.SortSpec>;
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// Evaluates to an array of column models, which are not referenced by anything in viewFields.
|
|
|
|
hiddenColumns: ko.Computed<ColumnRec[]>;
|
|
|
|
|
|
|
|
hasFocus: ko.Computed<boolean>;
|
|
|
|
|
|
|
|
activeLinkSrcSectionRef: modelUtil.CustomComputed<number>;
|
|
|
|
activeLinkSrcColRef: modelUtil.CustomComputed<number>;
|
|
|
|
activeLinkTargetColRef: modelUtil.CustomComputed<number>;
|
|
|
|
|
|
|
|
// Whether current linking state is as saved. It may be different during editing.
|
|
|
|
isActiveLinkSaved: ko.Computed<boolean>;
|
|
|
|
|
|
|
|
// Section-linking affects table if linkSrcSection is set. The controller value of the
|
|
|
|
// link is the value of srcCol at activeRowId of linkSrcSection, or activeRowId itself when
|
|
|
|
// srcCol is unset. If targetCol is set, we filter for all rows whose targetCol is equal to
|
|
|
|
// the controller value. Otherwise, the controller value determines the rowId of the cursor.
|
|
|
|
linkSrcSection: ko.Computed<ViewSectionRec>;
|
|
|
|
linkSrcCol: ko.Computed<ColumnRec>;
|
|
|
|
linkTargetCol: ko.Computed<ColumnRec>;
|
|
|
|
|
2022-01-27 17:51:37 +00:00
|
|
|
// Linking state maintains .filterFunc and .cursorPos observables which we use for
|
|
|
|
// auto-scrolling and filtering.
|
|
|
|
linkingState: ko.Computed<LinkingState | null>;
|
2022-04-07 15:18:20 +00:00
|
|
|
_linkingState: Holder<LinkingState>; // Holder for the current value of linkingState
|
2022-01-27 17:51:37 +00:00
|
|
|
|
|
|
|
linkingFilter: ko.Computed<FilterColValues>;
|
|
|
|
|
|
|
|
activeRowId: ko.Observable<RowId | null>; // May be null when there are no rows.
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// If the view instance for section is instantiated, it will be accessible here.
|
2022-01-27 17:51:37 +00:00
|
|
|
viewInstance: ko.Observable<BaseView | null>;
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// Describes the most recent cursor position in the section. Only rowId and fieldIndex are used.
|
|
|
|
lastCursorPos: CursorPos;
|
|
|
|
|
|
|
|
// Describes the most recent scroll position.
|
|
|
|
lastScrollPos: {
|
|
|
|
rowIndex: number; // Used for scrolly sections. Indicates the index of the first visible row.
|
|
|
|
offset: number; // Pixel distance past the top of row indicated by rowIndex.
|
|
|
|
scrollLeft: number; // Used for grid sections. Indicates the scrollLeft value of the scroll pane.
|
|
|
|
};
|
|
|
|
|
|
|
|
disableAddRemoveRows: ko.Computed<boolean>;
|
|
|
|
|
|
|
|
isSorted: ko.Computed<boolean>;
|
|
|
|
disableDragRows: ko.Computed<boolean>;
|
2021-04-14 15:17:45 +00:00
|
|
|
activeFilterBar: modelUtil.CustomComputed<boolean>;
|
2021-06-18 09:22:27 +00:00
|
|
|
// Number of frozen columns
|
|
|
|
rawNumFrozen: modelUtil.CustomComputed<number>;
|
|
|
|
// Number for frozen columns to display.
|
|
|
|
// We won't freeze all the columns on a grid, it will leave at least 1 column unfrozen.
|
|
|
|
numFrozen: ko.Computed<number>;
|
2022-01-12 13:30:51 +00:00
|
|
|
activeCustomOptions: modelUtil.CustomComputed<any>;
|
2022-02-08 15:23:14 +00:00
|
|
|
|
|
|
|
// Temporary fields used to communicate with the Custom Widget. There are set through the Widget API.
|
|
|
|
|
|
|
|
// Temporary variable holding columns mapping requested by the widget (set by API).
|
|
|
|
columnsToMap: ko.Observable<ColumnsToMap|null>;
|
|
|
|
// Temporary variable holding columns mapped by the user;
|
|
|
|
mappedColumns: ko.Computed<WidgetColumnMap|null>;
|
|
|
|
// Temporary variable holding flag that describes if the widget supports custom options (set by API).
|
2022-01-12 13:30:51 +00:00
|
|
|
hasCustomOptions: ko.Observable<boolean>;
|
2022-02-08 15:23:14 +00:00
|
|
|
// Temporary variable holding widget desired access (changed either from manifest or via API).
|
2022-01-12 13:30:51 +00:00
|
|
|
desiredAccessLevel: ko.Observable<AccessLevel|null>;
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2022-02-01 19:51:40 +00:00
|
|
|
// Show widget as linking source. Used by custom widget.
|
|
|
|
allowSelectBy: Observable<boolean>;
|
|
|
|
|
|
|
|
// List of selected rows
|
|
|
|
selectedRows: Observable<number[]>;
|
|
|
|
|
2022-08-08 13:32:50 +00:00
|
|
|
editingFormula: ko.Computed<boolean>;
|
2022-04-27 17:46:24 +00:00
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Save all filters of fields/columns in the section.
|
2020-10-02 15:10:00 +00:00
|
|
|
saveFilters(): Promise<void>;
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Revert all filters of fields/columns in the section.
|
2020-10-02 15:10:00 +00:00
|
|
|
revertFilters(): void;
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Apply `filter` to the field or column identified by `colRef`.
|
|
|
|
setFilter(colRef: number, filter: string): void;
|
2021-11-26 10:43:55 +00:00
|
|
|
|
|
|
|
// Saves custom definition (bundles change)
|
|
|
|
saveCustomDef(): Promise<void>;
|
2020-10-02 15:10:00 +00:00
|
|
|
}
|
|
|
|
|
2022-02-08 15:23:14 +00:00
|
|
|
export type WidgetMappedColumn = number|number[]|null;
|
|
|
|
export type WidgetColumnMapping = Record<string, WidgetMappedColumn>
|
|
|
|
|
2020-10-02 15:10:00 +00:00
|
|
|
export interface CustomViewSectionDef {
|
|
|
|
/**
|
|
|
|
* The mode.
|
|
|
|
*/
|
2021-11-26 10:43:55 +00:00
|
|
|
mode: modelUtil.KoSaveableObservable<"url"|"plugin">;
|
2020-10-02 15:10:00 +00:00
|
|
|
/**
|
|
|
|
* The url.
|
|
|
|
*/
|
2021-11-26 10:43:55 +00:00
|
|
|
url: modelUtil.KoSaveableObservable<string|null>;
|
|
|
|
/**
|
|
|
|
* Custom widget information.
|
|
|
|
*/
|
|
|
|
widgetDef: modelUtil.KoSaveableObservable<ICustomWidget|null>;
|
2022-01-12 13:30:51 +00:00
|
|
|
/**
|
|
|
|
* Custom widget options.
|
|
|
|
*/
|
|
|
|
widgetOptions: modelUtil.KoSaveableObservable<Record<string, any>|null>;
|
2022-02-08 15:23:14 +00:00
|
|
|
/**
|
|
|
|
* Custom widget interaction options.
|
|
|
|
*/
|
|
|
|
columnsMapping: modelUtil.KoSaveableObservable<WidgetColumnMapping|null>;
|
2020-10-02 15:10:00 +00:00
|
|
|
/**
|
|
|
|
* Access granted to url.
|
|
|
|
*/
|
2021-11-26 10:43:55 +00:00
|
|
|
access: modelUtil.KoSaveableObservable<string>;
|
2020-10-02 15:10:00 +00:00
|
|
|
/**
|
|
|
|
* The plugin id.
|
|
|
|
*/
|
2021-11-26 10:43:55 +00:00
|
|
|
pluginId: modelUtil.KoSaveableObservable<string>;
|
2020-10-02 15:10:00 +00:00
|
|
|
/**
|
|
|
|
* The section id.
|
|
|
|
*/
|
2021-11-26 10:43:55 +00:00
|
|
|
sectionId: modelUtil.KoSaveableObservable<string>;
|
2020-10-02 15:10:00 +00:00
|
|
|
}
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Information about filters for a field or hidden column.
|
|
|
|
export interface FilterInfo {
|
2022-06-23 08:01:12 +00:00
|
|
|
// The field or column associated with this filter info (field if column is visible, else column).
|
2021-11-19 20:30:11 +00:00
|
|
|
fieldOrColumn: ViewFieldRec|ColumnRec;
|
|
|
|
// Filter that applies to this field/column, if any.
|
|
|
|
filter: modelUtil.CustomComputed<string>;
|
|
|
|
// True if `filter` has a non-blank value.
|
|
|
|
isFiltered: ko.PureComputed<boolean>;
|
|
|
|
}
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
export function createViewSectionRec(this: ViewSectionRec, docModel: DocModel): void {
|
|
|
|
this.viewFields = recordSet(this, docModel.viewFields, 'parentId', {sortBy: 'parentPos'});
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// All table columns associated with this view section, excluding any hidden helper columns.
|
|
|
|
this.columns = this.autoDispose(ko.pureComputed(() => this.table().columns().all().filter(c => !c.isHiddenCol())));
|
2022-08-08 13:32:50 +00:00
|
|
|
this.editingFormula = ko.pureComputed({
|
|
|
|
read: () => docModel.editingFormula(),
|
|
|
|
write: val => {
|
|
|
|
docModel.editingFormula(val);
|
|
|
|
}
|
|
|
|
});
|
2020-10-02 15:10:00 +00:00
|
|
|
const defaultOptions = {
|
|
|
|
verticalGridlines: true,
|
|
|
|
horizontalGridlines: true,
|
|
|
|
zebraStripes: false,
|
|
|
|
customView: '',
|
2021-04-14 15:17:45 +00:00
|
|
|
filterBar: false,
|
2021-06-18 09:22:27 +00:00
|
|
|
numFrozen: 0
|
2020-10-02 15:10:00 +00:00
|
|
|
};
|
|
|
|
this.optionsObj = modelUtil.jsonObservable(this.options,
|
|
|
|
(obj: any) => defaults(obj || {}, defaultOptions));
|
|
|
|
|
|
|
|
const customViewDefaults = {
|
|
|
|
mode: 'url',
|
2021-11-26 10:43:55 +00:00
|
|
|
url: null,
|
|
|
|
widgetDef: null,
|
2020-10-02 15:10:00 +00:00
|
|
|
access: '',
|
|
|
|
pluginId: '',
|
|
|
|
sectionId: ''
|
|
|
|
};
|
|
|
|
const customDefObj = modelUtil.jsonObservable(this.optionsObj.prop('customView'),
|
|
|
|
(obj: any) => defaults(obj || {}, customViewDefaults));
|
|
|
|
|
|
|
|
this.customDef = {
|
|
|
|
mode: customDefObj.prop('mode'),
|
|
|
|
url: customDefObj.prop('url'),
|
2021-11-26 10:43:55 +00:00
|
|
|
widgetDef: customDefObj.prop('widgetDef'),
|
2022-01-12 13:30:51 +00:00
|
|
|
widgetOptions: customDefObj.prop('widgetOptions'),
|
2022-02-08 15:23:14 +00:00
|
|
|
columnsMapping: customDefObj.prop('columnsMapping'),
|
2020-10-02 15:10:00 +00:00
|
|
|
access: customDefObj.prop('access'),
|
|
|
|
pluginId: customDefObj.prop('pluginId'),
|
|
|
|
sectionId: customDefObj.prop('sectionId')
|
|
|
|
};
|
|
|
|
|
2022-01-12 13:30:51 +00:00
|
|
|
this.activeCustomOptions = modelUtil.customValue(this.customDef.widgetOptions);
|
|
|
|
|
|
|
|
this.saveCustomDef = async () => {
|
|
|
|
await customDefObj.save();
|
|
|
|
this.activeCustomOptions.revert();
|
2021-11-26 10:43:55 +00:00
|
|
|
};
|
|
|
|
|
2020-10-02 15:10:00 +00:00
|
|
|
this.themeDef = modelUtil.fieldWithDefault(this.theme, 'form');
|
|
|
|
this.chartTypeDef = modelUtil.fieldWithDefault(this.chartType, 'bar');
|
|
|
|
this.view = refRecord(docModel.views, this.parentId);
|
|
|
|
|
|
|
|
this.table = refRecord(docModel.tables, this.tableRef);
|
|
|
|
|
2022-04-27 17:46:24 +00:00
|
|
|
|
|
|
|
// The user-friendly name of the table, which is the same as tableId for non-summary tables,
|
|
|
|
// and is 'tableId[groupByCols...]' for summary tables.
|
|
|
|
// Consist of 3 parts
|
|
|
|
// - TableId (or primary table id for summary tables) capitalized
|
|
|
|
// - Grouping description (table record contains this for summary tables)
|
|
|
|
// - Widget type description (if not grid)
|
|
|
|
// All concatenated separated by space.
|
|
|
|
this.defaultWidgetTitle = this.autoDispose(ko.pureComputed(() => {
|
|
|
|
const widgetTypeDesc = this.parentKey() !== 'record' ? `${getWidgetTypes(this.parentKey.peek() as any).label}` : '';
|
|
|
|
const table = this.table();
|
|
|
|
return [
|
|
|
|
table.tableNameDef()?.toUpperCase(), // Due to ACL this can be null.
|
|
|
|
table.groupDesc(),
|
|
|
|
widgetTypeDesc
|
|
|
|
].filter(part => Boolean(part?.trim())).join(' ');
|
|
|
|
}));
|
|
|
|
// Widget title.
|
|
|
|
this.titleDef = modelUtil.fieldWithDefault(this.title, this.defaultWidgetTitle);
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2022-02-07 14:02:26 +00:00
|
|
|
// true if this record is its table's rawViewSection, i.e. a 'raw data view'
|
|
|
|
// in which case the UI prevents various things like hiding columns or changing the widget type.
|
|
|
|
this.isRaw = this.autoDispose(ko.pureComputed(() => this.table().rawViewSectionRef() === this.getRowId()));
|
|
|
|
|
(core) Speed up and upgrade build.
Summary:
- Upgrades to build-related packages:
- Upgrade typescript, related libraries and typings.
- Upgrade webpack, eslint; add tsc-watch, node-dev, eslint_d.
- Build organization changes:
- Build webpack from original typescript, transpiling only; with errors still
reported by a background tsc watching process.
- Typescript-related changes:
- Reduce imports of AWS dependencies (very noticeable speedup)
- Avoid auto-loading global @types
- Client code is now built with isolatedModules flag (for safe transpilation)
- Use allowJs to avoid copying JS files manually.
- Linting changes
- Enhance Arcanist ESLintLinter to run before/after commands, and set up to use eslint_d
- Update eslint config, and include .eslintignore to avoid linting generated files.
- Include a bunch of eslint-prompted and eslint-generated fixes
- Add no-unused-expression rule to eslint, and fix a few warnings about it
- Other items:
- Refactor cssInput to avoid circular dependency
- Remove a bit of unused code, libraries, dependencies
Test Plan: No behavior changes, all existing tests pass. There are 30 tests fewer reported because `test_gpath.py` was removed (it's been unused for years)
Reviewers: paulfitz
Reviewed By: paulfitz
Subscribers: paulfitz
Differential Revision: https://phab.getgrist.com/D3498
2022-06-27 20:09:41 +00:00
|
|
|
this.borderWidthPx = ko.pureComputed(() => this.borderWidth() + 'px');
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
this.layoutSpecObj = modelUtil.jsonObservable(this.layoutSpec);
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
this._savedFilters = recordSet(this, docModel.filters, 'viewSectionRef');
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
/**
|
|
|
|
* Unsaved client-side filters, keyed by original col ref. Currently only wiped when unsaved filters
|
|
|
|
* are applied or reverted.
|
|
|
|
*
|
|
|
|
* If saved filters exist for a col ref, unsaved filters take priority and are applied instead. This
|
|
|
|
* prevents disruption when changes are made to saved filters for the same field/column, but there
|
|
|
|
* may be some cases where we'd want to reset _unsavedFilters on some indirect change to the document.
|
|
|
|
*
|
|
|
|
* NOTE: See `filters`, where `_unsavedFilters` is merged with `savedFilters`.
|
|
|
|
*/
|
|
|
|
this._unsavedFilters = new Map();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter information for all fields/section in the section.
|
|
|
|
*
|
|
|
|
* Re-computed on changes to `savedFilters`, as well as any changes to `viewFields` or `columns`. Any
|
|
|
|
* unsaved filters saved in `_unsavedFilters` are applied on computation, taking priority over saved
|
|
|
|
* filters for the same field/column, if any exist.
|
|
|
|
*/
|
|
|
|
this.filters = this.autoDispose(ko.computed(() => {
|
|
|
|
const savedFiltersByColRef = new Map(this._savedFilters().all().map(f => [f.colRef(), f]));
|
2022-06-23 08:01:12 +00:00
|
|
|
const viewFieldsByColRef = new Map(this.viewFields().all().map(f => [f.origCol().getRowId(), f]));
|
2021-11-19 20:30:11 +00:00
|
|
|
|
|
|
|
return this.columns().map(column => {
|
|
|
|
const savedFilter = savedFiltersByColRef.get(column.origColRef());
|
|
|
|
const filter = modelUtil.customComputed({
|
|
|
|
// Initialize with a saved filter, if one exists. Otherwise, use a blank filter.
|
|
|
|
read: () => { return savedFilter ? savedFilter.activeFilter() : ''; },
|
|
|
|
});
|
|
|
|
|
|
|
|
// If an unsaved filter exists, overwrite `filter` with it.
|
|
|
|
const unsavedFilter = this._unsavedFilters.get(column.origColRef());
|
|
|
|
if (unsavedFilter !== undefined) { filter(unsavedFilter); }
|
|
|
|
|
|
|
|
return {
|
|
|
|
filter,
|
2022-06-23 08:01:12 +00:00
|
|
|
fieldOrColumn: viewFieldsByColRef.get(column.origColRef()) ?? column,
|
2021-11-19 20:30:11 +00:00
|
|
|
isFiltered: ko.pureComputed(() => filter() !== '')
|
2022-06-23 08:01:12 +00:00
|
|
|
};
|
2021-11-19 20:30:11 +00:00
|
|
|
});
|
|
|
|
}));
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// List of `filters` that have non-blank active filters.
|
|
|
|
this.activeFilters = Computed.create(this, use => use(this.filters).filter(col => use(col.isFiltered)));
|
|
|
|
|
|
|
|
// Helper metadata item which indicates whether any of the section's fields/columns have unsaved
|
|
|
|
// changes to their filters. (True indicates unsaved changes)
|
|
|
|
this.filterSpecChanged = Computed.create(this, use => {
|
|
|
|
return use(this.filters).some(col => !use(col.filter.isSaved));
|
|
|
|
});
|
|
|
|
|
|
|
|
// Save all filters of fields/columns in the section.
|
2020-10-02 15:10:00 +00:00
|
|
|
this.saveFilters = () => {
|
|
|
|
return docModel.docData.bundleActions(`Save all filters in ${this.titleDef()}`,
|
2021-11-19 20:30:11 +00:00
|
|
|
async () => {
|
|
|
|
const savedFiltersByColRef = new Map(this._savedFilters().all().map(f => [f.colRef(), f]));
|
|
|
|
const updatedFilters: [number, string][] = []; // Pairs of row ids and filters to update.
|
|
|
|
const removedFilterIds: number[] = []; // Row ids of filters to remove.
|
|
|
|
const newFilters: [number, string][] = []; // Pairs of column refs and filters to add.
|
|
|
|
|
|
|
|
for (const c of this.filters()) {
|
|
|
|
// Skip saved filters (i.e. filters whose local values are unchanged from server).
|
|
|
|
if (c.filter.isSaved()) { continue; }
|
|
|
|
|
|
|
|
const savedFilter = savedFiltersByColRef.get(c.fieldOrColumn.origCol().origColRef());
|
|
|
|
if (!savedFilter) {
|
|
|
|
// Since no saved filter exists, we must add a new record to the filters table.
|
|
|
|
newFilters.push([c.fieldOrColumn.origCol().origColRef(), c.filter()]);
|
|
|
|
} else if (c.filter() === '') {
|
|
|
|
// Mark the saved filter for removal from the filters table.
|
|
|
|
removedFilterIds.push(savedFilter.id());
|
|
|
|
} else {
|
|
|
|
// Mark the saved filter for update in the filters table.
|
|
|
|
updatedFilters.push([savedFilter.id(), c.filter()]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Remove records of any deleted filters.
|
|
|
|
if (removedFilterIds.length > 0) {
|
|
|
|
await docModel.filters.sendTableAction(['BulkRemoveRecord', removedFilterIds]);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update existing filter records with new filter values.
|
|
|
|
if (updatedFilters.length > 0) {
|
|
|
|
await docModel.filters.sendTableAction(['BulkUpdateRecord',
|
|
|
|
updatedFilters.map(([id]) => id),
|
|
|
|
{filter: updatedFilters.map(([, filter]) => filter)}
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add new filter records.
|
|
|
|
if (newFilters.length > 0) {
|
|
|
|
await docModel.filters.sendTableAction(['BulkAddRecord',
|
|
|
|
arrayRepeat(newFilters.length, null),
|
|
|
|
{
|
|
|
|
viewSectionRef: arrayRepeat(newFilters.length, this.id()),
|
|
|
|
colRef: newFilters.map(([colRef]) => colRef),
|
|
|
|
filter: newFilters.map(([, filter]) => filter),
|
|
|
|
}
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Reset client filter state.
|
|
|
|
this.revertFilters();
|
|
|
|
}
|
2020-10-02 15:10:00 +00:00
|
|
|
);
|
|
|
|
};
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Revert all filters of fields/columns in the section.
|
2020-10-02 15:10:00 +00:00
|
|
|
this.revertFilters = () => {
|
2021-11-19 20:30:11 +00:00
|
|
|
this._unsavedFilters = new Map();
|
|
|
|
this.filters().forEach(c => { c.filter.revert(); });
|
2020-10-02 15:10:00 +00:00
|
|
|
};
|
|
|
|
|
2021-11-19 20:30:11 +00:00
|
|
|
// Apply `filter` to the field or column identified by `colRef`.
|
|
|
|
this.setFilter = (colRef: number, filter: string) => {
|
|
|
|
this._unsavedFilters.set(colRef, filter);
|
|
|
|
const filterInfo = this.filters().find(c => c.fieldOrColumn.origCol().origColRef() === colRef);
|
|
|
|
filterInfo?.filter(filter);
|
|
|
|
};
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// Customizable version of the JSON-stringified sort spec. It may diverge from the saved one.
|
|
|
|
this.activeSortJson = modelUtil.customValue(this.sortColRefs);
|
|
|
|
|
|
|
|
// This is an array (parsed from JSON) of colRefs (i.e. rowIds into the columns table), with a
|
|
|
|
// twist: a rowId may be positive or negative, for ascending or descending respectively.
|
|
|
|
// TODO: This method of ignoring columns which are deleted is inefficient and may cause conflicts
|
|
|
|
// with sharing.
|
2021-11-03 11:44:28 +00:00
|
|
|
this.activeSortSpec = modelUtil.jsonObservable(this.activeSortJson, (obj: Sort.SortSpec|null) => {
|
|
|
|
return (obj || []).filter((sortRef: Sort.ColSpec) => {
|
|
|
|
const colModel = docModel.columns.getRowModel(Sort.getColRef(sortRef));
|
2020-10-02 15:10:00 +00:00
|
|
|
return !colModel._isDeleted() && colModel.getRowId();
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
// Modified sort spec to take into account any active display columns.
|
|
|
|
this.activeDisplaySortSpec = this.autoDispose(ko.computed(() => {
|
|
|
|
return this.activeSortSpec().map(directionalColRef => {
|
2021-11-03 11:44:28 +00:00
|
|
|
const colRef = Sort.getColRef(directionalColRef);
|
2020-10-02 15:10:00 +00:00
|
|
|
const field = this.viewFields().all().find(f => f.column().origColRef() === colRef);
|
|
|
|
const effectiveColRef = field ? field.displayColRef() : colRef;
|
2021-11-03 11:44:28 +00:00
|
|
|
return Sort.swapColRef(directionalColRef, effectiveColRef);
|
2020-10-02 15:10:00 +00:00
|
|
|
});
|
|
|
|
}));
|
|
|
|
|
|
|
|
// Evaluates to an array of column models, which are not referenced by anything in viewFields.
|
|
|
|
this.hiddenColumns = this.autoDispose(ko.pureComputed(() => {
|
|
|
|
const included = new Set(this.viewFields().all().map((f) => f.column().origColRef()));
|
2021-11-19 20:30:11 +00:00
|
|
|
return this.columns().filter(c => !included.has(c.getRowId()));
|
2020-10-02 15:10:00 +00:00
|
|
|
}));
|
|
|
|
|
|
|
|
this.hasFocus = ko.pureComputed({
|
|
|
|
// Read may occur for recently disposed sections, must check condition first.
|
2022-02-03 17:23:53 +00:00
|
|
|
read: () => !this.isDisposed() && this.view().activeSectionId() === this.id(),
|
2020-10-02 15:10:00 +00:00
|
|
|
write: (val) => { if (val) { this.view().activeSectionId(this.id()); } }
|
|
|
|
});
|
|
|
|
|
|
|
|
this.activeLinkSrcSectionRef = modelUtil.customValue(this.linkSrcSectionRef);
|
|
|
|
this.activeLinkSrcColRef = modelUtil.customValue(this.linkSrcColRef);
|
|
|
|
this.activeLinkTargetColRef = modelUtil.customValue(this.linkTargetColRef);
|
|
|
|
|
|
|
|
// Whether current linking state is as saved. It may be different during editing.
|
|
|
|
this.isActiveLinkSaved = this.autoDispose(ko.pureComputed(() =>
|
|
|
|
this.activeLinkSrcSectionRef.isSaved() &&
|
|
|
|
this.activeLinkSrcColRef.isSaved() &&
|
|
|
|
this.activeLinkTargetColRef.isSaved()));
|
|
|
|
|
|
|
|
// Section-linking affects this table if linkSrcSection is set. The controller value of the
|
|
|
|
// link is the value of srcCol at activeRowId of linkSrcSection, or activeRowId itself when
|
|
|
|
// srcCol is unset. If targetCol is set, we filter for all rows whose targetCol is equal to
|
|
|
|
// the controller value. Otherwise, the controller value determines the rowId of the cursor.
|
|
|
|
this.linkSrcSection = refRecord(docModel.viewSections, this.activeLinkSrcSectionRef);
|
|
|
|
this.linkSrcCol = refRecord(docModel.columns, this.activeLinkSrcColRef);
|
|
|
|
this.linkTargetCol = refRecord(docModel.columns, this.activeLinkTargetColRef);
|
|
|
|
|
(core) Speed up and upgrade build.
Summary:
- Upgrades to build-related packages:
- Upgrade typescript, related libraries and typings.
- Upgrade webpack, eslint; add tsc-watch, node-dev, eslint_d.
- Build organization changes:
- Build webpack from original typescript, transpiling only; with errors still
reported by a background tsc watching process.
- Typescript-related changes:
- Reduce imports of AWS dependencies (very noticeable speedup)
- Avoid auto-loading global @types
- Client code is now built with isolatedModules flag (for safe transpilation)
- Use allowJs to avoid copying JS files manually.
- Linting changes
- Enhance Arcanist ESLintLinter to run before/after commands, and set up to use eslint_d
- Update eslint config, and include .eslintignore to avoid linting generated files.
- Include a bunch of eslint-prompted and eslint-generated fixes
- Add no-unused-expression rule to eslint, and fix a few warnings about it
- Other items:
- Refactor cssInput to avoid circular dependency
- Remove a bit of unused code, libraries, dependencies
Test Plan: No behavior changes, all existing tests pass. There are 30 tests fewer reported because `test_gpath.py` was removed (it's been unused for years)
Reviewers: paulfitz
Reviewed By: paulfitz
Subscribers: paulfitz
Differential Revision: https://phab.getgrist.com/D3498
2022-06-27 20:09:41 +00:00
|
|
|
this.activeRowId = ko.observable<RowId|null>(null);
|
2020-10-02 15:10:00 +00:00
|
|
|
|
2022-04-07 15:18:20 +00:00
|
|
|
this._linkingState = Holder.create(this);
|
2022-01-27 17:51:37 +00:00
|
|
|
this.linkingState = this.autoDispose(ko.pureComputed(() => {
|
|
|
|
try {
|
|
|
|
const config = new LinkConfig(this);
|
2022-04-07 15:18:20 +00:00
|
|
|
return LinkingState.create(this._linkingState, docModel, config);
|
2022-01-27 17:51:37 +00:00
|
|
|
} catch (err) {
|
2022-04-07 15:18:20 +00:00
|
|
|
// Dispose old LinkingState in case creating the new one failed.
|
|
|
|
this._linkingState.dispose();
|
2022-01-27 17:51:37 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}));
|
|
|
|
|
|
|
|
this.linkingFilter = this.autoDispose(ko.pureComputed(() => {
|
|
|
|
return this.linkingState()?.filterColValues?.() || {filters: {}, operations: {}};
|
|
|
|
}));
|
|
|
|
|
2020-10-02 15:10:00 +00:00
|
|
|
// If the view instance for this section is instantiated, it will be accessible here.
|
(core) Speed up and upgrade build.
Summary:
- Upgrades to build-related packages:
- Upgrade typescript, related libraries and typings.
- Upgrade webpack, eslint; add tsc-watch, node-dev, eslint_d.
- Build organization changes:
- Build webpack from original typescript, transpiling only; with errors still
reported by a background tsc watching process.
- Typescript-related changes:
- Reduce imports of AWS dependencies (very noticeable speedup)
- Avoid auto-loading global @types
- Client code is now built with isolatedModules flag (for safe transpilation)
- Use allowJs to avoid copying JS files manually.
- Linting changes
- Enhance Arcanist ESLintLinter to run before/after commands, and set up to use eslint_d
- Update eslint config, and include .eslintignore to avoid linting generated files.
- Include a bunch of eslint-prompted and eslint-generated fixes
- Add no-unused-expression rule to eslint, and fix a few warnings about it
- Other items:
- Refactor cssInput to avoid circular dependency
- Remove a bit of unused code, libraries, dependencies
Test Plan: No behavior changes, all existing tests pass. There are 30 tests fewer reported because `test_gpath.py` was removed (it's been unused for years)
Reviewers: paulfitz
Reviewed By: paulfitz
Subscribers: paulfitz
Differential Revision: https://phab.getgrist.com/D3498
2022-06-27 20:09:41 +00:00
|
|
|
this.viewInstance = ko.observable<BaseView|null>(null);
|
2020-10-02 15:10:00 +00:00
|
|
|
|
|
|
|
// Describes the most recent cursor position in the section.
|
|
|
|
this.lastCursorPos = {
|
|
|
|
rowId: 0,
|
|
|
|
fieldIndex: 0
|
|
|
|
};
|
|
|
|
|
|
|
|
// Describes the most recent scroll position.
|
|
|
|
this.lastScrollPos = {
|
|
|
|
rowIndex: 0, // Used for scrolly sections. Indicates the index of the first visible row.
|
|
|
|
offset: 0, // Pixel distance past the top of row indicated by rowIndex.
|
|
|
|
scrollLeft: 0 // Used for grid sections. Indicates the scrollLeft value of the scroll pane.
|
|
|
|
};
|
|
|
|
|
|
|
|
this.disableAddRemoveRows = ko.pureComputed(() => this.table().disableAddRemoveRows());
|
|
|
|
|
|
|
|
this.isSorted = ko.pureComputed(() => this.activeSortSpec().length > 0);
|
|
|
|
this.disableDragRows = ko.pureComputed(() => this.isSorted() || !this.table().supportsManualSort());
|
2021-04-14 15:17:45 +00:00
|
|
|
|
|
|
|
this.activeFilterBar = modelUtil.customValue(this.optionsObj.prop('filterBar'));
|
2021-06-18 09:22:27 +00:00
|
|
|
|
|
|
|
// Number of frozen columns
|
|
|
|
this.rawNumFrozen = modelUtil.customValue(this.optionsObj.prop('numFrozen'));
|
|
|
|
// Number for frozen columns to display
|
|
|
|
this.numFrozen = ko.pureComputed(() =>
|
|
|
|
Math.max(
|
|
|
|
0,
|
|
|
|
Math.min(
|
|
|
|
this.rawNumFrozen(),
|
|
|
|
this.viewFields().all().length - 1
|
|
|
|
)
|
|
|
|
)
|
|
|
|
);
|
2022-01-12 13:30:51 +00:00
|
|
|
|
|
|
|
this.hasCustomOptions = ko.observable(false);
|
(core) Speed up and upgrade build.
Summary:
- Upgrades to build-related packages:
- Upgrade typescript, related libraries and typings.
- Upgrade webpack, eslint; add tsc-watch, node-dev, eslint_d.
- Build organization changes:
- Build webpack from original typescript, transpiling only; with errors still
reported by a background tsc watching process.
- Typescript-related changes:
- Reduce imports of AWS dependencies (very noticeable speedup)
- Avoid auto-loading global @types
- Client code is now built with isolatedModules flag (for safe transpilation)
- Use allowJs to avoid copying JS files manually.
- Linting changes
- Enhance Arcanist ESLintLinter to run before/after commands, and set up to use eslint_d
- Update eslint config, and include .eslintignore to avoid linting generated files.
- Include a bunch of eslint-prompted and eslint-generated fixes
- Add no-unused-expression rule to eslint, and fix a few warnings about it
- Other items:
- Refactor cssInput to avoid circular dependency
- Remove a bit of unused code, libraries, dependencies
Test Plan: No behavior changes, all existing tests pass. There are 30 tests fewer reported because `test_gpath.py` was removed (it's been unused for years)
Reviewers: paulfitz
Reviewed By: paulfitz
Subscribers: paulfitz
Differential Revision: https://phab.getgrist.com/D3498
2022-06-27 20:09:41 +00:00
|
|
|
this.desiredAccessLevel = ko.observable<AccessLevel|null>(null);
|
|
|
|
this.columnsToMap = ko.observable<ColumnsToMap|null>(null);
|
2022-02-08 15:23:14 +00:00
|
|
|
// Calculate mapped columns for Custom Widget.
|
|
|
|
this.mappedColumns = ko.pureComputed(() => {
|
|
|
|
// First check if widget has requested a custom column mapping and
|
|
|
|
// if we have a saved configuration.
|
|
|
|
const request = this.columnsToMap();
|
|
|
|
const mapping = this.customDef.columnsMapping();
|
2022-02-10 12:31:14 +00:00
|
|
|
if (!request || !mapping) {
|
2022-02-08 15:23:14 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
// Convert simple column expressions (widget can just specify a name of a column) to a rich column definition.
|
|
|
|
const columnsToMap = request.map(r => new ColumnToMapImpl(r));
|
|
|
|
const result: WidgetColumnMap = {};
|
|
|
|
// Prepare map of existing column, will need this for translating colRefs to colIds.
|
|
|
|
const colMap = new Map(this.columns().map(f => [f.id.peek(), f]));
|
|
|
|
for(const widgetCol of columnsToMap) {
|
|
|
|
// Start with marking this column as not mapped.
|
|
|
|
result[widgetCol.name] = widgetCol.allowMultiple ? [] : null;
|
|
|
|
const mappedCol = mapping[widgetCol.name];
|
|
|
|
if (!mappedCol) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
if (widgetCol.allowMultiple) {
|
|
|
|
// We expect a list of colRefs be mapped;
|
|
|
|
if (!Array.isArray(mappedCol)) { continue; }
|
|
|
|
result[widgetCol.name] = mappedCol
|
|
|
|
// Remove all colRefs saved but deleted
|
|
|
|
.filter(cId => colMap.has(cId))
|
|
|
|
// And those with wrong type.
|
|
|
|
.filter(cId => widgetCol.canByMapped(colMap.get(cId)!.pureType()))
|
|
|
|
.map(cId => colMap.get(cId)!.colId());
|
|
|
|
} else {
|
|
|
|
// Widget expects a single value and existing column
|
|
|
|
if (Array.isArray(mappedCol) || !colMap.has(mappedCol)) { continue; }
|
|
|
|
const selectedColumn = colMap.get(mappedCol)!;
|
|
|
|
result[widgetCol.name] = widgetCol.canByMapped(selectedColumn.pureType()) ? selectedColumn.colId() : null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
});
|
2022-02-01 19:51:40 +00:00
|
|
|
|
|
|
|
this.allowSelectBy = Observable.create(this, false);
|
|
|
|
this.selectedRows = Observable.create(this, []);
|
2022-08-08 13:32:50 +00:00
|
|
|
|
|
|
|
this.tableId = ko.pureComputed(() => this.table().tableId());
|
|
|
|
const rawSection = ko.pureComputed(() => this.table().rawViewSection());
|
|
|
|
this.rulesCols = refListRecords(docModel.columns, ko.pureComputed(() => rawSection().rules()));
|
|
|
|
this.rulesColsIds = ko.pureComputed(() => this.rulesCols().map(c => c.colId()));
|
|
|
|
this.rulesStyles = modelUtil.savingComputed({
|
|
|
|
read: () => rawSection().optionsObj.prop("rulesOptions")() ?? [],
|
|
|
|
write: (setter, val) => setter(rawSection().optionsObj.prop("rulesOptions"), val)
|
|
|
|
});
|
|
|
|
this.hasRules = ko.pureComputed(() => this.rulesCols().length > 0);
|
|
|
|
this.addEmptyRule = async () => {
|
|
|
|
const action = [
|
|
|
|
'AddEmptyRule',
|
|
|
|
this.tableId.peek(),
|
|
|
|
null,
|
|
|
|
null
|
|
|
|
];
|
|
|
|
await docModel.docData.sendAction(action, `Update rules for ${this.table.peek().tableId.peek()}`);
|
|
|
|
};
|
|
|
|
|
|
|
|
this.removeRule = (index: number) => removeRule(docModel, this, index);
|
2020-10-02 15:10:00 +00:00
|
|
|
}
|