Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

view-grid-column - adds column to existing grid.

Overview

This module is used for adding new column to existing grid.

...

name

type

required

description

plugin name

string

yes

Name of the plugin where the view belongscolumn. view

fields

string

yes

Name Fields of the view where the component belongscolumn.

component

string

yes

Name of the component where the listener will be added to.

node value

string

yes

Definition of the hook. Please see an article describing defining hook using XMLexpression

string

no

Column value expression.

orderable

boolean

no

True if column sort should be enabled.

searchable

boolean

no

True if column filter should be enabled.

multiSearchbooleannoTrue if column should be included in advanced filters.
hiddenbooleannoTrue if column should be hidden.

width

integer

no

Width of column.

link

boolean

no

True if column value should be link to detail.

alignstring
("left" | "right")
no

You could use this attribute to set your custom aligment.
Supported values: "left", "right". 

By default each column (except that one which contains a numeric values) has content aligned to the left.

More information about column definition can be found here.

Example

Please find below an example of plugin defining one additional column.

Code Block
themeEclipse
languagexmlthemeEclipse
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<plugin plugin="samplePlugin" version="1.0.0" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schema.qcadoo.org/plugin" 
    xmlns:view="http://schema.qcadoo.org/modules/view" 
    xsi:schemaLocation="http://schema.qcadoo.org/plugin http://schema.qcadoo.org/plugin.xsd http://schema.qcadoo.org/modules/view http://schema.qcadoo.org/modules/view.xsd">

    <view:view-grid-column plugin="orders" view="ordersList" component="grid">
        <view:column name="realizationTime" fields="realizationTime" orderable="true" searchable="false" width="30" link="false" />
    </view:view-grid-column>

</plugin>