GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Options

TemplateOptions Class

Defines the layout template options used by the Print widget to generate printed output.
ArcGIS Maps SDK for JavaScript

public class TemplateOptions :
System.IEquatable<dymaptic.GeoBlazor.Pro.Options.TemplateOptions>

Inheritance System.Object 🡒 TemplateOptions

Implements System.IEquatable<TemplateOptions>

Constructors

TemplateOptions(Nullable, string, string, IReadOnlyCollection, Nullable, string, Nullable, Nullable, Nullable, Nullable, Nullable, PortalItem, Nullable, Nullable, Nullable, Nullable, string, Nullable) Constructor

Defines the layout template options used by the Print widget to generate printed output.
ArcGIS Maps SDK for JavaScript

public TemplateOptions(System.Nullable<bool> AttributionEnabled=null, string? Author=null, string? Copyright=null, System.Collections.Generic.IReadOnlyCollection<string>? CustomTextElements=null, System.Nullable<double> Dpi=null, string? FileName=null, System.Nullable<bool> ForceFeatureAttributes=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat> Format=null, System.Nullable<int> Height=null, System.Nullable<bool> IncludeTables=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout> Layout=null, dymaptic.GeoBlazor.Core.Components.PortalItem? LayoutItem=null, System.Nullable<bool> LegendEnabled=null, System.Nullable<bool> NorthArrowEnabled=null, System.Nullable<double> Scale=null, System.Nullable<bool> ScaleEnabled=null, string? Title=null, System.Nullable<int> Width=null);

Parameters

AttributionEnabled System.Nullable<System.Boolean>

When false, the attribution is not displayed on the printout.
default true
ArcGIS Maps SDK for JavaScript

Author System.String

The text used for the author if the specified layout contains an author text element.
ArcGIS Maps SDK for JavaScript

Copyright System.String

The text used for the copyright if the specified layout contains an copyright text element.
ArcGIS Maps SDK for JavaScript

CustomTextElements System.Collections.Generic.IReadOnlyCollection<System.String>

Use this prop to display text fields for custom text elements from the print service.
ArcGIS Maps SDK for JavaScript

Dpi System.Nullable<System.Double>

Resolution in dots per inch.
default 96
ArcGIS Maps SDK for JavaScript

FileName System.String

This property only applies when the layout value is map-only.
ArcGIS Maps SDK for JavaScript

ForceFeatureAttributes System.Nullable<System.Boolean>

When true, the feature’s attributes are included in feature collection layers even when they are not needed for
rendering.
default false
ArcGIS Maps SDK for JavaScript

Format System.Nullable<PrintFormat>

The output format for the printed map.
default “pdf”
ArcGIS Maps SDK for JavaScript

Height System.Nullable<System.Int32>

Map height.
ArcGIS Maps SDK for JavaScript

IncludeTables System.Nullable<System.Boolean>

When true, tables will be included in the printout request.
default true
ArcGIS Maps SDK for JavaScript

Layout System.Nullable<PrintLayout>

The layout used for the print output.
default “letter-ansi-a-landscape”
ArcGIS Maps SDK for JavaScript

LayoutItem dymaptic.GeoBlazor.Core.Components.PortalItem

A custom layout hosted as a portal item.
ArcGIS Maps SDK for JavaScript

LegendEnabled System.Nullable<System.Boolean>

When false, the legend is not displayed on the printout.
ArcGIS Maps SDK for JavaScript

NorthArrowEnabled System.Nullable<System.Boolean>

When true, the north arrow will be included on the printout.
ArcGIS Maps SDK for JavaScript

Scale System.Nullable<System.Double>

The map scale of the printed map.
ArcGIS Maps SDK for JavaScript

ScaleEnabled System.Nullable<System.Boolean>

Define whether the printed map should preserve map scale or map extent.
default false
ArcGIS Maps SDK for JavaScript

Title System.String

The text used for the map title if the specified layout contains a title text element.
ArcGIS Maps SDK for JavaScript

Width System.Nullable<System.Int32>

Map width.
ArcGIS Maps SDK for JavaScript

Properties

TemplateOptions.AttributionEnabled Property

When false, the attribution is not displayed on the printout.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> AttributionEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.Author Property

The text used for the author if the specified layout contains an author text element.
ArcGIS Maps SDK for JavaScript

public string? Author { get; set; }

Property Value

System.String

TemplateOptions.Copyright Property

The text used for the copyright if the specified layout contains an copyright text element.
ArcGIS Maps SDK for JavaScript

public string? Copyright { get; set; }

Property Value

System.String

TemplateOptions.CustomTextElements Property

Use this prop to display text fields for custom text elements from the print service.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyCollection<string>? CustomTextElements { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.String>

TemplateOptions.Dpi Property

Resolution in dots per inch.
default 96
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> Dpi { get; set; }

Property Value

System.Nullable<System.Double>

TemplateOptions.FileName Property

This property only applies when the layout value is map-only.
ArcGIS Maps SDK for JavaScript

public string? FileName { get; set; }

Property Value

System.String

TemplateOptions.ForceFeatureAttributes Property

When true, the feature’s attributes are included in feature collection layers even when they are not needed for
rendering.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> ForceFeatureAttributes { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.Format Property

The output format for the printed map.
default “pdf”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat> Format { get; set; }

Property Value

System.Nullable<PrintFormat>

TemplateOptions.Height Property

Map height.
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> Height { get; set; }

Property Value

System.Nullable<System.Int32>

TemplateOptions.IncludeTables Property

When true, tables will be included in the printout request.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> IncludeTables { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.Layout Property

The layout used for the print output.
default “letter-ansi-a-landscape”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout> Layout { get; set; }

Property Value

System.Nullable<PrintLayout>

TemplateOptions.LayoutItem Property

A custom layout hosted as a portal item.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.PortalItem? LayoutItem { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.PortalItem

TemplateOptions.LegendEnabled Property

When false, the legend is not displayed on the printout.
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> LegendEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.NorthArrowEnabled Property

When true, the north arrow will be included on the printout.
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> NorthArrowEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.Scale Property

The map scale of the printed map.
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> Scale { get; set; }

Property Value

System.Nullable<System.Double>

TemplateOptions.ScaleEnabled Property

Define whether the printed map should preserve map scale or map extent.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> ScaleEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

TemplateOptions.Title Property

The text used for the map title if the specified layout contains a title text element.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

TemplateOptions.Width Property

Map width.
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> Width { get; set; }

Property Value

System.Nullable<System.Int32>