Custom Icons at Grid and Column Level

This section details how to provide your own icons for the grid and style grid icons for your application requirements
at grid/column level. It is also possible to provide customs icons at global level,
see Custom Icons at Global Level.

Set the Icons Through dashGridOptions and columnDefs

You can pass an icons property either on the Grid Options to apply across the whole grid:

dashGridOptions = {
    "icons": {
        'menu': '<i>',
        'filter': '<i>',
    }}

Or the Column Definition to use the icons only the current column:

columnDefs = [
    {
        "field": "athlete",
        "sort": "asc",
        "icons": {
            "sortAscending": '<i>',
            "sortDescending": '<i>',
        }
    },
    # Other columns
]

If both are provided, icons specified at the column level will take priority.

The icons property takes an object of name/value pairs where the name is one of the icon names below (note that these
are different from
the CSS names that can be
used at global level) and the value is an HTML string to be inserted in place of the usual DOM element for an icon.

The following example uses:

Icon Names

In the following table, the grid name used in the dashGridOptions/columnDefs is to the left, and on the right is the
corresponding CSS names.

Alpine Icon (default) Grid name CSS Name Description
<img> <p>'columnGroupOpened'<p> <p>expanded<p> Header column group shown when expanded (click to contract)
<img> <p>'columnGroupClosed'<p> <p>contracted<p> Header column group shown when contracted (click to expand)
<img> <p>'columnSelectClosed'<p> <p>tree-closed<p> Tool panel column group contracted (click to expand)
<img> <p>'columnSelectOpen'<p> <p>tree-open<p> Tool panel column group expanded (click to contract)
<img> <p>'columnSelectIndeterminate'<p> <p><code>tree‑indeterminate<code><p> Column tool panel header expand/collapse all button, shown when some children are expanded and others are collapsed
<img> <p>'columnMovePin'<p> <p>pin<p> Shown on ghost icon while dragging column to the side of the grid to pin
<img> <p>'columnMoveHide'<p> <p>eye-slash<p> Shown on ghost icon while dragging over part of the page that is not a drop zone
<img> <p>'columnMoveMove'<p> <p>arrows<p> Shown on ghost icon while dragging columns to reorder
<img> <p>'columnMoveLeft'<p> <p>left<p> Animating icon shown when dragging a column to the right of the grid causes horizontal scrolling
<img> <p>'columnMoveRight'<p> <p>right<p> Animating icon shown when dragging a column to the left of the grid causes horizontal scrolling
<img> <p>'columnMoveGroup'<p> <p>group<p> Shown on ghost icon while dragging over Row Groups drop zone
<img> <p>'columnMoveValue'<p> <p>aggregation<p> Shown on ghost icon while dragging over Values drop zone
<img> <p>'columnMovePivot'<p> <p>pivot<p> Shown on ghost icon while dragging over pivot drop zone
<img> <p>'dropNotAllowed'<p> <p>not-allowed<p> Shown on ghost icon while dragging over drop zone that doesn’t support it, for example string column over aggregation drop zone
<img> <p>'groupContracted'<p> <p>tree-closed<p> Shown on row group when contracted (click to expand)
<img> <p>'groupExpanded'<p> <p>tree-open<p> Shown on row group when expanded (click to contract)
<img> <p>'setFilterGroupClosed'<p> <p>tree-closed<p> Set filter tree list group contracted (click to expand)
<img> <p>'setFilterGroupOpen'<p> <p>tree-open<p> Set filter tree list group expanded (click to contract)
<img> <p>'setFilterGroupIndeterminate'<p> <p><code>tree‑indeterminate<code><p> Set filter tree list expand/collapse all button, shown when some children are expanded and others are collapsed
<img> <p>'chart'<p> <p>chart<p> Context menu chart item
<img> <p>'close'<p> <p>cross<p> Chart window title bar
<img> <p>'cancel'<p> <p>cancel<p> X (remove) on column ‘pill’ after adding it to a drop zone list
<img> <p>'check'<p> <p>tick<p> Indicates the currently active pin state in the “Pin column” sub-menu of the column menu
<img> <p>'first'<p> <p>first<p> “go to first” button in pagination controls
<img> <p>'previous'<p> <p>previous<p> “go to previous” button in pagination controls
<img> <p>'next'<p> <p>next<p> “go to next” button in pagination controls
<img> <p>'last'<p> <p>last<p> “go to last” button in pagination controls
<img> <p>'linked'<p> <p>linked<p> Shown on top right of chart when chart is linked to range data (click to unlink)
<img> <p>'unlinked'<p> <p>unlinked<p> Shown on top right of chart when chart is not linked to range data (click to link)
<img> <p>'colorPicker'<p> <p>color-picker<p> “Choose color” button on chart settings tab
<img> <p>'groupLoading'<p> <p>loading<p> Rotating spinner shown by the loading cell renderer
<img> <p>'menu'<p> <p>menu<p> Button to launch enterprise column menu
<img> <p>'filter'<p> <p>filter<p> Filter tool panel tab
<img> <p>'columns'<p> <p>columns<p> Column tool panel tab
<img> <p>'maximize'<p> <p>maximize<p> Button in chart regular size window title bar (click to maximise)
<img> <p>'minimize'<p> <p>minimize<p> Button in chart maximised window title bar (click to make regular size)
<img> <p>'menuPin'<p> <p>pin<p> “Pin column” item in column header menu
<img> <p>'menuValue'<p> <p>aggregation<p> “Value aggregation” column menu item (shown on numeric columns when grouping is active)”
<img> <p>'menuAddRowGroup'<p> <p>group<p> “Group by
<img> <p>'menuRemoveRowGroup'<p> <p>group<p> “Un-Group by
<img> <p>'clipboardCopy'<p> <p>copy<p> Context menu copy item
<img> <p>'clipboardCut'<p> <p>cut<p> Context menu cut item
<img> <p>'clipboardPaste'<p> <p>paste<p> Context menu paste item
<img> <p>'pivotPanel'<p> <p>pivot<p> Identifies the pivot drop zone
<img> <p>'rowGroupPanel'<p> <p>group<p> “Row groups” drop zone in column tool panel
<img> <p>'valuePanel'<p> <p>aggregation<p> Columns tool panel Values drop zone
<img> <p>'columnDrag'<p> <p>grip<p> Drag handle used to pick up draggable columns
<img> <p>'rowDrag'<p> <p>grip<p> Drag handle used to pick up draggable rows
<img> <p>'save'<p> <p>save<p> Context menu export item
<img> <p>'csvExport'<p> <p>csv<p> CSV export
<img> <p>'excelExport'<p> <p>excel<p> Excel export
<img> <p>'smallDown'<p> <p>small-down<p> Icon on dropdown editors
<img> <p>'smallLeft'<p> <p>small-left<p> Version of small-right used in RTL mode
<img> <p>'smallRight'<p> <p>small-right<p> Separator between column ‘pills’ when you add multiple columns to the header drop zone
<img> <p>'smallUp'<p> <p>small-up<p> Separator between column ‘pills’ when you add multiple columns to the header drop zone
<img> <p>'sortAscending'<p> <p>asc<p> Show on column header when column is sorted ascending
<img> <p>'sortDescending'<p> <p>desc<p> Show on column header when column is sorted descending
<img> <p>'sortUnSort'<p> <p>none<p> Show on column header when column has no sort, only when enabled with columnDefs param <p>"unSortIcon": True<p>

<br>