Debian Codegraph @

packages/datagrid/src/renderermap.ts

raw
1 // Copyright (c) Jupyter Development Team.
2 // Distributed under the terms of the Modified BSD License.
3 /*-----------------------------------------------------------------------------
4 | Copyright (c) 2014-2019, PhosphorJS Contributors
5 |
6 | Distributed under the terms of the BSD 3-Clause License.
7 |
8 | The full license is in the file LICENSE, distributed with this software.
9 |----------------------------------------------------------------------------*/
10 import { ISignal, Signal } from '@lumino/signaling';
11
12 import { CellRenderer } from './cellrenderer';
13
14 import { DataModel } from './datamodel';
15
16 import { TextRenderer } from './textrenderer';
17
18 /**
19 * A class which manages the mapping of cell renderers.
20 */
21 export class RendererMap {
22 /**
23 * Construct a new renderer map.
24 *
25 * @param values - The initial values for the map.
26 *
27 * @param fallback - The renderer of last resort.
28 */
29 constructor(values: RendererMap.Values = {}, fallback?: CellRenderer) {
30 this._values = { ...values };
31 this._fallback = fallback || new TextRenderer();
32 }
33
34 /**
35 * A signal emitted when the renderer map has changed.
36 */
37 get changed(): ISignal<this, void> {
38 return this._changed;
39 }
40
41 /**
42 * Get the cell renderer to use for the given cell config.
43 *
44 * @param config - The cell config of interest.
45 *
46 * @returns The renderer to use for the cell.
47 */
48 get(config: CellRenderer.CellConfig): CellRenderer {
49 // Fetch the renderer from the values map.
50 let renderer = this._values[config.region];
51
52 // Execute a resolver function if necessary.
53 if (typeof renderer === 'function') {
54 try {
55 renderer = renderer(config);
56 } catch (err) {
57 renderer = undefined;
58 console.error(err);
59 }
60 }
61
62 // Return the renderer or the fallback.
63 return renderer || this._fallback;
64 }
65
66 /**
67 * Update the renderer map with new values
68 *
69 * @param values - The updated values for the map.
70 *
71 * @param fallback - The renderer of last resort.
72 *
73 * #### Notes
74 * This method always emits the `changed` signal.
75 */
76 update(values: RendererMap.Values = {}, fallback?: CellRenderer): void {
77 this._values = { ...this._values, ...values };
78 this._fallback = fallback || this._fallback;
79 this._changed.emit(undefined);
80 }
81
82 private _fallback: CellRenderer;
83 private _values: RendererMap.Values;
84 private _changed = new Signal<this, void>(this);
85 }
86
87 /**
88 * The namespace for the `RendererMap` class statics.
89 */
90 export namespace RendererMap {
91 /**
92 * A type alias for a cell renderer resolver function.
93 */
94 export type Resolver = CellRenderer.ConfigFunc<CellRenderer | undefined>;
95
96 /**
97 * A type alias for a `RendererMap` values type.
98 */
99 export type Values = {
100 [R in DataModel.CellRegion]?: Resolver | CellRenderer | undefined;
101 };
102 }