igniteui-grid-lite 0.2.0 → 0.3.1-alpha.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/column.d.ts +4 -4
- package/components/column.js +4 -4
- package/components/column.js.map +1 -1
- package/components/filter-row.js +5 -5
- package/components/filter-row.js.map +1 -1
- package/components/grid.js +2 -2
- package/components/grid.js.map +1 -1
- package/components/header-row.js +1 -1
- package/components/header-row.js.map +1 -1
- package/components/header.js +2 -2
- package/components/header.js.map +1 -1
- package/components/row.js +2 -2
- package/components/row.js.map +1 -1
- package/controllers/filter.js +1 -1
- package/controllers/filter.js.map +1 -1
- package/controllers/navigation.js +4 -4
- package/controllers/navigation.js.map +1 -1
- package/controllers/resize.js +2 -2
- package/controllers/resize.js.map +1 -1
- package/controllers/sort.js +3 -3
- package/controllers/sort.js.map +1 -1
- package/controllers/state.js +1 -1
- package/controllers/state.js.map +1 -1
- package/custom-elements.json +1811 -1811
- package/docs/assets/search.js +1 -1
- package/docs/classes/IgcGridLiteColumn.html +12 -12
- package/docs/interfaces/BaseColumnConfiguration.html +12 -12
- package/internal/constants.js +2 -2
- package/internal/constants.js.map +1 -1
- package/internal/types.d.ts +5 -5
- package/internal/types.js.map +1 -1
- package/internal/utils.js +6 -6
- package/internal/utils.js.map +1 -1
- package/package.json +2 -2
package/docs/assets/search.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
window.searchData = "eJytnFtv2zoSgP+L8mqk5l3K4/bcit3FFujBeTGChY+
|
|
1
|
+
window.searchData = "eJytnFtv2zoSgP+L8mqk5l3K4/bcit3FFujBeTGChY+tukIdO7CVtN2g/31BSY5nNENpZOctiDkXkt/MkJTEl+yw/3bM7hYv2ddqt87ulM5n2W75UGZ32YfN6vdDtf5XVZfZLHs6bLO7bLVdHo/l8R347fZL/bDNZqefsrss+zl71TfX9lXh8qne/17uysNSoPEmtt6cWwP1s+xxeSh3dc/HhNX1sl6OW+taXWXlY/VYbqtd+X6/+1xtng7LutrvZKYfO9FVT/Rif477Q13tNv95jIqO40507fev7S+3XP/YlhKLp3ZTLGmvlcWj/ldVfpMN8nPb8gp7n6ttXR5+/f54KI9H2cC2IiUSucKDJl5HjXatrrDT8TCpq53Mm/W13tfL7Ye6fBDYbtpWXdtJNuf2nPJW23J5+K2ZsXGTTePPp8bX2fy0P9RCi8e26cX2Pgu7d33PNmX9fr99ehDkwE1Zr05NL7Z3FA3iteP39Lhe1mXbMQGYbfPVa/NJeZWvxuOD2raQV+ZVud3+WT48bkcqM9B7E2Xqs8xovzqvB+rnnz8exdZj+7ptf6Xlz1W5XUvNnhpfbTPG1vLvrbi/SOJNrFe7zfvlsfxU7o5VXT1P9KTabVbLY3kE0ld69aVcrofzEvTitfWbWJ3Kfiv1dvR/qdbrUhrRN6+tr7R6KI/V/6ZACAWutB2z8BTToP0bWBav0PsuTF6fj/tyaRx2sm8chd+qdf1F6sKp8bWjMLpjQP0W7xuIVe38q9F/LI9dAx6GaleXh8/LVXl8l2h6ZXkVGpDV2VRvpNVW6sxo2Z3oCC6+Ui+Gq/BkF0gtlvsxWpQvciaZEqY5Js4OE53sVWqpUyMl+yInLo4qYQWf6hSu42Jnhgv6RCdoWZf6MV7fJ7pCqrzUk9Fyf4EjV+X5CdX/AteuDvhJi4GJDuIlgdSj4bXBuAt8rf40bR5J8wk1e/8QvR1Jc7yBGyA81n/ao/QY/NY7fkz51m83odcSCln1N3L2SDeSU7BbV0OTnHAEiL2BE4cqltLlRB/OUte78LX8Mc16K3C94WO5PKy+/FkeHqbZb+XqVu4iN/rkf9is3pfb7fv9ri6/1ylvcKspsY4O1Ma13owcVjIuJ0x3IhNMv0pca/qw/zbFbtv8WqPPy+1TMrFwZk8CFxjuQ/Sp/0wj5Qdp+MYJlNc/IYPSnlxYxVKeSOqX2Il1dShXQ3k84QWUewM3BtJowoGxPDpkGsL3y+jDYeBPsrEcwt4jHrHysWc+6X4MrG0vcGPwEY3ECTj4p9OgT/wTceAV31I+7A/7NRvyA3pvOhm+qwnX+X5+2Kzaglquf31O1JR+G3nfEsHDKhyMG+Jm8lAwsa3nTZ6aTzbKDmEM6tExPDWSD2LJPE0f1XwjfJ7e8/zCecSmRRM5ZrJOHDQmbI491Usa7c3kKXiaZv9ePiZc6DebmmVL9vgypfgGCI2eX796PnZYeIEHrdTVLsRMPXEEXkXexPjU3p9lLjHfQ+yP5hBxYFPSb/MWWxJW59iGhDg7eTvCmx3ZjAyY1fMiKKfRAv3jYf9YHuof6NFEzAftKg3+PDiSnO72nKW3Gj7rhj9P0j30DKlVP/XREW8hffIFrUw78OpbgkurP/b7rz0T/Z8v1v1xeViCl7qo9raBPFrQO56D6oZf9GScTFjcHKq10GLX9FqLNQ2KlMXBEjpokZs1JhpP/55EQFu43/fP01qN+McL9DK7eqhZuJfv606cO7WaJxw39fX+s/zR5z/+a5KOgWx5caYcyJIXZ8hu9/ILOQU464U/X6I7OfnTTnI47Z/QPuSstfk/p+1+llW7dfk9u3vJnstD49Rdpm/NbZHN2gfe8Y371sYsntA8tCV0vV89NX/ed83+Klf1/hAbt63fzbPZYj6z+tbkxf39bHESbn5o/nHScf5PI6iy2UJxgooIKiSos9lCz0y41blCgpoIaiRostnCcIKGCBokaLPZwnKuWiJokaDLZgvHWXRE0CFBn80WnrPoiaBHgiGbLQInGIhgQIJ5NlvknGBOBHMkWGSzRcEJFkSwwABEHhTLjqLwqB49DT48PwxAmCAVuVCaFaYQKUyRimwoliNFQVKYJBX5UCxLisKkME0qMqJYnhQFSmGiVOREsUwpCpXCVKnIimK5UhQshclSkReVs25TuBSmS0VmVDEz5rZQHgtTwBQmTEdm9JzNFZQwjQnTkRmtWGFKmO7lqCZJ8VmKSVOYMB2Z0SxhmhKmMWE6MqMtK0wJ05gwHZnRLGGaEqYxYToyoz0rTAnTmDAdmdGBFaaEaUyYjsxoljBNCdOYMB2Z0QUrTAnTmDATmTEsYYYSZjBhRqXKg6GAGQyYicgYNv8ZCpjpFUKTjEjD1EIMmLHJiDQUMIMBMy4ZkYYCZjBgxicj0lDADAbMhGREGgqYwYCZPBmRhgJmMGCmSEakoYAZDJidJyPSUsAsBsyqZERaSpjFhFmdjEhLCbOYMGuSEWkpYba33LLJiLTMigsTZl0yIi0lzGLCbGTGsAsDSwmzmDAbmTEsJJYSZjFhNjJj+EUmJcxiwmxkxvCQUMIsJsw1KYxdGDhKmMOEuciMYRcGjhLmMGGuyWH5zKhbOzdYmBLmMGGuWc2zC09HCXOYMNes6Nmlp6OEud6iPjJj2TTkmHU9JsxFZiybhhwlzGHCXGTGGtZtSpjDhLnIjGUJc5QwhwlzkRnrWGFKmMOE+XkST08J85gwr5JR5SlhHhPmIzOW30hRwjwmzJsknp4S5jFh3qY2m54C5jFg3iV3GJ4C5ns7R5/cJHhm84gB8w1gbDh7CpjHgPkGMHYP6SlgHgPmG8DYcPYUMI8BC/PkTAUKWMCAhWYVxuaCQAELGLAQkXHsMixQwAIGLERkHFttAgUsYMCCTfeZEhYwYaE5mGAJC5SwgAkLkRnHJpJACQu984nIjGMTSWCOKDBhITLj2HAOlLCACQuRGcefjVDCAiYsj8w4/nyEEpZjwvKGMJbtnBKWY8Jynaw2OSUsx4TlJlltckpYjgnLIzOeDYycEpZjwvLIjGcDI6eE5ZiwvDn+YgMjp4TlmLA8MuPZIplTwvLeKVhkxrNs58xBGCYsj8x4lu2cEpZjwop56lizoIAVGLAiIuPZuCgoYAUGrNDJXFBQwAoMWGGSm8GCAlZgwIoGMDYiCwpYgQErGsDYiCwoYAUGrGgA408tKWAFBqxozljZuCgoYAUGrIjIBDYuCgpY0TtqjcgENi4K5rS1f9waoQlsYLS/YXHwv04+chP4s8s5c+Y67x26ziM6gQ2P9re+fPu/5tnFc/wuav2hfYaxWGT4Ip6X7L/d4w11ek7ykqns7uXnz/PDjLuXn+B5Rvwtmvt7eewuQuh9SHPWaYBSoydqZT7RAZr1WbP1Ys3961uQSgtU5mKV1WYVv+lcnZ4pnhXa+Vmhs2KFj93Tvvax71mdB+pyubp2GE/PAIE6MDe5m6QO3QqDeuxAjwuRzt5b0mA6gC5btNJ+LtOJvrEFiOeA8bwVNkamEt4OAzTCqJGFDbj1BegBOCtZoJxeEQKjD5xxrhXLpyhLRpsH7uWyaBPEsDdAaxBqpSAboMaGDhThXJy/LQL6PBhGIXCvb0EANQGokbnTvsxyVgFGXbcihcyfgTvIgIMgN3ejJssqUPuX5r0iMKcgieayJArVPXavEgGFIA3kspRy/qodBFgBAqzLJsZ2gypLAec7x4B3Z62ysAAfQYDAhWpkAYveIj5rcgCZIOtW9/U9oA7UGT3vhkpWIJgECShTJ8ymKGs/GwbegSSnVeedbOxbhVysehCrhSwIzm/+gtEHrAZZQhtakHhQroopY5aAA3RyinPN+7WgkwDWIIvw1P0FYFZhqutynZE5Ce4aA9iBNKRkE9q+1wdGH/SzkOXvqCLeWte/fRFEOpgDL+vf6Z4FMFggpnQXU0Y2E/17EoBSMGK6S4xGlm9P9x0AZSAQdLcSsbLSlV5Oe5DCC1nEV5vVKU7L9gMQMBVAnZd19FVdXAD39TmQmIIsiVeb1QkZqAnkX/GYnfQwoQCQUzLkgL6mmw/xcwvQU4BKEE9Eix4zrw5MRC4LtOZDFrCSAYnSddnDd4ERugoWZFnga/MmJ8iZYDIK2ei134AB0IB3Xhamp/fwgRKQIJ1vxXJZgU/tJwMAtpD5BW4UAcEOEqXuXLOyeWw+QgadBInNyQa7vRr1rAKMtaxL8ON2QBRg0smGmWzpQA5UXQ70smg5X5cCRhmEse52OVaWZlInAAEwVcgy4OB+ToPB19322soHr7eWgqsVuXP9xQrkQZZM+btXQC8BGrrbSVhZculUs3uAABfK80mu8qvHAJdAc1k8clf+njXC+jtFHbcOAlt2saruo1DQRRhic2Ew9JU4kOGDcJi6O+uAEpAuurWTTBW86BjkjjnsmExRL7s7wFPofCpkQ9S74xa4BTK9kqWy5/a+BzDzYOqdLEV3dw+B7AyGx3T13Qo2SPez7HTQkN0t7n/+/D+h4xXz";
|
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IgcGridLiteColumn | igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">IgcGridLiteColumn</a></li></ul><h1>Class IgcGridLiteColumn<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="tsd-tag-element"><h4 class="tsd-anchor-link" id="element">Element<a href="#element" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>igc-grid-lite-column</p>
|
|
2
2
|
</div></div></section><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="1"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">LitElement</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IgcGridLiteColumn</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/BaseColumnConfiguration.html" class="tsd-signature-type tsd-kind-interface">BaseColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Other</h3><div class="tsd-index-list"><a href="#celltemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template?</span></a>
|
|
3
|
+
<a href="#datatype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Type?</span></a>
|
|
4
|
+
<a href="#field" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a>
|
|
3
5
|
<a href="#filterable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filterable</span></a>
|
|
4
6
|
<a href="#filteringcasesensitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filtering<wbr/>Case<wbr/>Sensitive</span></a>
|
|
7
|
+
<a href="#header" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header?</span></a>
|
|
5
8
|
<a href="#headertemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template?</span></a>
|
|
6
|
-
<a href="#headertext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Text?</span></a>
|
|
7
9
|
<a href="#hidden" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a>
|
|
8
|
-
<a href="#key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a>
|
|
9
10
|
<a href="#resizable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable</span></a>
|
|
10
11
|
<a href="#sortable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sortable</span></a>
|
|
11
12
|
<a href="#sortconfiguration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration?</span></a>
|
|
12
13
|
<a href="#sortingcasesensitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sorting<wbr/>Case<wbr/>Sensitive</span></a>
|
|
13
|
-
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type?</span></a>
|
|
14
14
|
<a href="#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width?</span></a>
|
|
15
15
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">styles</h3><div class="tsd-index-list"><a href="#styles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles</span></a>
|
|
16
16
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Other"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Other</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="celltemplate"><code class="tsd-tag">Optional</code><span>cell<wbr/>Template</span><a href="#celltemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cellTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Custom cell template for the column.</p>
|
|
17
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#celltemplate">cellTemplate</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
17
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#celltemplate">cellTemplate</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datatype"><code class="tsd-tag">Optional</code><span>data<wbr/>Type</span><a href="#datatype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dataType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"string"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"number"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol"> = 'string'</span></div><div class="tsd-comment tsd-typography"><p>The data type of the column's values.</p>
|
|
18
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#datatype">dataType</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="field"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></div><div class="tsd-comment tsd-typography"><p>The field from the data for this column.</p>
|
|
19
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#field">field</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filterable"><span>filterable</span><a href="#filterable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filterable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the column is filterable.</p>
|
|
18
20
|
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#filterable">filterable</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filteringcasesensitive"><span>filtering<wbr/>Case<wbr/>Sensitive</span><a href="#filteringcasesensitive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filteringCaseSensitive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Whether filter operations will be case sensitive.</p>
|
|
19
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#filteringcasesensitive">filteringCaseSensitive</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
20
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#
|
|
21
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#
|
|
22
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#hidden">hidden</a></p><p>Overrides LitElement.hidden</p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
23
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#key">key</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resizable"><span>resizable</span><a href="#resizable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resizable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the column is resizable.</p>
|
|
21
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#filteringcasesensitive">filteringCaseSensitive</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="header"><code class="tsd-tag">Optional</code><span>header</span><a href="#header" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">header</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The header text of the column.</p>
|
|
22
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#header">header</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headertemplate"><code class="tsd-tag">Optional</code><span>header<wbr/>Template</span><a href="#headertemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headerTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IgcHeaderContext.html" class="tsd-signature-type tsd-kind-interface">IgcHeaderContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Custom header template for the column.</p>
|
|
23
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#headertemplate">headerTemplate</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidden"><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the column is hidden.</p>
|
|
24
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#hidden">hidden</a></p><p>Overrides LitElement.hidden</p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resizable"><span>resizable</span><a href="#resizable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resizable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the column is resizable.</p>
|
|
24
25
|
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#resizable">resizable</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortable"><span>sortable</span><a href="#sortable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the column is sortable.</p>
|
|
25
26
|
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#sortable">sortable</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortconfiguration"><code class="tsd-tag">Optional</code><span>sort<wbr/>Configuration</span><a href="#sortconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortConfiguration</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ColumnSortConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnSortConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Sort configuration for the column (e.g., custom comparer).</p>
|
|
26
27
|
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#sortconfiguration">sortConfiguration</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortingcasesensitive"><span>sorting<wbr/>Case<wbr/>Sensitive</span><a href="#sortingcasesensitive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortingCaseSensitive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Whether sort operations will be case sensitive.</p>
|
|
27
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#sortingcasesensitive">sortingCaseSensitive</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
28
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#type">type</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The width of the column.</p>
|
|
28
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#sortingcasesensitive">sortingCaseSensitive</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The width of the column.</p>
|
|
29
29
|
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BaseColumnConfiguration.html">BaseColumnConfiguration</a>.<a href="../interfaces/BaseColumnConfiguration.html#width">width</a></p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-styles"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>styles</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="styles"><code class="tsd-tag">Static</code><span>styles</span><a href="#styles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">styles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CSSResult</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Array of styles to apply to the element. The styles should be defined
|
|
30
30
|
using the css tag function, via constructible stylesheets, or
|
|
31
31
|
imported from native CSS module scripts.</p>
|
|
@@ -41,4 +41,4 @@ loading application code:</p>
|
|
|
41
41
|
<pre><code class="html"><span class="hl-4"><</span><span class="hl-5">script</span><span class="hl-4">></span><br/><span class="hl-8"> </span><span class="hl-6">// Generated and unique per request:</span><br/><span class="hl-8"> </span><span class="hl-7">window</span><span class="hl-8">.</span><span class="hl-7">litNonce</span><span class="hl-8"> </span><span class="hl-1">=</span><span class="hl-8"> </span><span class="hl-2">'a1b2c3d4'</span><span class="hl-8">;</span><br/><span class="hl-4"></</span><span class="hl-5">script</span><span class="hl-4">></span>
|
|
42
42
|
</code><button type="button">Copy</button></pre>
|
|
43
43
|
|
|
44
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-nocollapse"><h4 class="tsd-anchor-link" id="nocollapse">Nocollapse<a href="#nocollapse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Overrides LitElement.styles</p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Other"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Other</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#
|
|
44
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-nocollapse"><h4 class="tsd-anchor-link" id="nocollapse">Nocollapse<a href="#nocollapse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Overrides LitElement.styles</p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Other"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Other</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#datatype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Type</span></a><a href="#field"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a><a href="#filterable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filterable</span></a><a href="#filteringcasesensitive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filtering<wbr/>Case<wbr/>Sensitive</span></a><a href="#header"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header</span></a><a href="#headertemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template</span></a><a href="#hidden"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#resizable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable</span></a><a href="#sortable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sortable</span></a><a href="#sortconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration</span></a><a href="#sortingcasesensitive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sorting<wbr/>Case<wbr/>Sensitive</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-styles"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>styles</summary><div><a href="#styles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseColumnConfiguration | igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BaseColumnConfiguration</a></li></ul><h1>Interface BaseColumnConfiguration<T, K></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration object for grid columns.</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseColumnConfiguration</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">=</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#celltemplate">cellTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseColumnConfiguration</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">=</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#celltemplate">cellTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#datatype">dataType</a><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#field">field</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filterable">filterable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filteringcasesensitive">filteringCaseSensitive</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#header">header</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#headertemplate">headerTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="IgcHeaderContext.html" class="tsd-signature-type tsd-kind-interface">IgcHeaderContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#resizable">resizable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sortable">sortable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sortconfiguration">sortConfiguration</a><span class="tsd-signature-symbol">?:</span> <a href="../types/ColumnSortConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnSortConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sortingcasesensitive">sortingCaseSensitive</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#width">width</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span></span></li><li><span id="k"><span class="tsd-kind-type-parameter">K</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> = <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></span></li></ul></section><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/IgcGridLiteColumn.html" class="tsd-signature-type tsd-kind-class">IgcGridLiteColumn</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#celltemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template?</span></a>
|
|
3
|
+
<a href="#datatype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Type?</span></a>
|
|
4
|
+
<a href="#field" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a>
|
|
3
5
|
<a href="#filterable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filterable?</span></a>
|
|
4
6
|
<a href="#filteringcasesensitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filtering<wbr/>Case<wbr/>Sensitive?</span></a>
|
|
7
|
+
<a href="#header" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header?</span></a>
|
|
5
8
|
<a href="#headertemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template?</span></a>
|
|
6
|
-
<a href="#headertext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Text?</span></a>
|
|
7
9
|
<a href="#hidden" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden?</span></a>
|
|
8
|
-
<a href="#key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a>
|
|
9
10
|
<a href="#resizable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable?</span></a>
|
|
10
11
|
<a href="#sortable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sortable?</span></a>
|
|
11
12
|
<a href="#sortconfiguration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration?</span></a>
|
|
12
13
|
<a href="#sortingcasesensitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sorting<wbr/>Case<wbr/>Sensitive?</span></a>
|
|
13
|
-
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type?</span></a>
|
|
14
14
|
<a href="#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width?</span></a>
|
|
15
15
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="celltemplate"><code class="tsd-tag">Optional</code><span>cell<wbr/>Template</span><a href="#celltemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cellTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Cell template callback.</p>
|
|
16
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datatype"><code class="tsd-tag">Optional</code><span>data<wbr/>Type</span><a href="#datatype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dataType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></div><div class="tsd-comment tsd-typography"><p>The type of data this column will reference.</p>
|
|
17
|
+
<p>Affects the default filter operands if the column is with filtering enabled.</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If not passed, <code>string</code> is assumed to be the default type.</p>
|
|
19
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="field"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a></div><div class="tsd-comment tsd-typography"><p>The field from the data for this column.</p>
|
|
16
20
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filterable"><code class="tsd-tag">Optional</code><span>filterable</span><a href="#filterable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filterable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the column can be filtered.</p>
|
|
17
21
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filteringcasesensitive"><code class="tsd-tag">Optional</code><span>filtering<wbr/>Case<wbr/>Sensitive</span><a href="#filteringcasesensitive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filteringCaseSensitive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the filter operations will be case sensitive.</p>
|
|
18
|
-
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
19
|
-
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headertext"><code class="tsd-tag">Optional</code><span>header<wbr/>Text</span><a href="#headertext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headerText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional text to display in the column header. By default, the column key is used
|
|
22
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="header"><code class="tsd-tag">Optional</code><span>header</span><a href="#header" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">header</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional text to display in the column header. By default, the column field is used
|
|
20
23
|
to render the header text.</p>
|
|
24
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headertemplate"><code class="tsd-tag">Optional</code><span>header<wbr/>Template</span><a href="#headertemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headerTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="IgcHeaderContext.html" class="tsd-signature-type tsd-kind-interface">IgcHeaderContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Header template callback.</p>
|
|
21
25
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidden"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the column is hidden or not.</p>
|
|
22
|
-
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="key"><span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a></div><div class="tsd-comment tsd-typography"><p>The field for from the data the this column will reference.</p>
|
|
23
26
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resizable"><code class="tsd-tag">Optional</code><span>resizable</span><a href="#resizable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resizable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the the column can be resized or not.</p>
|
|
24
27
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortable"><code class="tsd-tag">Optional</code><span>sortable</span><a href="#sortable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the column can be sorted.</p>
|
|
25
28
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortconfiguration"><code class="tsd-tag">Optional</code><span>sort<wbr/>Configuration</span><a href="#sortconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortConfiguration</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ColumnSortConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnSortConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Sort configuration options for the column (e.g., custom comparer).</p>
|
|
26
29
|
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortingcasesensitive"><code class="tsd-tag">Optional</code><span>sorting<wbr/>Case<wbr/>Sensitive</span><a href="#sortingcasesensitive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortingCaseSensitive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the sort operations will be case sensitive.</p>
|
|
27
|
-
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
28
|
-
<p>Affects the default filter operands if the column is with filtering enabled.</p>
|
|
29
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If not passed, <code>string</code> is assumed to be the default type.</p>
|
|
30
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Width for the current column.</p>
|
|
30
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Width for the current column.</p>
|
|
31
31
|
<p>Accepts most CSS units for controlling width.</p>
|
|
32
32
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If not passed, the column will try to size itself based on the number of other
|
|
33
33
|
columns and the total width of the grid.</p>
|
|
34
|
-
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#
|
|
34
|
+
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#datatype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Type</span></a><a href="#field"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a><a href="#filterable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filterable</span></a><a href="#filteringcasesensitive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filtering<wbr/>Case<wbr/>Sensitive</span></a><a href="#header"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header</span></a><a href="#headertemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template</span></a><a href="#hidden"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#resizable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable</span></a><a href="#sortable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sortable</span></a><a href="#sortconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration</span></a><a href="#sortingcasesensitive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sorting<wbr/>Case<wbr/>Sensitive</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/internal/constants.js
CHANGED
|
@@ -9,8 +9,8 @@ export const SENTINEL_NODE = Object.freeze({
|
|
|
9
9
|
row: -1,
|
|
10
10
|
});
|
|
11
11
|
export const DEFAULT_COLUMN_CONFIG = Object.freeze({
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
field: columnKey,
|
|
13
|
+
dataType: 'string',
|
|
14
14
|
resizable: false,
|
|
15
15
|
hidden: false,
|
|
16
16
|
sortable: false,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/internal/constants.ts"],"names":[],"mappings":"AAEA,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC;AAC3B,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAErC,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;AACnC,MAAM,CAAC,MAAM,mBAAmB,GAAG,cAAuB,CAAC;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAyB,CAAC;AAE9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEvC,MAAM,CAAC,MAAM,aAAa,GAA8B,MAAM,CAAC,MAAM,CAAC;IACpE,MAAM,EAAE,mBAAmB;IAC3B,GAAG,EAAE,CAAC,CAAC;CACR,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAA2B;IAC3E,
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/internal/constants.ts"],"names":[],"mappings":"AAEA,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC;AAC3B,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAErC,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;AACnC,MAAM,CAAC,MAAM,mBAAmB,GAAG,cAAuB,CAAC;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAyB,CAAC;AAE9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEvC,MAAM,CAAC,MAAM,aAAa,GAA8B,MAAM,CAAC,MAAM,CAAC;IACpE,MAAM,EAAE,mBAAmB;IAC3B,GAAG,EAAE,CAAC,CAAC;CACR,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAA2B;IAC3E,KAAK,EAAE,SAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,KAAK;IACf,UAAU,EAAE,KAAK;CAClB,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA0C,IAAI,GAAG,CAAC;IAC7E,CAAC,UAAU,EAAE,aAAa,CAAC;IAC3B,CAAC,SAAS,EAAE,aAAa,CAAC;CAC3B,CAAC,CAAC","sourcesContent":["import type { ActiveNode, ColumnConfiguration, NavigationState } from './types.js';\n\nconst columnKey = Symbol();\nconst NON_EXISTING_COLUMN = Symbol();\n\nexport const PIPELINE = 'pipeline';\nexport const SORT_ICON_ASCENDING = 'arrow-upward' as const;\nexport const SORT_ICON_DESCENDING = 'arrow-downward' as const;\n\nexport const MIN_COL_RESIZE_WIDTH = 80;\n\nexport const SENTINEL_NODE: Readonly<ActiveNode<any>> = Object.freeze({\n column: NON_EXISTING_COLUMN,\n row: -1,\n});\nexport const DEFAULT_COLUMN_CONFIG = Object.freeze<ColumnConfiguration<any>>({\n field: columnKey,\n dataType: 'string',\n resizable: false,\n hidden: false,\n sortable: false,\n filterable: false,\n});\nexport const NAVIGATION_STATE: Map<NavigationState, ActiveNode<any>> = new Map([\n ['previous', SENTINEL_NODE],\n ['current', SENTINEL_NODE],\n]);\n"]}
|
package/internal/types.d.ts
CHANGED
|
@@ -45,9 +45,9 @@ export type ColumnSortConfiguration<T, K extends Keys<T> = Keys<T>> = K extends
|
|
|
45
45
|
/** Configuration object for grid columns. */
|
|
46
46
|
export interface BaseColumnConfiguration<T extends object, K extends Keys<T> = Keys<T>> {
|
|
47
47
|
/**
|
|
48
|
-
* The field
|
|
48
|
+
* The field from the data for this column.
|
|
49
49
|
*/
|
|
50
|
-
|
|
50
|
+
field: K;
|
|
51
51
|
/**
|
|
52
52
|
* The type of data this column will reference.
|
|
53
53
|
*
|
|
@@ -57,12 +57,12 @@ export interface BaseColumnConfiguration<T extends object, K extends Keys<T> = K
|
|
|
57
57
|
* If not passed, `string` is assumed to be the default type.
|
|
58
58
|
*
|
|
59
59
|
*/
|
|
60
|
-
|
|
60
|
+
dataType?: DataType;
|
|
61
61
|
/**
|
|
62
|
-
* Optional text to display in the column header. By default, the column
|
|
62
|
+
* Optional text to display in the column header. By default, the column field is used
|
|
63
63
|
* to render the header text.
|
|
64
64
|
*/
|
|
65
|
-
|
|
65
|
+
header?: string;
|
|
66
66
|
/**
|
|
67
67
|
* Width for the current column.
|
|
68
68
|
*
|
package/internal/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ReactiveControllerHost, TemplateResult } from 'lit';\nimport type IgcGridLiteCell from '../components/cell.js';\nimport type { IgcGridLite } from '../components/grid.js';\nimport type IgcGridLiteHeader from '../components/header.js';\nimport type IgcGridLiteRow from '../components/row.js';\nimport type { SortComparer } from '../operations/sort/types.js';\n\nexport type NavigationState = 'previous' | 'current';\nexport type GridHost<T extends object> = ReactiveControllerHost & IgcGridLite<T>;\n\n/**\n * Helper type for resolving keys of type T.\n */\nexport type Keys<T> = keyof T;\n\n/**\n * Helper type for resolving types of type T.\n */\nexport type BasePropertyType<T, K extends Keys<T> = Keys<T>> = T[K];\n\n/**\n * Helper type for resolving types of type T.\n */\nexport type PropertyType<T, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BasePropertyType<T, K>\n : never;\n\n/** The data for the current column. */\nexport type DataType = 'number' | 'string' | 'boolean';\n\n/**\n * Configures the sort behavior for the grid.\n */\nexport interface GridLiteSortingOptions {\n /**\n * The sorting mode - either 'single' or 'multiple' column sorting.\n */\n mode: 'single' | 'multiple';\n}\n\n/**\n * Extended sort configuration for a column.\n */\nexport interface BaseColumnSortConfiguration<T, K extends Keys<T> = Keys<T>> {\n /**\n * Custom comparer function for sort operations for this column.\n */\n comparer?: SortComparer<T, K>;\n}\n\n/**\n * See {@link BaseColumnSortConfiguration} for the full documentation.\n */\nexport type ColumnSortConfiguration<T, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BaseColumnSortConfiguration<T, K>\n : never;\n\n/** Configuration object for grid columns. */\nexport interface BaseColumnConfiguration<T extends object, K extends Keys<T> = Keys<T>> {\n /**\n * The field
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ReactiveControllerHost, TemplateResult } from 'lit';\nimport type IgcGridLiteCell from '../components/cell.js';\nimport type { IgcGridLite } from '../components/grid.js';\nimport type IgcGridLiteHeader from '../components/header.js';\nimport type IgcGridLiteRow from '../components/row.js';\nimport type { SortComparer } from '../operations/sort/types.js';\n\nexport type NavigationState = 'previous' | 'current';\nexport type GridHost<T extends object> = ReactiveControllerHost & IgcGridLite<T>;\n\n/**\n * Helper type for resolving keys of type T.\n */\nexport type Keys<T> = keyof T;\n\n/**\n * Helper type for resolving types of type T.\n */\nexport type BasePropertyType<T, K extends Keys<T> = Keys<T>> = T[K];\n\n/**\n * Helper type for resolving types of type T.\n */\nexport type PropertyType<T, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BasePropertyType<T, K>\n : never;\n\n/** The data for the current column. */\nexport type DataType = 'number' | 'string' | 'boolean';\n\n/**\n * Configures the sort behavior for the grid.\n */\nexport interface GridLiteSortingOptions {\n /**\n * The sorting mode - either 'single' or 'multiple' column sorting.\n */\n mode: 'single' | 'multiple';\n}\n\n/**\n * Extended sort configuration for a column.\n */\nexport interface BaseColumnSortConfiguration<T, K extends Keys<T> = Keys<T>> {\n /**\n * Custom comparer function for sort operations for this column.\n */\n comparer?: SortComparer<T, K>;\n}\n\n/**\n * See {@link BaseColumnSortConfiguration} for the full documentation.\n */\nexport type ColumnSortConfiguration<T, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BaseColumnSortConfiguration<T, K>\n : never;\n\n/** Configuration object for grid columns. */\nexport interface BaseColumnConfiguration<T extends object, K extends Keys<T> = Keys<T>> {\n /**\n * The field from the data for this column.\n */\n field: K;\n /**\n * The type of data this column will reference.\n *\n * Affects the default filter operands if the column is with filtering enabled.\n *\n * @remarks\n * If not passed, `string` is assumed to be the default type.\n *\n */\n dataType?: DataType;\n /**\n * Optional text to display in the column header. By default, the column field is used\n * to render the header text.\n */\n header?: string;\n /**\n * Width for the current column.\n *\n * Accepts most CSS units for controlling width.\n *\n * @remarks\n * If not passed, the column will try to size itself based on the number of other\n * columns and the total width of the grid.\n *\n */\n width?: string;\n /**\n * Whether the column is hidden or not.\n */\n hidden?: boolean;\n /**\n * Whether the the column can be resized or not.\n */\n resizable?: boolean;\n /**\n * Whether the column can be sorted.\n */\n sortable?: boolean;\n /**\n * Whether the sort operations will be case sensitive.\n */\n sortingCaseSensitive?: boolean;\n /**\n * Sort configuration options for the column (e.g., custom comparer).\n */\n sortConfiguration?: ColumnSortConfiguration<T, K>;\n /**\n * Whether the column can be filtered.\n */\n filterable?: boolean;\n /**\n * Whether the filter operations will be case sensitive.\n */\n filteringCaseSensitive?: boolean;\n /**\n * Header template callback.\n */\n headerTemplate?: (params: IgcHeaderContext<T>) => TemplateResult | unknown;\n /**\n * Cell template callback.\n */\n cellTemplate?: (params: IgcCellContext<T, K>) => TemplateResult | unknown;\n}\n\n/**\n * See {@link BaseColumnConfiguration} for the full documentation.\n */\nexport type ColumnConfiguration<T extends object, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BaseColumnConfiguration<T, K>\n : never;\n\nexport interface ActiveNode<T> {\n column: Keys<T>;\n row: number;\n}\n\n/**\n * Context object for the column header template callback.\n */\nexport interface IgcHeaderContext<T extends object> {\n /**\n * The header element parent of the template.\n */\n parent: IgcGridLiteHeader<T>;\n /**\n * The current configuration for the column.\n */\n column: ColumnConfiguration<T>;\n}\n\n/**\n * Context object for the row cell template callback.\n */\nexport interface BaseIgcCellContext<T extends object, K extends Keys<T> = Keys<T>> {\n /**\n * The cell element parent of the template.\n */\n parent: IgcGridLiteCell<T>;\n /**\n * The row element containing the cell.\n */\n row: IgcGridLiteRow<T>;\n /**\n * The current configuration for the column.\n */\n column: ColumnConfiguration<T, K>;\n /**\n * The value from the data source for this cell.\n */\n value: PropertyType<T, K>;\n}\n\n/**\n * See {@link BaseIgcCellContext} for the full documentation.\n */\nexport type IgcCellContext<T extends object, K extends Keys<T> = Keys<T>> = K extends Keys<T>\n ? BaseIgcCellContext<T, K>\n : never;\n\n/**\n * The parameters passed to a {@link DataPipelineHook} callback.\n */\nexport type DataPipelineParams<T extends object> = {\n /**\n * The current data state of the grid.\n */\n data: T[];\n /**\n * The grid component itself.\n */\n grid: IgcGridLite<T>;\n /**\n * The type of data operation being performed.\n */\n type: 'sort' | 'filter';\n};\n\n/**\n * Callback function for customizing data operations in the grid.\n */\nexport type DataPipelineHook<T extends object> = (\n state: DataPipelineParams<T>\n) => T[] | Promise<T[]>;\n\n/**\n * Configuration for customizing the various data operations of the grid.\n */\nexport interface DataPipelineConfiguration<T extends object> {\n /**\n * Hook for customizing sort operations.\n */\n sort?: DataPipelineHook<T>;\n /**\n * Hook for customizing filter operations.\n */\n filter?: DataPipelineHook<T>;\n}\n"]}
|
package/internal/utils.js
CHANGED
|
@@ -20,7 +20,7 @@ export function asArray(value) {
|
|
|
20
20
|
return Array.isArray(value) ? value : [value];
|
|
21
21
|
}
|
|
22
22
|
export function getFilterOperandsFor(column) {
|
|
23
|
-
switch (column.
|
|
23
|
+
switch (column.dataType) {
|
|
24
24
|
case 'boolean':
|
|
25
25
|
return BooleanOperands;
|
|
26
26
|
case 'number':
|
|
@@ -41,16 +41,16 @@ function getColumnType(value) {
|
|
|
41
41
|
export function setColumnsFromData(record) {
|
|
42
42
|
return Object.entries(record).map(([key, value]) => {
|
|
43
43
|
return createColumnConfiguration({
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
field: key,
|
|
45
|
+
dataType: getColumnType(value),
|
|
46
46
|
});
|
|
47
47
|
});
|
|
48
48
|
}
|
|
49
49
|
export function createColumnConfiguration(config) {
|
|
50
50
|
return {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
51
|
+
field: config.field ?? '',
|
|
52
|
+
dataType: config.dataType ?? 'string',
|
|
53
|
+
header: config.header,
|
|
54
54
|
width: config.width,
|
|
55
55
|
hidden: config.hidden ?? false,
|
|
56
56
|
resizable: config.resizable ?? false,
|
package/internal/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/internal/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAGzE,MAAM,UAAU,iBAAiB,CAC/B,OAAsC;IAEtC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;SAChC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;SAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC,CAAC;IAErD,OAAO,EAAE,uBAAuB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,CAAU;IAClC,OAAO,OAAO,CAAC,KAAK,SAAS,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,OAAO,CAAI,KAAc;IACvC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAmB,MAA8B;IAEnF,QAAQ,MAAM,CAAC,
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/internal/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAGzE,MAAM,UAAU,iBAAiB,CAC/B,OAAsC;IAEtC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;SAChC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;SAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC,CAAC;IAErD,OAAO,EAAE,uBAAuB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,CAAU;IAClC,OAAO,OAAO,CAAC,KAAK,SAAS,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,OAAO,CAAI,KAAc;IACvC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAmB,MAA8B;IAEnF,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,KAAK,SAAS;YACZ,OAAO,eAAe,CAAC;QACzB,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC;QACxB;YACE,OAAO,cAAc,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAmB,MAAS;IAC5D,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACjD,OAAO,yBAAyB,CAAI;YAClC,KAAK,EAAE,GAAc;YACrB,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC;SACI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,MAAuC;IAEvC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,EAAE;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,QAAQ;QACrC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,KAAK;QAC9B,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,KAAK;QACpC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;QAClC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,IAAI,KAAK;QAC1D,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;QACtC,sBAAsB,EAAE,MAAM,CAAC,sBAAsB,IAAI,KAAK;QAC9D,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,YAAY,EAAE,MAAM,CAAC,YAAY;KACR,CAAC;AAC9B,CAAC","sourcesContent":["import type { StyleInfo } from 'lit/directives/style-map.js';\nimport { BooleanOperands } from '../operations/filter/operands/boolean.js';\nimport { NumberOperands } from '../operations/filter/operands/number.js';\nimport { StringOperands } from '../operations/filter/operands/string.js';\nimport type { ColumnConfiguration } from './types.js';\n\nexport function applyColumnWidths<T extends object>(\n columns: Array<ColumnConfiguration<T>>\n): StyleInfo {\n const iter = Iterator.from(columns)\n .filter((each) => !each.hidden)\n .map((each) => each.width ?? 'minmax(136px, 1fr)');\n\n return { 'grid-template-columns': iter.toArray().join(' ') };\n}\n\nexport function isBoolean(x: unknown): x is boolean {\n return typeof x === 'boolean';\n}\n\nexport function isNumber(x: unknown): x is number {\n return typeof x === 'number' && !Number.isNaN(x);\n}\n\nexport function isString(x: unknown): x is string {\n return typeof x === 'string';\n}\n\nexport function asArray<T>(value: T | T[]): T[] {\n return Array.isArray(value) ? value : [value];\n}\n\nexport function getFilterOperandsFor<T extends object>(column: ColumnConfiguration<T>) {\n // Check for custom class in the filter config\n switch (column.dataType) {\n case 'boolean':\n return BooleanOperands;\n case 'number':\n return NumberOperands;\n default:\n return StringOperands;\n }\n}\n\nfunction getColumnType(value: unknown): 'boolean' | 'number' | 'string' {\n if (isBoolean(value)) {\n return 'boolean';\n }\n\n if (isNumber(value)) {\n return 'number';\n }\n\n return 'string';\n}\n\nexport function setColumnsFromData<T extends object>(record: T): Array<ColumnConfiguration<T>> {\n return Object.entries(record).map(([key, value]) => {\n return createColumnConfiguration<T>({\n field: key as keyof T,\n dataType: getColumnType(value),\n } as Partial<ColumnConfiguration<T>>);\n });\n}\n\nexport function createColumnConfiguration<T extends object>(\n config: Partial<ColumnConfiguration<T>>\n): ColumnConfiguration<T> {\n return {\n field: config.field ?? '',\n dataType: config.dataType ?? 'string',\n header: config.header,\n width: config.width,\n hidden: config.hidden ?? false,\n resizable: config.resizable ?? false,\n sortable: config.sortable ?? false,\n sortingCaseSensitive: config.sortingCaseSensitive ?? false,\n sortConfiguration: config.sortConfiguration,\n filterable: config.filterable ?? false,\n filteringCaseSensitive: config.filteringCaseSensitive ?? false,\n headerTemplate: config.headerTemplate,\n cellTemplate: config.cellTemplate,\n } as ColumnConfiguration<T>;\n}\n"]}
|