global javascript file and handlebar helpers

[evildmguy]

Rather than make a new topic, again, I will ask a semi-related question here.

Is there a way to access the localizedResource in the global javascript file? Or do I have to do some init() type initialization? My intent is to make localization easier in the scripts for others who read it. This would allow me to parse the localization file out to the parts we create with better names.

I guess that brings up, I know there is beforeRender, is there an initialize event to do this?

Thanks!

edg

[jan_blaha]

What you you mean with "global javascript file"? I'm not sure I get your intentions.

[evildmguy]

I have a js file marked as "shared helpers attached to each template." That allows me to use any functions I create across all the templates.

Is there an onInit() or similar call I can do so I can pass my localizations ($localizedResource) and have them available in some global variable I set? This is going to allow me to create functions with parameters like getDataColumnName(database, column, value) instead of needing to know the localizedResource file?

I do read the examples and items on the learn page but it's not clicking with me how I could do this or if it's even possible. I wish I could understand why!

Thanks!

edg

[jan_blaha]

This is a bit hack. But does it help to reach your goal?
https://playground.jsreport.net/studio/workspace/VkLWfMyMb/120

Basically the shared helpers doesn't have an event like onInit. It is just evaluated before templating engine runs. You can use any global code to do the init like recalculating the inputs.

[evildmguy]

Thanks! I think the "this.m.data.$localizedResource" was the main thing I was wanting.

I appreciate it!

edg

[evildmguy]

Sigh. More questions. Do you have underscore or lodash in jsReports? How do I use them in a javascript file? This is where WebStorm isn't helping because when I typed _.find(. . . ) it helped me complete that but then jsReports itself says that it doesn't have _ defined. Is it just a matter of putting any extras like that in a <script> area?

Thanks!

edg

[bjrmatos]

you are trying to use lodash/underscore in your shared helper/or any other helper, right?

in order to user lodash/underscore first you need to allow them in jsreport, to do that you need to set allowedModules config.
to allow modules for helpers the configuration is tasks: { allowedModules: [value here] }, for jsreport scripts the configuration is scripts: { allowedModules: [value here] }. you can use allowedModules: '*' as a value if you just want to allow everything or if you want to be specific allowedModules: ['lodash'], just be sure to have installed the module that you want to use first (for example doing npm install lodash or for other external dependencies in your project).

then just require the module in your helper (just like you have done require('handlebars') in the past`.

// helper
var _ = require('lodash')

function hasId(data) {
  return _.has(data, ['id']) 
}

[jan_blaha]

Or update node version and use native ES8 function instead :)

[evildmguy]

lol - I'm on 8.9.4. Does that have them? If so, how do I get to them in jsReports?

Again, thanks for your patience with me in all of this!

[bjrmatos]

lol - I'm on 8.9.4. Does that have them? If so, how do I get to them in jsReports?

Jan was just recommending that if you have modern node.js you should try to not use lodash/underscore and just use native modern javascript functions like (.find, .includes, keys), but if you really have the need for lodash/underscore (maybe you are going to use other kind of utilities in these libraries) then you should follow the step above that i gave.

[evildmguy]

I installed jquery and put in var $ = require('jquery') and that seems to be fine and recognized.

Then, in a function, I have $("#testing").innerHTML += "<div>test</div>" but get an error. What did I do wrong?

Error occured - Error during rendering report: jQuery requires a window with a document
Stak - C:\dev\src\apps\JsReports\node_modules\jquery\dist\jquery.js:31
throw new Error( "jQuery requires a window with a document" );
^

Error: jQuery requires a window with a document
at module.exports (C:\dev\src\apps\JsReports\node_modules\jquery\dist\jquery.js:31:12)
at Object.stuffItIntoThere (evalmachine.<anonymous>:102:5)
at eval (eval at createFunctionContext (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\compiler\javascript-compiler.js:254:23), <anonymous>:6:217)
at prog (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\runtime.js:219:12)
at execIteration (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\helpers\each.js:51:19)
at Object.<anonymous> (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\helpers\each.js:61:13)
at Object.eval [as main] (eval at createFunctionContext (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\compiler\javascript-compiler.js:254:23), <anonymous>:62:31)
at main (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\runtime.js:173:32)
at ret (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\runtime.js:176:12)
at ret (C:\dev\src\apps\JsReports\node_modules\jsreport-handlebars\node_modules\handlebars\dist\cjs\handlebars\compiler\compiler.js:525:21)

Thanks!

edg

[bjrmatos]

you can't use jQuery in a helper file, because the helper runs server side, in which a window, document or the DOM does not exists, that is the reason of your error.

if you want to use jQuery in the context of the web page that your template outputs, then you must include jquery as an asset inside a script tag, you can find an example of that here

[evildmguy]

Okay, thanks!

[evildmguy]

How do I get the shortId of a report in code? I have a header template that has the report title. In my localization file, I have report titles by their shortIds, but I don't know how to get a report's shortId?

Thanks!

[bjrmatos]

hi @evildmguy, the quick way to see the shortid of a template is right in the studio, open a template in the studio and you will se the URL changed to something like this http://localhost:4000/studio/templates/HJXE5dkwG where HJXE5dkwG is the shortid of that template.

also when you have a template open in studio you will see there is a "Link" button which you can click to get the full url that also contains the shortid.

[evildmguy]

Yes . . . but I want to get it programatically and pass it to another template. How do I do that?

[bjrmatos]

you can try something like this (using a jsreport script), it will work as long as you only use stored templates (and not inline template content) when doing requests to jsreport.

[evildmguy]

Well, at least I think I have learned enough to help you help me! I hope.

https://playground.jsreport.net/studio/workspace/HkHqEFkDf/15

If you run ShortIdSource report, I want "SJLLrPlvf" the id of ShortIdSource, to appear in the quotes at Value in Header: "" line.

I want to pass the id of ShortIdSource to reportHeader. How do I do that?

Thanks for your patience!

[bjrmatos]

here is updated code https://playground.jsreport.net/studio/workspace/HkHqEFkDf/22

header will receive the shortid of parent template in parentTemplateShortId

[evildmguy]

That worked! Thanks a lot!