Grid Column Renderer not called

Question

I have an issue with a rally grid column render not getting called when using the filtering plugin.

When first entering the page it works fine, even the filtering. But if I do a page refresh (browser F5 or go to another page and back) the renderer function is not called.

Is this a bug or feature?

Can I force the renderer function to be called somehow, e.g., in the store load event?

Here's a small example showing the behavior;

Ext.define('CustomApp', {
extend: 'Rally.app.App',
componentCls: 'app',
launch: function () {

    Ext.create('Rally.data.wsapi.TreeStoreBuilder').build({
        models: ['PortfolioItem/Initiative'],
        enableHierarchy: true
    }).then({
        success: this._onStoreBuilt,
        scope: this
    });
},


_onStoreBuilt: function (store) {
    var modelNames = ['PortfolioItem/Initiative'];
    var context = this.getContext();

    this.add({
        xtype: 'rallygridboard',
        context: context,
        modelNames: modelNames,
        toggleState: 'grid',
        plugins: [
            'rallygridboardaddnew',
            {
                ptype: 'rallygridboardfieldpicker',
                headerPosition: 'left',
                modelNames: modelNames,
                stateful: true,
                stateId: context.getScopedStateId('grid-fields')
            },
            {
                ptype: 'rallygridboardinlinefiltercontrol',
                inlineFilterButtonConfig: {
                    stateful: true,
                    stateId: context.getScopedStateId('grid-filters'),
                    modelNames: modelNames,
                    inlineFilterPanelConfig: {
                        quickFilterPanelConfig: {
                            defaultFields: [
                                'ArtifactSearch',
                                'State'
                            ]
                        }
                    }
                }
            }
        ],
        gridConfig: {
            store: store,
            columnCfgs: [
                'Name',
                'State',
                {
                    text: 'Refined',
                    dataIndex: 'RefinedEstimate',
                    renderer: function (value) {
                        console.log("RefinedEstimate:renderer");
                        return value + " EUR";
                    }
                }
            ]
        },
        height: this.getHeight()
    });
}

});

score 0 · Answer 1 · answered Jun 01 '18 at 16:28

0

What if you set alwaysShowDefaultColumns to true in your gridconfig?

gridConfig: {
    alwaysShowDefaultColumns: true
}

answered Jun 01 '18 at 16:28

Kyle Morse

8,390
2
15
16

Just to add to the above comment. The alwaysShowDefaultColumns does ensure that the columns are shown, but it doesn't ensure that the renderer function is called on the columns. – Michael Østerberg Jakobsen Jun 05 '18 at 07:36

score 0 · Answer 2 · answered Jun 08 '18 at 10:22

I've been playing around with different options and I actually think it has something to do with the gridboard and not the plugins.

I've created a rather bare-bone gridboard on which I can reproduce the issue.

Reproduction steps;

Create new page
Insert HTML app + paste code
Re-arrange the column ordering
Refresh the page (F5) or jump to another page and back

Now the custom renderer function is no longer called.

I've tried the same with a rallygrid, but here the rendering works ok.

Bare-bone RallyGrid Code

Ext.define('CustomApp', {
extend: 'Rally.app.App',
componentCls: 'app',
launch: function () {
    console.log("launch()");
    Ext.create('Rally.data.wsapi.TreeStoreBuilder').build({
        models: ['PortfolioItem/Initiative'],
        autoLoad: true,
        enableHierarchy: true
    }).then({
        success: this._onStoreBuilt,
        scope: this
    });
},

_onStoreBuilt: function (store) {
    console.log("_onStoreBuilt()");
    var modelNames = ['PortfolioItem/Initiative'];
    var context = this.getContext();
    var me = this;

    var myGrid = me.add({
        xtype: 'rallygridboard',
        context: context,
        modelNames: modelNames,
        toggleState: 'grid',

        gridConfig: {
            store: store,
            alwaysShowDefaultColumns: true,
            columnCfgs: [
                'Name',
                'State',
                {
                    text: 'Refined',
                    dataIndex: 'RefinedEstimate',
                    renderer: function (value) {
                        console.log("RefinedEstimate:renderer");
                        return value + " EUR";
                    }
                },
                {
                    text: 'Department (Yrs)',
                    xtype: 'templatecolumn',
                    tpl: '{RefinedEstimate} ({Name})'
                }
            ]
        },
        height: me.getHeight()
    });
}});

score 0 · Answer 3 · answered Jun 08 '18 at 14:15

0

the problem seems to be that you do not fetch the field that you are trying to display.

If you do not specify a 'fetch' list when you are doing the first TreeStore build, then the SDK will revert to a default set of fields (i.e. not everything). When it comes to do the grid, the field doesn't not exist, so it cannot fetch data, so it doesn't bother to call the renderer.

If you add a line "fetch: true" after enableHierarchy, it will probably burst into life. If you don't want to fetch ALL the fields, then specify an array of field to fetch. E.g: fetch: ['FormattedID', 'ObjectID', 'RefinedEstimate', 'PreliminaryEstimate']

answered Jun 08 '18 at 14:15

Nik Antonelli

19
1

Hmmm, are you sure your build and test process is working to plan? – Nik Antonelli Jun 08 '18 at 14:34
This worked for me: launch: function () { console.log("launch()"); Ext.create('Rally.data.wsapi.TreeStoreBuilder').build({ models: ['PortfolioItem/Initiative'], autoLoad: true, enableHierarchy: true, fetch: true }).then({ success: this._onStoreBuilt, scope: this }); }, – Nik Antonelli Jun 08 '18 at 14:49
I've just updated my rally-app-builder, so that should be ok. And I use the App.html after a rally-app-builder build call. Still doesn't work for me. I've created a GitHub project to show my exact code and App.html: https://github.com/michael-jakobsen-dk/GridBoard – Michael Østerberg Jakobsen Jun 11 '18 at 05:35

score 0 · Accepted Answer · answered Aug 10 '18 at 10:38

0

I have gotten a confirmation that this is a bug.

Might not be prioritized due to focus on new framework using React.

answered Aug 10 '18 at 10:38

Michael Østerberg Jakobsen

224
1
15

Grid Column Renderer not called

4 Answers4