Column definition.

Requires field, renderer, headerName, and settings to be defined for each column.

• field: name of the column and specifically used to decode data properly (e.g. from events)

• renderer: used to render data to a cell (for more information see the documentation for Renderer)

• headerName: displayed text in the column header

• settings: allows to customize each column - a defaultSettings record is offered, which can be adjusted to your own needs to reduce the implemenation overhead.

Example

let
    defaultSettings =
        AgGrid.defaultSettings
in
[ { field = "id"
  , renderer = IntRenderer .id
  , headerName = "Id"
  , settings = defaultSettings
  }
, { field = "title"
  , renderer = StringRenderer .title
  , headerName = "Product"
  , settings =
        { defaultSettings
            | editable = False
            , pinned = AgGrid.PinnedToLeft
        }
  }
]

Possible filter options for columns.

Possible options to pin a column.

The Renderer expresses how the data is retrieved from the list of data and rendered to the view.

The editor and renderer views in the table depend on the type. For example, a BoolRenderer is displayed and can be edited with a checkbox in the table.

The Renderer may need a function to read the value for the cell from the records.

Example

If the data is list of Product, the Renderer to display the column for the title might be defined as:

type alias Product =
    { title : String }


-- Column definitions:
[{ renderer = StringRenderer .title, ... }]

Possible options for displayed sidebars.

Change event data for a table state changes.

Defines the data grid.

Example

let
    gridConfig =
        AgGrid.defaultGridConfig
            |> (\config -> { config | themeClasses = Just "ag-theme-balham ag-basic" })


    events =
        [ onCellChanged rowDecoder UpdateProduct ]


    defaultSettings =
        AgGrid.defaultSettings
            |> (\settings -> { settings | editable = True })


    columns =
        [ { field = "id"
          , renderer = IntRenderer .id
          , headerName = "Id"
          , settings = { defaultSettings | enablePivot = False }
          }
        , { field = "title"
          , renderer = StringRenderer .title
          , headerName = "Product"
          , settings = { defaultSettings | filter = StringFilter }
          }
        ]


    data =
        model.products
in
grid gridConfig events columns data

Retrieve a GridConfig record with default configuration.

Can be used when implementing the grid.

    { allowColResize = True
    , autoSizeColumns = False
    , cacheQuickFilter = False
    , disableResizeOnScroll = False
    , pagination = False
    , rowHeight = Nothing
    , quickFilterText = ""
    , sideBar = NoSidebar
    , size = "65vh"
    , suppressMenuHide = False
    , themeClasses = Nothing
    }

Retrieve a ColumnSettings record with default configuration.

Can be used when implementing column configurations for the table.

Default column settings:

{ editable = False
, enablePivot = True
, enableRowGroup = True
, enableValue = True
, filter = SetFilter
, hide = False
, pinned = Unpinned
, sortable = True
, suppressColumnsToolPanel = False
, suppressFiltersToolPanel = False
, suppressMenu = False
, suppressSizeToFit = True
, width = Nothing
}

Detect change events on cells.

Decodes the changed row according to the provided dataDecoder and passes the result to the message toMsg.

Handles the cellValueChanged event from Ag Grid.

Detect doubleclick events on cells.

Decodes the row of the clicked cell according to the provided dataDecoder and the field name of the clicked cells as tuple and passes the result to the message toMsg.

Handles the cellDoubleClicked event from Ag Grid.

Column state.

Can be used to evaluate the current table state whenever a change to the structure of the table happens (e.g. sorting, order, sizing, or visiblity of columns changed).

Might be used to persist the table state of the user to the localstorage or some other external storage. Column states can be restored through the columnState on the GridConfig.

Detect change events to the table structure (e.g. sorting or moved columns).

Decodes the EventType of the change and the current states of the grid columns and passes the result to the toMsg.

Decoder for the current column states.

Can be used to retrieve and decode the column states from an external storage.

Encode a collection of ColumnState.

Can be used to persist the current list of ColumnState for the grid to an external storage.

Filter state.

Can be used to evaluate the current filter configuration whenever a filter on a column gets changed.

Might be used to persist the filters applied to the table for the users to the localstorage or some other external storage. Filter states can be restored through the filterState on the GridConfig.

Detect change events to the table filters.

Decodes the EventType of the change and the filter configuration of the grid columns and passes the result to the toMsg.

Encode a collection of FilterState.

Can be used to persist the current collection of FilterState for the grid to an external storage.

Decoder for the filter states.

Can be used to retrieve and decode the filter states from an external storage.