1 | import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
|
2 | import { ITranslator } from '@jupyterlab/translation';
|
3 | import { Message } from '@lumino/messaging';
|
4 | import { Widget } from '@lumino/widgets';
|
5 |
|
6 |
|
7 |
|
8 | export declare abstract class RenderedCommon extends Widget implements IRenderMime.IRenderer {
|
9 | |
10 |
|
11 |
|
12 |
|
13 |
|
14 | constructor(options: IRenderMime.IRendererOptions);
|
15 | /**
|
16 | * The mimetype being rendered.
|
17 | */
|
18 | readonly mimeType: string;
|
19 | /**
|
20 | * The sanitizer used to sanitize untrusted html inputs.
|
21 | */
|
22 | readonly sanitizer: IRenderMime.ISanitizer;
|
23 | /**
|
24 | * The resolver object.
|
25 | */
|
26 | readonly resolver: IRenderMime.IResolver | null;
|
27 | /**
|
28 | * The link handler.
|
29 | */
|
30 | readonly linkHandler: IRenderMime.ILinkHandler | null;
|
31 | /**
|
32 | * The latexTypesetter.
|
33 | */
|
34 | readonly latexTypesetter: IRenderMime.ILatexTypesetter | null;
|
35 | /**
|
36 | * The translator.
|
37 | */
|
38 | readonly translator: ITranslator;
|
39 | /**
|
40 | * Render a mime model.
|
41 | *
|
42 | * @param model - The mime model to render.
|
43 | *
|
44 | * @returns A promise which resolves when rendering is complete.
|
45 | *
|
46 | * #### Notes
|
47 | * If the DOM node for this widget already has content, it is emptied
|
48 | * before rendering. Subclasses that do not want this behavior
|
49 | * (if, for instance, they are using DOM diffing), should override
|
50 | * this method and not call `super.renderModel()`.
|
51 | */
|
52 | renderModel(model: IRenderMime.IMimeModel): Promise<void>;
|
53 | /**
|
54 | * Render the mime model.
|
55 | *
|
56 | * @param model - The mime model to render.
|
57 | *
|
58 | * @returns A promise which resolves when rendering is complete.
|
59 | */
|
60 | abstract render(model: IRenderMime.IMimeModel): Promise<void>;
|
61 | /**
|
62 | * Set the URI fragment identifier.
|
63 | *
|
64 | * @param fragment - The URI fragment identifier.
|
65 | */
|
66 | protected setFragment(fragment: string): void;
|
67 | }
|
68 | /**
|
69 | * A common base class for HTML mime renderers.
|
70 | */
|
71 | export declare abstract class RenderedHTMLCommon extends RenderedCommon {
|
72 | |
73 |
|
74 |
|
75 |
|
76 |
|
77 | constructor(options: IRenderMime.IRendererOptions);
|
78 | setFragment(fragment: string): void;
|
79 | }
|
80 | /**
|
81 | * A mime renderer for displaying HTML and math.
|
82 | */
|
83 | export declare class RenderedHTML extends RenderedHTMLCommon {
|
84 | |
85 |
|
86 |
|
87 |
|
88 |
|
89 | constructor(options: IRenderMime.IRendererOptions);
|
90 | /**
|
91 | * Render a mime model.
|
92 | *
|
93 | * @param model - The mime model to render.
|
94 | *
|
95 | * @returns A promise which resolves when rendering is complete.
|
96 | */
|
97 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
98 | /**
|
99 | * A message handler invoked on an `'after-attach'` message.
|
100 | */
|
101 | onAfterAttach(msg: Message): void;
|
102 | }
|
103 | /**
|
104 | * A mime renderer for displaying LaTeX output.
|
105 | */
|
106 | export declare class RenderedLatex extends RenderedCommon {
|
107 | |
108 |
|
109 |
|
110 |
|
111 |
|
112 | constructor(options: IRenderMime.IRendererOptions);
|
113 | /**
|
114 | * Render a mime model.
|
115 | *
|
116 | * @param model - The mime model to render.
|
117 | *
|
118 | * @returns A promise which resolves when rendering is complete.
|
119 | */
|
120 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
121 | /**
|
122 | * A message handler invoked on an `'after-attach'` message.
|
123 | */
|
124 | onAfterAttach(msg: Message): void;
|
125 | }
|
126 | /**
|
127 | * A mime renderer for displaying images.
|
128 | */
|
129 | export declare class RenderedImage extends RenderedCommon {
|
130 | |
131 |
|
132 |
|
133 |
|
134 |
|
135 | constructor(options: IRenderMime.IRendererOptions);
|
136 | /**
|
137 | * Render a mime model.
|
138 | *
|
139 | * @param model - The mime model to render.
|
140 | *
|
141 | * @returns A promise which resolves when rendering is complete.
|
142 | */
|
143 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
144 | }
|
145 | /**
|
146 | * A mime renderer for displaying Markdown with embedded latex.
|
147 | */
|
148 | export declare class RenderedMarkdown extends RenderedHTMLCommon {
|
149 | |
150 |
|
151 |
|
152 |
|
153 |
|
154 | constructor(options: IRenderMime.IRendererOptions);
|
155 | /**
|
156 | * Render a mime model.
|
157 | *
|
158 | * @param model - The mime model to render.
|
159 | *
|
160 | * @returns A promise which resolves when rendering is complete.
|
161 | */
|
162 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
163 | /**
|
164 | * A message handler invoked on an `'after-attach'` message.
|
165 | */
|
166 | onAfterAttach(msg: Message): void;
|
167 | }
|
168 | /**
|
169 | * A widget for displaying SVG content.
|
170 | */
|
171 | export declare class RenderedSVG extends RenderedCommon {
|
172 | |
173 |
|
174 |
|
175 |
|
176 |
|
177 | constructor(options: IRenderMime.IRendererOptions);
|
178 | /**
|
179 | * Render a mime model.
|
180 | *
|
181 | * @param model - The mime model to render.
|
182 | *
|
183 | * @returns A promise which resolves when rendering is complete.
|
184 | */
|
185 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
186 | /**
|
187 | * A message handler invoked on an `'after-attach'` message.
|
188 | */
|
189 | onAfterAttach(msg: Message): void;
|
190 | }
|
191 | /**
|
192 | * A widget for displaying plain text and console text.
|
193 | */
|
194 | export declare class RenderedText extends RenderedCommon {
|
195 | |
196 |
|
197 |
|
198 |
|
199 |
|
200 | constructor(options: IRenderMime.IRendererOptions);
|
201 | /**
|
202 | * Render a mime model.
|
203 | *
|
204 | * @param model - The mime model to render.
|
205 | *
|
206 | * @returns A promise which resolves when rendering is complete.
|
207 | */
|
208 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
209 | }
|
210 | /**
|
211 | * A widget for displaying JavaScript output.
|
212 | */
|
213 | export declare class RenderedJavaScript extends RenderedCommon {
|
214 | |
215 |
|
216 |
|
217 |
|
218 |
|
219 | constructor(options: IRenderMime.IRendererOptions);
|
220 | /**
|
221 | * Render a mime model.
|
222 | *
|
223 | * @param model - The mime model to render.
|
224 | *
|
225 | * @returns A promise which resolves when rendering is complete.
|
226 | */
|
227 | render(model: IRenderMime.IMimeModel): Promise<void>;
|
228 | }
|