smas1 / geoext-viewer

Automatically exported from code.google.com/p/geoext-viewer
GNU General Public License v3.0
0 stars 0 forks source link

Consistent variable name for height/width - printDialog #326

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Currently there are two parameters for controlling the height/width of a print 
preview dialog:

windowWidth
mapPreviewHeight

I'd suggest one of them (windowWidth?) be renamed so they both follow a 
consistent pattern.

Original issue reported on code.google.com by jonathan...@warwickshire.gov.uk on 3 Jan 2014 at 12:58

GoogleCodeExporter commented 9 years ago
Hmm - for clarification: 'windowWidth' is controlling the width of the dialog 
box (see 'ToolbarBuilder.js'). With 'mapPreviewHeight' you can configure the 
height of the preview map INSIDE the dialog if 'mapPreviewAutoHeight' is 
disabled - have a look at the 'PrintPreview.js' code:
...
    /** api: config[mapPreviewAutoHeight]
     *  ``Boolean`` Set to false if no automatic preview map height adjustment
     *  should be done. Default is true.
     */
    mapPreviewAutoHeight: true,

    /** api: config[mapPreviewHeight]
     *  ``Integer`` Static height of the preview map, if no automatic height
     *  adjustment is set by 'mapPreviewAutoHeight'. Default is 250.
     */
    mapPreviewHeight: 250,
...
I'd suggest to keep the terms.

Original comment by wolfram.winter on 6 Jan 2014 at 11:44

GoogleCodeExporter commented 9 years ago
Ah ok. I get that and know why the change was made. But at the same time I can 
see it potentially confusing users (or them not being aware of the difference) 
- it got me after all and I'd read the tickets that lead to this change!

I guess it would be difficult to add a "mapPreviewWidth" or a "windowHeight" 
and then remove whatever the other one is? Or maybe not remove the other one.
Just thinking aloud, not sure what the solution is but the current setup is 
definitely confusing.

Original comment by jonathan...@warwickshire.gov.uk on 6 Jan 2014 at 1:09

GoogleCodeExporter commented 9 years ago
Hi Jonathan,
yes, ok - I've had a look on the source modules, and you are right: the 
documentation could be better! I suggest to insert some comments - starting in 
the PrintPreview.js module and then transfer it as an extended comment to the 
config.js modules in the example section to document the width of the dialog 
window and the height of the preview map. 

Original comment by wolfram.winter on 7 Jan 2014 at 1:44