-
Notifications
You must be signed in to change notification settings - Fork 413
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
tdipisa
merged 2 commits into
geosolutions-it:master
from
mbarto:print_custom_scales_doc
Jul 16, 2019
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
* 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
* } | ||
* } | ||
* } | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
boolean