Skip to main content

@mapgear/geoapps > Prints

Prints class

Provides access to the Prints functionality. Can be accessed through the Map.Prints-property.

Signature:
export declare class Prints

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Prints class.

Example

An example of the usage:

// Connect as anonymous user to a geoapps environment
geoapps.Initialize("<specified tenant>");

// Add the map to a div with element id `map`
var map = geoapps.AddMap("map", "<mapId>");

// Wait till the map loaded, before starting prints
map.onLoaded.add(() => {
   // Disable print preview
   map.Prints.DisablePreview();

   // Enable print preview
   map.Prints.EnablePreview();

   // Print the map to a PDF file
   map.Prints.Print(<options>);

   // Update print preview based on options input
   map.Prints.UpdatePreview(<options>);
});

Methods

MethodModifiersDescription
DisablePreview()Disable print preview
DisablePrintPreview()Method is deprecated, use DisablePreview()
EnablePreview(options)Retrieves extent for printing and calls extension to project print preview on the map
EnablePrintPreview(options)Method is deprecated, use EnablePreview()
Print(options)Creates a permalink that is used for a view that can be printed
UpdatePreview(options)Updates print preview