Class: PrintDialog2x

ol.control. PrintDialog2x

Print control to get an image of the map


new PrintDialog2x()

Extends

Members


_labels

Print dialog labels (for customisation)

Inherited From:
Overrides:

formats

List of legeng options * / ol.control.PrintDialog.prototype.legendOptions = { off: 'Hide legend', on: 'Show legend' }; /** List of print image file formats

Inherited From:
Overrides:

marginSize

List of margin size

Inherited From:
Overrides:

paperSize

List of paper size

Inherited From:
Overrides:

scales

List of print scale

Inherited From:
Overrides:

Methods


getContentElement()

Get dialog content element

Inherited From:
Overrides:
Returns:
Type
Element

getMap2()

Set the second map to print

Returns:
Type
ol.Map

getMargin()

Get print margin

Inherited From:
Overrides:
Returns:
Type
number

getOrientation()

Get print orientation

Inherited From:
Overrides:
Returns:
Type
string

getPage()

Get page element

Inherited From:
Overrides:
Returns:
Type
Element

getPrintControl()

Get print control

Inherited From:
Overrides:
Returns:
Type
ol.control.Print

getScale()

Get the current map scale factor

Inherited From:
Overrides:
Returns:
Type
number

getSize()

Get print size

Inherited From:
Overrides:
Returns:
Type
ol.size

getUserElement()

Get dialog user element

Inherited From:
Overrides:
Returns:
Type
Element

i18n(what)

Translate

Parameters:
Name Type Description
what string
Inherited From:
Overrides:
Returns:
Type
string

isOpen()

Check if the dialog is oprn

Inherited From:
Overrides:
Returns:
Type
boolean

print(options)

Show print dialog

Parameters:
Name Type Description
options *
Properties
Name Type Description
size ol/size | string

map size as ol/size or A4, etc.

value number | string

the scale factor or a scale string as 1/xxx

orientation string

landscape or portrait

margin number
Inherited From:
Overrides:

setMap(map)

Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

Parameters:
Name Type Description
map ol.Map

Map.

Inherited From:
Overrides:

setMap2(map)

Set the second map to print

Parameters:
Name Type Description
map ol.Map

setMargin(margin)

Set print margin

Parameters:
Name Type Description
margin number
Inherited From:
Overrides:

setOrientation(ori)

Set print orientation

Parameters:
Name Type Description
ori string

landscape or portrait

Inherited From:
Overrides:

setScale(value)

Set the current scale (will change the scale of the map)

Parameters:
Name Type Description
value number | string

the scale factor or a scale string as 1/xxx

Inherited From:
Overrides:

setSize(size)

Set map print size

Parameters:
Name Type Description
size ol/size | string

map size as ol/size or A4, etc.

Inherited From:
Overrides: