mercurymedia / elm-ag-grid / AgGrid.ContextMenu

Definition


type ContextAction

Context action configuration.


type alias ContextMenu =
List ContextAction

Type alias for a context menu.

Custom context action

contextAction : { name : String, checked : Maybe Basics.Bool, actionName : Maybe String, disabled : AgGrid.Expression.Eval Basics.Bool, icon : Maybe String, cssClasses : List ( List String, AgGrid.Expression.Eval Basics.Bool ), subMenu : List ContextAction } -> ContextAction

Create a custom context action

defaultActionAttributes : ContextActionAttributes

Retrieves ContextActionAttributes with default configuration.

Can be used to ease the context action attributes configuration.

    { name = ""
    , checked = Nothing
    , disabled = Const False
    , actionName = Nothing
    , icon = Nothing
    , subMenu = []
    }

Predefined context actions

autoSizeAllContextAction : ContextAction

Auto-size all columns.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

chartRangeContextAction : ContextAction

Chart a range of selected cells. Only shown if charting is enabled.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

contractAllContextAction : ContextAction

Collapse all groups. When set, it's only shown if grouping by at least one column.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

copyContextAction : ContextAction

Copy selected value to clipboard.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

copyWithGroupHeadersContextAction : ContextAction

Copy selected value to clipboard with headers and header groups.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

copyWithHeadersContextAction : ContextAction

Copy selected value to clipboard with headers.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

csvExportContextAction : ContextAction

Export to CSV using all default export values.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

cutContextAction : ContextAction

Cut the selected value to clipboard.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

excelExportContextAction : ContextAction

Export to Excel (.xlsx) using all default export values.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

expandAllContextAction : ContextAction

When set, it's only shown if grouping by at least one column.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

exportContextAction : ContextAction

Export sub menu (containing csvExport and excelExport).

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

pasteContextAction : ContextAction

Always disabled.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

pivotChartContextAction : ContextAction

Chart all grouped and pivoted data from the grid. Only shown if charting is enabled and in Pivot Mode.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

resetColumnsContextAction : ContextAction

Reset all columns

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

contextSeparator : ContextAction

Adds a septerator to the context menu.

Reference: https://www.ag-grid.com/javascript-data-grid/context-menu/#built-in-menu-items

Encoding

encode : ContextMenu -> Json.Encode.Value

Encodes the ContextMenu type to json.