Module Print

Returns all available paper formats.

Different sizes are available: "letter" | "legal" | "a3" | "a4".

deprecated

will be removed in the futur

example

// returns all available paper formats
JMap.Application.Print.getAllPaperFormats()

Returns the current type of the file, that is used when downloading the print.

One of the following: "png" | "jpeg" | "pdf"

example

// returns "png", "jpeg", or "pdf"
JMap.Application.Print.getFileType()

Returns true if the map export is set to hi resolution, false otherwise.

example

// get export resolution
JMap.Application.Print.getHiResolution()
// true

Returns the subtitle displayed in the bottom of the print layout.

example

// returns the displayed subtitle
JMap.Application.Print.getPageSubTitle()

Returns the title displayed in the bottom of the print layout.

example

// returns the displayed title
JMap.Application.Print.getPageTitle()

Returns the active paper format.

deprecated

will be removed in the futur

example

// returns active paper format
JMap.Application.Print.getPaperFormat()

Returns true if the date is displayed in the bottom of the print layout.

example

// returns true if the date is visible
JMap.Application.Print.isDateVisibile()

Returns true if the north arrow is displayed in the bottom of the print layout.

example

// returns true if the north arrow is visible
JMap.Application.Print.isNorthArrowVisible()

Returns true if the print layout is portrait, else false (landscape).

example

// returns true if the print layout is portrait, else false (landscape)
JMap.Application.Print.isOrientationPortrait()

Returns true if the scale control widget is visible, else false.

example

// true if the scale controle widget is displayed
JMap.Application.Print.isScaleControlVisible()

Sets the date visible or hidden in the bottom of the print layout.

example

// Hide the date
JMap.Application.Print.setDateVisibility(false)

// Show the date
JMap.Application.Print.setDateVisibility(true)

Sets the type of file used when downloading the print.

throws

if fileType is not correct

example

// set the layout as portrait
JMap.Application.Print.setFileType("pdf")

Sets the parameter determining if the map will be exported in hi resolution or not.

throws

if isHiResolution is not a boolean

example

// set export mode to hi resolution
JMap.Application.Print.setHiResolution(true)

Sets the north arrow visible or hidden in the bottom of the print layout.

example

// Hide the north arrow
JMap.Application.Print.setNorthArrowVisibility(false)

// Show the north arrow
JMap.Application.Print.setNorthArrowVisibility(true)

Sets the print layout orientation as portrait or landscape.

throws

if isPortrait is not a boolean

example

// set the layout as portrait
JMap.Application.Print.setOrientation(true)

// set the layout as landscape
JMap.Application.Print.setOrientation(false)

Sets the subtitle displayed in the bottom of the print layout.

throws

if subTitle is not a string

example

// set subtitle
JMap.Application.Print.setPageSubTitle("My custom subtitle")

Sets the title displayed in the bottom of the print layout.

If empty string, will display no title.

throws

if title is not a string

example

// set title
JMap.Application.Print.setPageTitle("My custom title")

Sets the paper format of the print layout.

Technical method, you should not use it.

deprecated

will be removed in the futur

throws

if format is incorrect

example

// set the letter paper format
JMap.Application.Print.setPaperFormat("letter")

Displays or hides the scale control widget.

example

// Display the scale
JMap.Application.Print.setScaleControlVisibility(true)

// Hide the scale
JMap.Application.Print.setScaleControlVisibility(false)

Builds print image and launches downwnload of the file

example

// build print image and launch downwnload of the file
JMap.Application.Print.takeCapture()