aboutsummaryrefslogtreecommitdiff
path: root/src/client/views/FilterPanel.tsx
blob: a3c4350d95c53a4f9e6e9ea1736b3a5eab135d4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
import * as React from 'react';
import { action, computed, observable, ObservableMap } from 'mobx';
import { observer } from 'mobx-react';
import { Handles, Rail, Slider, Ticks, Tracks } from 'react-compound-slider';
import { AiOutlineMinusSquare, AiOutlinePlusSquare } from 'react-icons/ai';
import { CiCircleRemove } from 'react-icons/ci';
import Select from 'react-select';
import { Doc, DocListCast, Field, LinkedTo, StrListCast } from '../../fields/Doc';
import { RichTextField } from '../../fields/RichTextField';
import { DocOptions, DocumentOptions, FInfo } from '../documents/Documents';
import { DocumentManager } from '../util/DocumentManager';
import { UserOptions } from '../util/GroupManager';
import { SearchUtil } from '../util/SearchUtil';
import { undoable } from '../util/UndoManager';
import './FilterPanel.scss';
import { FieldView } from './nodes/FieldView';
import { Handle, Tick, TooltipRail, Track } from './nodes/SliderBox-components';
import { SettingsManager } from '../util/SettingsManager';
import { Id } from '../../fields/FieldSymbols';
import { List } from '../../fields/List';
import { emptyFunction } from '../../Utils';

interface filterProps {
    Document: Doc;
}

@observer
export class FilterPanel extends React.Component<filterProps> {
    public static LayoutString(fieldKey: string) {
        return FieldView.LayoutString(FilterPanel, fieldKey);
    }

    /**
     * @returns the relevant doc according to the value of FilterBox._filterScope i.e. either the Current Dashboard or the Current Collection
     */
    @computed get targetDoc() {
        return this.props.Document;
    }
    @computed get targetDocChildKey() {
        const targetView = DocumentManager.Instance.getFirstDocumentView(this.targetDoc);
        return targetView?.ComponentView?.annotationKey ?? targetView?.ComponentView?.fieldKey ?? 'data';
    }
    @computed get targetDocChildren() {
        return [...DocListCast(this.targetDoc?.[this.targetDocChildKey] || Doc.ActiveDashboard?.data), ...DocListCast(this.targetDoc[Doc.LayoutFieldKey(this.targetDoc) + '_sidebar'])];
    }

    @computed get allDocs() {
        const allDocs = new Set<Doc>();
        const targetDoc = this.targetDoc;
        if (targetDoc) {
            SearchUtil.foreachRecursiveDoc([this.targetDoc], (depth, doc) => allDocs.add(doc));
        }
        return Array.from(allDocs);
    }

    @computed get _allFacets() {
        const noviceReqFields = ['author', 'tags', 'text', 'type', LinkedTo];
        const noviceLayoutFields: string[] = []; //["_layout_curPage"];
        const noviceFields = [...noviceReqFields, ...noviceLayoutFields];

        const keys = new Set<string>(noviceFields);
        this.allDocs.forEach(doc => SearchUtil.documentKeys(doc).filter(key => keys.add(key)));
        const sortedKeys = Array.from(keys.keys())
            .filter(key => key[0])
            .filter(key => key.indexOf('modificationDate') !== -1 || (key[0] === key[0].toUpperCase() && !key.startsWith('_')) || noviceFields.includes(key) || !Doc.noviceMode)
            .sort();

        noviceFields.forEach(key => sortedKeys.splice(sortedKeys.indexOf(key), 1));

        return [...noviceFields, ...sortedKeys];
    }

    @computed get rangeFilters() {
        return StrListCast(this.targetDoc?._childFiltersByRanges).filter((filter, i) => !(i % 3));
    }

    /**
     * activeFilters( ) -- all filters that currently have a filter set on them in this document (ranges, and others)
     * ["#tags::bob::check", "tags::joe::check", "width", "height"]
     */
    @computed get activeFilters() {
        return StrListCast(this.targetDoc?._childFilters).concat(this.rangeFilters);
    }

    @computed get mapActiveFiltersToFacets() {
        const filters = new Map<string, string>();
        //this.targetDoc.docFilters
        this.activeFilters.map(filter => filters.set(filter.split(Doc.FilterSep)[1], filter.split(Doc.FilterSep)[0]));
        return filters;
    }

    //
    // activeFacetHeaders() - just the facet names, not the rest of the filter
    //
    // this wants to return all the filter facets that have an existing filter set on them in order to show them in the rendered panel
    // this set may overlap the selectedFilters
    // if the components reloads, these will still exist and be shown

    // ["#tags", "width", "height"]
    //

    @computed get activeFacetHeaders() {
        const activeHeaders = new Array();
        this.activeFilters.map(filter => activeHeaders.push(filter.split(Doc.FilterSep)[0]));

        return activeHeaders;
    }
    /**
     * @returns a string array of the current attributes
     */
    // @computed get currentFacets() {
    //     return this.activeFilters.map(filter => filter.split(Doc.FilterSep)[0]);
    // }

    gatherFieldValues(childDocs: Doc[], facetKey: string) {
        const valueSet = new Set<string>(StrListCast(this.props.Document.childFilters).map(filter => filter.split(Doc.FilterSep)[1]));
        let rtFields = 0;
        let subDocs = childDocs;
        if (subDocs.length > 0) {
            let newarray: Doc[] = [];
            while (subDocs.length > 0) {
                newarray = [];
                subDocs.forEach(t => {
                    const facetVal = t[facetKey];
                    if (facetVal instanceof RichTextField || typeof facetVal === 'string') rtFields++;
                    facetVal !== undefined && valueSet.add(Field.toString(facetVal as Field));
                    (facetVal === true || facetVal == false) && valueSet.add(Field.toString(!facetVal));
                    const fieldKey = Doc.LayoutFieldKey(t);
                    const annos = !Field.toString(Doc.LayoutField(t) as Field).includes('CollectionView');
                    DocListCast(t[annos ? fieldKey + '_annotations' : fieldKey]).forEach(newdoc => newarray.push(newdoc));
                    annos && DocListCast(t[fieldKey + '_sidebar']).forEach(newdoc => newarray.push(newdoc));
                });
                subDocs = newarray;
            }
        }
        //     }
        // });

        return { strings: Array.from(valueSet.keys()), rtFields };
    }

    public removeFilter = (filterName: string) => {
        Doc.setDocFilter(this.targetDoc, filterName, undefined, 'remove');
        Doc.setDocRangeFilter(this.targetDoc, filterName, undefined);
    };

    // @observable _chosenFacets = new ObservableMap<string, 'text' | 'checkbox' | 'slider' | 'range'>();
    @observable _chosenFacetsCollapse = new ObservableMap<string, boolean>();
    @observable _collapseReturnKeys = new Array();

    // this computed function gets the active filters and maps them to their headers

    //
    // activeRenderedFacetInfos()
    //    returns renderInfo for all user selected filters and for all existing filters set on the document
    // Map("tags" => {"checkbox"},
    //         "width" => {"rangs", domain:[1978,1992]})
    //

    @computed get activeRenderedFacetInfos() {
        return new Set(
            Array.from(new Set(Array.from(this._selectedFacetHeaders).concat(this.activeFacetHeaders))).map(facetHeader => {
                const facetValues = this.gatherFieldValues(this.targetDocChildren, facetHeader);

                let nonNumbers = 0;
                let minVal = Number.MAX_VALUE,
                    maxVal = -Number.MAX_VALUE;
                facetValues.strings.map(val => {
                    const num = val ? Number(val) : Number.NaN;
                    if (Number.isNaN(num)) {
                        val && nonNumbers++;
                    } else {
                        minVal = Math.min(num, minVal);
                        maxVal = Math.max(num, maxVal);
                    }
                });

                if (facetHeader === 'text') {
                    return { facetHeader, renderType: 'text' };
                } else if (facetHeader !== 'tags' && nonNumbers / facetValues.strings.length < 0.1) {
                    const extendedMinVal = minVal - Math.min(1, Math.floor(Math.abs(maxVal - minVal) * 0.1));
                    const extendedMaxVal = Math.max(minVal + 1, maxVal + Math.min(1, Math.ceil(Math.abs(maxVal - minVal) * 0.05)));
                    const ranged = Doc.readDocRangeFilter(this.targetDoc, facetHeader); // not the filter range, but the zooomed in range on the filter
                    return { facetHeader, renderType: 'range', domain: [extendedMinVal, extendedMaxVal], range: ranged ? ranged : [extendedMinVal, extendedMaxVal] };
                } else {
                    return { facetHeader, renderType: 'checkbox' };
                }
            })
        );
    }

    @observable _selectedFacetHeaders = new Set<string>();

    /**
     * user clicks on a filter facet because they want to see it.
     * this adds this chosen filter to a set of user selected filters called:  selectedFilters
     * if this component reloads, then these filters will go away since they haven't been written to any Doc anywhere
     *
     *   // this._selectedFacets.add(facetHeader);  .. add to Set() not array
     */

    @action
    facetClick = (facetHeader: string) => this._selectedFacetHeaders.add(facetHeader);

    @action
    sortingCurrentFacetValues = (facetHeader: string) => {
        this._collapseReturnKeys.splice(0);

        Array.from(this.activeRenderedFacetInfos.keys()).map(renderInfo => {
            if (renderInfo.renderType === 'range' && renderInfo.facetHeader === facetHeader && renderInfo.range) {
                this._collapseReturnKeys.push(renderInfo.range.map(number => number.toFixed(2)));
            }
        });

        for (var key of this.facetValues(facetHeader)) {
            if (this.mapActiveFiltersToFacets.get(key)) {
                this._collapseReturnKeys.push(key);
            }
        }

        return <div className=" filterbox-collpasedAndActive">{this._collapseReturnKeys.join(',  ')}</div>;
    };

    facetValues = (facetHeader: string) => {
        const allCollectionDocs = new Set<Doc>();
        SearchUtil.foreachRecursiveDoc(this.targetDocChildren, (depth: number, doc: Doc) => allCollectionDocs.add(doc));
        const set = new Set<string>([...StrListCast(this.props.Document.childFilters).map(filter => filter.split(Doc.FilterSep)[1]), Doc.FilterNone, Doc.FilterAny]);
        if (facetHeader === 'tags')
            allCollectionDocs.forEach(child =>
                StrListCast(child[facetHeader])
                    .filter(h => h)
                    .forEach(key => set.add(key))
            );
        else
            allCollectionDocs.forEach(child => {
                const fieldVal = child[facetHeader] as Field;
                if (!(fieldVal instanceof List)) {
                    // currently we have no good way of filtering based on a field that is a list
                    set.add(Field.toString(fieldVal));
                    (fieldVal === true || fieldVal === false) && set.add((!fieldVal).toString());
                }
            });
        const facetValues = Array.from(set).filter(v => v);

        let nonNumbers = 0;

        facetValues.map(val => Number.isNaN(Number(val)) && nonNumbers++);
        return nonNumbers / facetValues.length > 0.1 ? facetValues.sort() : facetValues.sort((n1: string, n2: string) => Number(n1) - Number(n2));
    };

    @computed get fieldsDropdown() {
        const filteredOptions = ['author', 'tags', 'text', 'acl-Guest', ...this._allFacets.filter(facet => facet[0] === facet.charAt(0).toUpperCase())];

        Object.entries(DocOptions)
            .filter(opts => opts[1].filterable)
            .forEach((pair: [string, FInfo]) => filteredOptions.push(pair[0]));
        const options = filteredOptions.map(facet => ({ value: facet, label: facet }));

        return (
            <Select
                styles={{
                    control: (baseStyles, state) => ({
                        ...baseStyles,
                        color: SettingsManager.userColor,
                        background: SettingsManager.userBackgroundColor,
                    }),
                    placeholder: (baseStyles, state) => ({
                        ...baseStyles,
                        color: SettingsManager.userColor,
                        background: SettingsManager.userBackgroundColor,
                    }),
                    input: (baseStyles, state) => ({
                        ...baseStyles,
                        color: SettingsManager.userColor,
                        background: SettingsManager.userBackgroundColor,
                    }),
                    option: (baseStyles, state) => ({
                        ...baseStyles,
                        color: SettingsManager.userColor,
                        background: !state.isFocused ? SettingsManager.userBackgroundColor : SettingsManager.userVariantColor,
                    }),
                    menuList: (baseStyles, state) => ({
                        ...baseStyles,
                        backgroundColor: SettingsManager.userBackgroundColor,
                    }),
                }}
                placeholder={'add a filter'}
                options={options}
                isMulti={false}
                onChange={val => this.facetClick((val as UserOptions).value)}
                onKeyDown={e => e.stopPropagation()}
                //onMenuClose={onClose}
                value={null}
                closeMenuOnSelect={true}
            />
        );
    }

    render() {
        return (
            <div className="filterBox-treeView">
                <div className="filterBox-select">
                    <div style={{ width: '100%' }}>{this.fieldsDropdown}</div>
                    {/* THE FOLLOWING CODE SHOULD BE DEVELOPER FOR BOOLEAN EXPRESSION (AND / OR) */}
                    {/* <div className="filterBox-select-bool"> 
                        <select className="filterBox-selection" onChange={action(e => this.targetDoc && (this.targetDoc._childFilters_boolean = (e.target as any).value))} defaultValue={StrCast(this.targetDoc?.childFilters_boolean)}>
                            {['AND', 'OR'].map(bool => (
                                <option value={bool} key={bool}>
                                    {bool}
                                </option>
                            ))}
                        </select>
                    </div>{' '} */}
                </div>

                <div className="filterBox-tree" key="tree">
                    {Array.from(this.activeRenderedFacetInfos.keys()).map(
                        (
                            renderInfo // iterato over activeFacetRenderInfos  ==> renderInfo  which you can renderInfo.facetHeader
                        ) => (
                            <div>
                                <div className="filterBox-facetHeader">
                                    <div className="filterBox-facetHeader-Header"> </div>
                                    {renderInfo.facetHeader.charAt(0).toUpperCase() + renderInfo.facetHeader.slice(1)}

                                    <div
                                        className="filterBox-facetHeader-collapse"
                                        onClick={action(e => {
                                            const collapseBoolValue = this._chosenFacetsCollapse.get(renderInfo.facetHeader);
                                            this._chosenFacetsCollapse.set(renderInfo.facetHeader, !collapseBoolValue);
                                        })}>
                                        {this._chosenFacetsCollapse.get(renderInfo.facetHeader) ? <AiOutlinePlusSquare /> : <AiOutlineMinusSquare />}
                                    </div>

                                    <div
                                        className="filterBox-facetHeader-remove"
                                        onClick={action(e => {
                                            if (renderInfo.facetHeader === 'text') {
                                                Doc.setDocFilter(this.targetDoc, renderInfo.facetHeader, 'match', 'remove');
                                            } else {
                                                for (var key of this.facetValues(renderInfo.facetHeader)) {
                                                    if (this.mapActiveFiltersToFacets.get(key)) {
                                                        Doc.setDocFilter(this.targetDoc, renderInfo.facetHeader, key, 'remove');
                                                    }
                                                }
                                            }
                                            this._selectedFacetHeaders.delete(renderInfo.facetHeader);
                                            this._chosenFacetsCollapse.delete(renderInfo.facetHeader);

                                            if (renderInfo.domain) {
                                                Doc.setDocRangeFilter(this.targetDoc, renderInfo.facetHeader, renderInfo.domain, 'remove');
                                            }
                                        })}>
                                        <CiCircleRemove />{' '}
                                    </div>
                                </div>

                                {this._chosenFacetsCollapse.get(renderInfo.facetHeader)
                                    ? this.sortingCurrentFacetValues(renderInfo.facetHeader)
                                    : this.displayFacetValueFilterUIs(renderInfo.renderType, renderInfo.facetHeader, renderInfo.domain, renderInfo.range)}
                                {/*  */}
                            </div>
                        )
                    )}
                </div>
            </div>
        );
    }

    private displayFacetValueFilterUIs(type: string | undefined, facetHeader: string, renderInfoDomain?: number[] | undefined, renderInfoRange?: number[]): React.ReactNode {
        switch (type) {
            case 'text':
                return (
                    <input
                        key={this.targetDoc[Id]}
                        placeholder={'enter text to match'}
                        defaultValue={
                            StrListCast(this.targetDoc._childFilters)
                                .find(filter => filter.split(Doc.FilterSep)[0] === facetHeader)
                                ?.split(Doc.FilterSep)[1]
                        }
                        style={{ color: SettingsManager.userColor, background: SettingsManager.userBackgroundColor }}
                        onBlur={undoable(e => Doc.setDocFilter(this.targetDoc, facetHeader, e.currentTarget.value, !e.currentTarget.value ? 'remove' : 'match'), 'set text filter')}
                        onKeyDown={e => e.key === 'Enter' && undoable(e => Doc.setDocFilter(this.targetDoc, facetHeader, e.currentTarget.value, !e.currentTarget.value ? 'remove' : 'match'), 'set text filter')(e)}
                    />
                );
            case 'checkbox':
                return this.facetValues(facetHeader).map(fval => {
                    const facetValue = fval;
                    return (
                        <div>
                            <input
                                style={{ width: 20, marginLeft: 20 }}
                                checked={['check', 'exists'].includes(
                                    StrListCast(this.targetDoc._childFilters)
                                        .find(filter => filter.split(Doc.FilterSep)[0] === facetHeader && filter.split(Doc.FilterSep)[1] == facetValue)
                                        ?.split(Doc.FilterSep)[2] ?? ''
                                )}
                                type={type}
                                onChange={undoable(e => Doc.setDocFilter(this.targetDoc, facetHeader, fval, e.target.checked ? 'check' : 'remove'), 'set filter')}
                            />
                            {facetValue}
                        </div>
                    );
                });

            case 'range':
                const domain = renderInfoDomain;
                const range = renderInfoRange;

                if (range) {
                    console.log('this is info range ' + range[0] + ' , ' + range[1]);
                }

                if (domain) {
                    console.log('this is info domain ' + domain[0] + ', ' + domain[1]);

                    return (
                        <>
                            {/* <div className="sliderBox-outerDiv-checkBox" style={{ float: 'left' }}>
                                <Checkbox color="primary" onChange={action(() => console.log('on change'))} />
                            </div> */}

                            <div className="sliderBox-outerDiv" style={{ width: '95%', height: 45, float: 'right' }}>
                                <Slider
                                    mode={2}
                                    step={Math.min(1, 0.1 * (domain[1] - domain[0]))}
                                    domain={[domain[0], domain[1]]} // -1000, 1000
                                    rootStyle={{ position: 'relative', width: '100%' }}
                                    onChange={values => Doc.setDocRangeFilter(this.targetDoc, facetHeader, values)}
                                    values={renderInfoRange!}>
                                    <Rail>{railProps => <TooltipRail {...railProps} />}</Rail>
                                    <Handles>
                                        {({ handles, activeHandleID, getHandleProps }) => (
                                            <div className="slider-handles">
                                                {handles.map((handle, i) => {
                                                    // const value = i === 0 ? defaultValues[0] : defaultValues[1];
                                                    return (
                                                        <div>
                                                            <Handle key={handle.id} handle={handle} domain={domain} isActive={handle.id === activeHandleID} getHandleProps={getHandleProps} />
                                                        </div>
                                                    );
                                                })}
                                            </div>
                                        )}
                                    </Handles>
                                    <Tracks left={false} right={false}>
                                        {({ tracks, getTrackProps }) => (
                                            <div className="slider-tracks">
                                                {tracks.map(({ id, source, target }) => (
                                                    <Track key={id} source={source} target={target} disabled={false} getTrackProps={getTrackProps} />
                                                ))}
                                            </div>
                                        )}
                                    </Tracks>
                                    <Ticks count={5}>
                                        {({ ticks }) => (
                                            <div className="slider-ticks">
                                                {ticks.map(tick => (
                                                    <Tick key={tick.id} tick={tick} count={ticks.length} format={(val: number) => val.toString()} />
                                                ))}
                                            </div>
                                        )}
                                    </Ticks>
                                </Slider>
                            </div>
                        </>
                    );
                }

            // case 'range'
            // return <Slider ...
            //  return <slider domain={renderInfo.domain}> domain is number[] for min and max
            //         onChange = { ...     Doc.setDocRangeFilter(this.targetDoc, facetHeader, [extendedMinVal, extendedMaxVal] ) }
            //
            //  OR

            // return <div>
            //     <slider domain={renderInfo.domain}> // domain is number[] for min and max
            //     <dimain changing handles >
            //  <?div
        }
    }
}