-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-153.html
541 lines (492 loc) · 38 KB
/
template-153.html
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="column-selection-dialog">Column Selection Dialog</h1>
<p>The Column Selection Dialog is UI for managing Grid's columns.</p>
<h2 id="features">Features</h2>
<ul>
<li>Allow users to show/hide columns and change order of the visible columns.</li>
<li>Allow users to search columns by name.</li>
<li>Allow users to add a tag and search only for columns with the specified tags.</li>
</ul>
<h2 id="demo">Demo</h2>
<p>Click on <code>Open Dialog</code> button to see the dialog.</p>
<code-sandbox hash="4e06b9b2"><pre><code class="language-css">html hr {
margin: 5px;
}
efx-grid {
height: 500px;
}
</code></pre>
<pre><code class="language-html">Language:
<select id="lang_selector">
<option value="en">English</option>
<option value="ja">Japanese</option>
<option value="de">German</option>
<option value="zh">Simplified Chinese</option>
<option value="zh-Hant">Traditional Chinese</option>
</select>
<ef-button id="open_btn">Open Dialog</ef-button>
<hr>
<efx-grid id="grid"></efx-grid>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
var fields = ["companyName", "market", "CF_LAST", "CF_NETCHNG", "industry", "CF_VOLUMN", "date", "PCTCHNG2"];
var records = DataGenerator.generateRecords(fields, { numRows: 6 });
var allColumns = [
{name: "Company", field: fields[0], disabled: true},
{name: "Market", field: fields[1], width: 100},
{name: "Last", field: fields[2], width: 80, alignment: "right"},
{name: "Net. Chng", field: fields[3], width: 80, alignment: "right"},
{name: "Industry", field: fields[4]},
{name: "Volumn", field: fields[5], alignment: "right"},
{name: "IPO Date", field: fields[6]},
{name: "Pct. Chng", field: fields[7], alignment: "right"}
];
var configObj = {
staticDataRows: records
};
var grid = document.getElementById("grid");
grid.config = configObj;
grid.columns = [
allColumns[0],
allColumns[1],
allColumns[2],
allColumns[3],
allColumns[4]
];
var dialog = document.createElement("column-selection-dialog");
dialog.config = {
data: allColumns,
defaultItems: grid.columns
};
dialog.addEventListener("confirm", function (e) {
grid.columns = e.detail.value;
});
document.getElementById("open_btn").addEventListener("click", function () {
var lang = document.getElementById("lang_selector").value;
dialog.lang = lang;
dialog.visibleItems = grid.api.getConfigObject().columns;
dialog.show();
});
</code></pre>
</code-sandbox><h2 id="setup-guide">Setup guide</h2>
<pre><code class="language-js">// efx-grid
import '@refinitiv-ui/efx-grid';
import '@refinitiv-ui/efx-grid/themes/halo/light';
// Column Selection Dialog module
import '@refinitiv-ui/efx-grid/column-selection-dialog';
import '@refinitiv-ui/efx-grid/column-selection-dialog/themes/halo/light';
</code></pre>
<p>Create a <code>column-selection-dialog</code> using the <code>document.createElement</code> method. This way, the column-selection-dialog DOM instance will not be mounted initially.</p>
<pre><code class="language-js">var dialog = document.createElement("column-selection-dialog");
</code></pre>
<p>Then you need to subscribe to <code>confirm</code> event which will be fired when the user has confirmed their changes. It is also required to directly manipulate <code>grid.columns</code> with the <code>e.detail.value</code> like below.</p>
<pre><code class="language-js">dialog.addEventListener("confirm", function (e) {
var grid = document.getElementById("grid");
grid.columns = e.detail.value;
});
</code></pre>
<p>By default, once users click <code>Done</code> the dialog will automatically hide. In order to prevent the dialog from closing (eg. Validate something before closing), use <code>beforeConfirm</code> event and set <code>e.cancel</code> to true.</p>
<pre><code class="language-js">dialog.addEventListener("beforeConfirm", function (e) {
if (/*Some logic*/) {
e.cancel = true;
window.alert("Don't hide the dialog");
}
});
</code></pre>
<p>Then set initial data using the <code>init(configObj)</code> method. This takes a configuration object consisting of two properties, <code>data</code> and <code>visibleItems</code>. Alternatively, the same configuration can be set through <code>config</code> property. For example, dialog.config = configObj;</p>
<pre><code class="language-js">var columns = [/* Grid Column Option */];
var grid = document.getElementsByTagName("efx-grid")[0];
grid.config = {/* Grid Option */};
grid.columns = columns; // Explicitly set columns, otherwise it will be undefined
dialog.config = {
data: columns, // All columns
visibleItems: grid.columns // Currently visible columns
};
</code></pre>
<blockquote>
<p>Note: <code>grid.columns</code> needs to be set explicitly due to limitations of the Grid.</p>
</blockquote>
<p>Finally, to open the dialog you need to call <code>dialog.show()</code> method on dialog element.</p>
<pre><code class="language-js">dialog.show();
</code></pre>
<h2 id="changing-language">Changing Language</h2>
<p>For more information about internationalization and how is it applied in different contexts see <a href="#/widgets/language-support">Language Support</a>.</p>
<h2 id="multi-level-with-column-selection">Multi Level with Column Selection</h2>
<code-sandbox hash="5930635e"><pre><code class="language-css">html hr {
margin: 5px;
}
efx-grid {
height: 500px;
}
</code></pre>
<pre><code class="language-html"><button id="open_btn">Open Dialog</button>
<hr>
<efx-grid id="grid"></efx-grid>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
var fields = ["companyName", "market", "CF_LAST", "CF_NETCHNG", "industry", "CF_VOLUMN", "date", "PCTCHNG2"];
var records = DataGenerator.generateRecords(fields, 20);
var allColumns = [
{name: "Company", field: fields[0], disabled: true},
{name: "Market", field: fields[1], width: 100},
{name: "Last", field: fields[2], width: 80, alignment: "right"},
{name: "Net. Chng", field: fields[3], width: 80, alignment: "right"},
{name: "Industry", field: fields[4]},
{name: "Volumn", field: fields[5], alignment: "right"},
{name: "IPO Date", field: fields[6]},
{name: "Pct. Chng", field: fields[7], alignment: "right"}
];
var configObj = {
staticDataRows: records
};
var grid = document.getElementById("grid");
grid.config = configObj;
grid.columns = [
allColumns[0],
allColumns[1],
allColumns[2],
allColumns[3],
allColumns[4]
];
var columnTree = [
allColumns[0],
{
label: 'Basic Info',
items: [
allColumns[1],
allColumns[4],
allColumns[6]
]
},
{
label: 'Trading Info',
items: [
{
label: 'Net.',
items: [
allColumns[2],
allColumns[3],
allColumns[5]
]
},
{
label: 'Percent',
items: [
allColumns[7]
]
}
]
}
];
var dialog = document.createElement("column-selection-dialog");
dialog.config = {
data: columnTree
};
dialog.addEventListener("confirm", function (e) {
grid.columns = e.detail.value;
});
document.getElementById("open_btn").addEventListener("click", function () {
dialog.visibleItems = grid.api.getConfigObject().columns;
dialog.show();
});
</code></pre>
</code-sandbox><h2 id="disabled-column">Disabled column</h2>
<p>In case you do not want specific columns to move out of the grid, you can set the flag as disabled for that specific column, as the example below:</p>
<pre><code class="language-js">var columns = [/* Grid Column Option */];
var grid = document.getElementById("grid_id");
grid.config = {/* Grid Option */};
grid.columns = columns; // Explicitly set columns, otherwise it will be undefined
columns[1].disabled = true; // To prevent this column from moving between the lists
dialog.config = {
data: columns, // All columns
visibleItems: columns// Currently visible columns
};
</code></pre>
<h2 id="stationary-column">Stationary column</h2>
<p>In case you are having pinned columns, and you do not want pinned columns to be moved or removed from the grid, you can enable the stationary flag to disable select and moving operation for that specific column.</p>
<code-sandbox hash="41b29f7c"><pre><code class="language-css">html hr {
margin: 5px;
}
</code></pre>
<pre><code class="language-html"><button id="open_btn">Open Dialog</button>
<hr>
<efx-grid id="grid"></efx-grid>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
var fields = ["companyName", "market", "CF_LAST", "CF_NETCHNG", "industry", "CF_VOLUMN", "date", "PCTCHNG2"];
var records = DataGenerator.generateRecords(fields, 20);
var allColumns = [
{name: "Company", field: fields[0], width: 250, leftPinned: true, stationary: true},
{name: "Market", field: fields[1], width: 250},
{name: "Last", field: fields[2], width: 120, alignment: "right"},
{name: "Net. Chng", field: fields[3], width: 100, alignment: "right"},
{name: "Industry", field: fields[4], width: 200},
{name: "Volumn", field: fields[5], width: 100, alignment: "right"},
{name: "IPO Date", field: fields[6], width: 100},
{name: "Pct. Chng", field: fields[7], width: 100, alignment: "right"}
];
var configObj = {
staticDataRows: records
};
var grid = document.getElementById("grid");
grid.config = configObj;
grid.columns = [
allColumns[0],
allColumns[1],
allColumns[2],
allColumns[3],
allColumns[4]
];
var columnTree = [
allColumns[0],
{
label: 'Basic Info',
items: [
allColumns[1],
allColumns[4],
allColumns[6]
]
},
{
label: 'Trading Info',
items: [
{
label: 'Net.',
items: [
allColumns[2],
allColumns[3],
allColumns[5]
]
},
{
label: 'Percent',
items: [
allColumns[7]
]
}
]
}
];
var dialog = document.createElement("column-selection-dialog");
dialog.config = {
data: columnTree
};
dialog.addEventListener("confirm", function (e) {
grid.columns = e.detail.value;
});
document.getElementById("open_btn").addEventListener("click", function () {
dialog.visibleItems = grid.api.getConfigObject().columns;
dialog.show();
});
</code></pre>
</code-sandbox><blockquote>
<p><strong>Note:</strong> </p>
<ul>
<li>Disabled column will only prevent column from selection and deselection, but the column is still movable.</li>
<li>Stationary column will not allow the column to be deselected or changing its order.</li>
</ul>
</blockquote>
<h2 id="hide-columns-in-visible-columns">Hide Columns in Visible Columns</h2>
<p>There is a use case where you might not want some columns to be moved. You can disable the number of columns in the visible columns using <code>excludedColumns</code> config.</p>
<pre><code class="language-js">dialog.config = {
// Other dialog config
excludedColumns: 2, // This will make column index 0-1 hidden in the Visible Columns.
};
</code></pre>
<h2 id="default-columns">Default Columns</h2>
<p>The "RESTORE DEFAULT" button will show only when defaultItems has been set. This button will reset all visible columns to default.</p>
<pre><code class="language-js">var allColumns = [
{name: "Company", field: fields[0], disabled: true},
{name: "Market", field: fields[1], width: 100},
{name: "Last", field: fields[2], width: 80, alignment: "right"},
{name: "Net. Chng", field: fields[3], width: 80, alignment: "right"},
{name: "Industry", field: fields[4]},
{name: "Volumn", field: fields[5], alignment: "right"},
{name: "IPO Date", field: fields[6]},
{name: "Pct. Chng", field: fields[7], alignment: "right"}
];
grid.columns = [
allColumns[0],
allColumns[1],
allColumns[2],
allColumns[3],
allColumns[4]
];
dialog.config = {
// Other dialog config
defaultItems: grid.columns
};
</code></pre>
<blockquote>
<p>Note: <code>availableItems</code> is deprecated.</p>
</blockquote>
<h2 id="restoring-columns-with-retaining-sorting-and-filtering-states">Restoring columns with retaining sorting and filtering states</h2>
<p>The Column Selection Dialog only provides column information to the user. If you wish to retain certain states, such as sorting and filtering, you will need to utilize the grid API to restore the updated data back to the grid from your side.</p>
<p>In the example below, we will demonstrate how to retain the sorting and filtering state in the grid when confirming the column selection dialog.</p>
<code-sandbox hash="a1b5002d"><pre><code class="language-css">html hr {
margin: 5px;
}
efx-grid {
height: 500px;
}
</code></pre>
<pre><code class="language-html"><button id="open_btn">Open Dialog</button>
<hr>
<efx-grid id="grid"></efx-grid>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
var rowFilteringExt = new RowFiltering();
var fields = ["companyName", "market", "CF_LAST", "CF_NETCHNG", "industry", "CF_VOLUMN", "date", "PCTCHNG2"];
var records = DataGenerator.generateRecords(fields, 20);
var allColumns = [
{name: "Company", field: fields[0], disabled: true},
{name: "Market", field: fields[1], width: 100},
{name: "Last", field: fields[2], width: 80, alignment: "right"},
{name: "Net. Chng", field: fields[3], width: 80, alignment: "right"},
{name: "Industry", field: fields[4]},
{name: "Volumn", field: fields[5], alignment: "right"},
{name: "IPO Date", field: fields[6]},
{name: "Pct. Chng", field: fields[7], alignment: "right"}
];
var configObj = {
staticDataRows: records,
extensions: [rowFilteringExt],
rowFiltering: {
iconActivation: "always"
},
};
var grid = document.getElementById("grid");
grid.config = configObj;
grid.columns = [
allColumns[0],
allColumns[1],
allColumns[2],
allColumns[3],
allColumns[4]
];
var dialog = document.createElement("column-selection-dialog");
dialog.config = {
data: allColumns,
defaultItems: grid.columns
};
dialog.addEventListener("confirm", function (e) {
grid.api.restoreColumns(e.detail.data, true);
});
document.getElementById("open_btn").addEventListener("click", function () {
dialog.visibleItems = grid.api.getConfigObject().columns;
dialog.show();
});
</code></pre>
</code-sandbox><h2 id="tag-searching">Tag searching</h2>
<p>To add available tag list to the dialog, set an array of tags to <code>tags</code> property on the dialog configuration object. <code>tags</code> property can also be set on column configuration object for matching. </p>
<code-sandbox hash="ba53034d"><pre><code class="language-css">html hr {
margin: 5px;
}
efx-grid {
height: 500px;
}
</code></pre>
<pre><code class="language-html"><button id="open_btn">Open Dialog</button>
<hr>
<big id="msg_big"></big>
<hr>
<efx-grid id="grid"></efx-grid>
</code></pre>
<pre><code class="language-javascript">import { halo } from './theme-loader.js'; // This line is only required for demo purpose. It is not relevant for your application.
await halo(); // This line is only required for demo purpose. It is not relevant for your application.
/* ---------------------------------- Note ----------------------------------
DataGenerator, Formatters and extensions are exposed to global scope
in the bundle file to make it easier to create live examples.
Importing formatters and extensions is still required in your application.
Please see the document for further information.
---------------------------------------------------------------------------*/
var availableTags = ["Runner", "Swimmer", "Flier", "red", "green", "blue"];
var fieldDefs = [
["Red Dog", ["red", "runner", "running"]],
["Red Snake", ["red"]],
["Blue Penguin", ["Blue", "Runner", "Running", "Swimmer"]],
["Blue Bird", ["Blue", "Flier"]],
["Blue Chicken", ["Blue", "runner", "running"]],
["Green Lion", ["Green", "Runner", "running"]],
["Red Bat", ["red", "Flier"]],
["Green Frog", ["Green", "Swimmer"]],
["Blue Rabbit", ["Blue", "Runner", "running"]],
["Red Fish", ["red", "Swimmer"]]
];
document.getElementById("msg_big").textContent = "Available tags: " + availableTags.join(", ");
var columnDefMap = fieldDefs.reduce(function(obj, def) {
var field = def[0];
var tag = def[1];
obj[field] = {
field: field,
id: field,
tags: tag
};
return obj;
}, {});
function idToColumnDef(colId) {
return columnDefMap[colId] || null;
}
var fields = Object.keys(columnDefMap);
var availableColumns = Object.values(columnDefMap);
var records = DataGenerator.generateRecords(fields, { seed: 1, numRows: 20 });
var configObj = {
staticDataRows: records
};
var grid = document.getElementById("grid");
grid.config = configObj;
grid.columns = availableColumns.slice(0, 4);
function onConfirm(e) {
grid.columns = e.detail.value;
}
var dialog = null;
document.getElementById("open_btn").addEventListener("click", function () {
if (!dialog) {
dialog = document.createElement("column-selection-dialog");
dialog.config = {
data: availableColumns,
confirm: onConfirm,
tags: availableTags,
infoTooltip: "Search Column to add to the right list. Press Tab to add a Tag. Available tags for Search: Red, Blue, Green, Runner, Swimmer, and Flier",
searchPlaceholder: "Search Column. Press Tab to add a Tag"
};
}
var columnIds = grid.api.getColumnIds();
dialog.visibleItems = columnIds.map(idToColumnDef);
dialog.show();
});
</code></pre>
</code-sandbox><h2 style="margin-bottom:5px" id="api-refs">API Reference</h2>
<div id="elf-api-container"><div id="main-template" class="elf-template"> <section><header> <h1 class="subsection-title"><span class="attribs"><span class="type-signature"></span></span>ColumnSelectionDialog<span class="signature">()</span><span class="type-signature"></span></h1> </header><article> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~Config">Config</h4> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Array.<Object></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">All possible columns for selection.</td> </tr> <tr> <td class="name"><code>visibleItems</code></td> <td class="type"> <span class="param-type">Array.<Object></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Column list that is in existing Grid.</td> </tr> <tr> <td class="name"><code>defaultItems</code></td> <td class="type"> <span class="param-type">Array.<Object></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Column list that is default.</td> </tr> <tr> <td class="name"><code>confirm</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Confirm event callback.</td> </tr> <tr> <td class="name"><code>cancel</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Cancel event callback.</td> </tr> <tr> <td class="name"><code>excludedColumns</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Deprecated, Alias wigh excludedLeftColumns.</td> </tr> <tr> <td class="name"><code>excludedLeftColumns</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Number of columns on the left side that should be hidden from Visible Columns.</td> </tr> <tr> <td class="name"><code>excludedRightColumns</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Number of columns on the right side that should be hidden from Visible Columns.</td> </tr> <tr> <td class="name"><code>unmovableColumns</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Depricated, Alias with stationary column option. Number of columns that is unmovable in Visible Columns.</td> </tr> <tr> <td class="name"><code>descriptionBox</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Show description box</td> </tr> <tr> <td class="name"><code>middleSeparator</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Field of column which used as middle separator to divide grid into two sides</td> </tr> <tr> <td class="name"><code>collapseAll</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">Default collapse property applies to all groups</td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Specify width of the dialog, with the minimum width of 490px</td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Specify height of the dialog</td> </tr> <tr> <td class="name"><code>tags</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">All available tags for filtering</td> </tr> <tr> <td class="name"><code>infoTooltip</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">If specified, an informational icon will appear on the top with the given text as its tooltip</td> </tr> <tr> <td class="name"><code>searchPlaceholder</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "Search" </td> <td class="description last">Placeholder text inside the search input.</td> </tr> <tr> <td class="name"><code>dialogLabel</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">Dialog's title displayed in the title bar of the dialog.</td> </tr> <tr> <td class="name"><code>availableItemsLabel</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">The title of the available column list on the left pane.</td> </tr> <tr> <td class="name"><code>visibleItemsLabel</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">The title of the visible column list on the right pane.</td> </tr> </tbody></table></div><div class="details"> </div></div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hide"><span class="type-signature"></span>hide<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Hide the dialog </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/widgets/column-selection-dialog#~Config">ColumnSelectionDialog~Config</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="show"><span class="type-signature"></span>show<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Show the dialog </div> <div class="details"> </div> </div> </article></section></div></div>