Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#3863: improved Print plugin documentation with info on printing usin… #3975

Merged
merged 2 commits into from
Jul 16, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions web/client/plugins/Print.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,36 @@ require('./print/print.css');
* @memberof plugins
* @static
*
* @prop {boolean} cfg.useFixedScales if true the printing scale is constrained to the nearest scale of the ones configured
* in the config.yml file, if false the current scale is used
* @prop {object} cfg.overrideOptions overrides print options, this will override options created from current state of map
* @prop {bool} cfg.overrideOptions.gedetic print in geodetic mode
* @prop {bool} cfg.overrideOptions.geodetic prints in geodetic mode: in geodetic mode scale calculation is more precise on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

boolean

* printed maps, but the preview is not accurate
* @prop {string} cfg.overrideOptions.outputFilename name of output file
* @prop {object} cfg.mapPreviewOptions options for the map preview tool
* @prop {bool} cfg.mapPreviewOptions.enableScalebox if true a combobox to select the printing scale is shown over the preview
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

boolean

* this is particularly useful if useFixedScales is also true, to show the real printing scales
* @prop {bool} cfg.mapPreviewOptions.enableRefresh true by default, if false the preview is not updated if the user pans or zooms the main map
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

boolean

*
* @example
* // printing in geodetic mode
* {
* "name": "Print",
* "cfg": {
* "overrideOptions": {
* "gedetic": false
* "geodetic": true
* }
* }
* }
*
* @example
* // Using a list of fixed scales with scale selector
* {
* "name": "Print",
* "cfg": {
* "useFixedScales": true,
* "mapPreviewOptions": {
* "enableScalebox": true
* }
* }
* }
Expand Down