GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
PrintTemplate Class
Defines the layout template options used by print
and the PrintViewModel.print()
method to generate the print page.
ArcGIS Maps SDK for JavaScript
public class PrintTemplate : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 PrintTemplate
Constructors
PrintTemplate() Constructor
Parameterless constructor for use as a Razor Component.
public PrintTemplate();
PrintTemplate(Nullable, PrintTemplateExportOptions, Nullable, Nullable, Nullable, Nullable, Nullable, PortalItem, PrintTemplateLayoutOptions, Nullable, Nullable, PortalItem, string, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public PrintTemplate(System.Nullable<bool> attributionVisible=null, dymaptic.GeoBlazor.Pro.Options.PrintTemplateExportOptions? exportOptions=null, System.Nullable<bool> forceFeatureAttributes=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat> format=null, System.Nullable<bool> includeCharts=null, System.Nullable<bool> includeTables=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout> layout=null, dymaptic.GeoBlazor.Core.Components.PortalItem? layoutItem=null, dymaptic.GeoBlazor.Pro.Options.PrintTemplateLayoutOptions? layoutOptions=null, System.Nullable<double> outScale=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Report> report=null, dymaptic.GeoBlazor.Core.Components.PortalItem? reportItem=null, string? reportOptions=null, System.Nullable<bool> scalePreserved=null, System.Nullable<bool> showLabels=null);
Parameters
attributionVisible System.Nullable<System.Boolean>
When false, the attribution is not displayed on the printout.
default true
ArcGIS Maps SDK for JavaScript
exportOptions PrintTemplateExportOptions
Define the map width, height and dpi.
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 “png32”
ArcGIS Maps SDK for JavaScript
includeCharts System.Nullable<System.Boolean>
When true, charts will be included in the printout request.
default false
ArcGIS Maps SDK for JavaScript
includeTables System.Nullable<System.Boolean>
When true, tables will be included in the printout request.
default false
ArcGIS Maps SDK for JavaScript
layout System.Nullable<PrintLayout>
The layout used for the print output.
default “map-only”
ArcGIS Maps SDK for JavaScript
layoutItem dymaptic.GeoBlazor.Core.Components.PortalItem
A custom layout hosted as a portal item.
ArcGIS Maps SDK for JavaScript
layoutOptions PrintTemplateLayoutOptions
Defines the layout elements.
ArcGIS Maps SDK for JavaScript
outScale System.Nullable<System.Double>
The optional map scale of the printed map.
default 0
ArcGIS Maps SDK for JavaScript
report System.Nullable<Report>
The name of the report template.
ArcGIS Maps SDK for JavaScript
reportItem dymaptic.GeoBlazor.Core.Components.PortalItem
A custom report template hosted as a portal item for report printing.
ArcGIS Maps SDK for JavaScript
reportOptions System.String
This object links the various report elements to their data source.
ArcGIS Maps SDK for JavaScript
scalePreserved System.Nullable<System.Boolean>
Define whether the printed map should preserve map scale or map extent.
default true
ArcGIS Maps SDK for JavaScript
showLabels System.Nullable<System.Boolean>
When true, labels will be shown on the layout.
default true
ArcGIS Maps SDK for JavaScript
Properties
PrintTemplate.AttributionVisible Property
When false, the attribution is not displayed on the printout.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> AttributionVisible { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintTemplate.ExportOptions Property
Define the map width, height and dpi.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.PrintTemplateExportOptions? ExportOptions { get; set; }
Property Value
PrintTemplate.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>
PrintTemplate.Format Property
The output format for the printed map.
default “png32”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat> Format { get; set; }
Property Value
PrintTemplate.IncludeCharts Property
When true, charts will be included in the printout request.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IncludeCharts { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintTemplate.IncludeTables Property
When true, tables will be included in the printout request.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IncludeTables { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintTemplate.Layout Property
The layout used for the print output.
default “map-only”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout> Layout { get; set; }
Property Value
PrintTemplate.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
PrintTemplate.LayoutOptions Property
Defines the layout elements.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.PrintTemplateLayoutOptions? LayoutOptions { get; set; }
Property Value
PrintTemplate.OutScale Property
The optional map scale of the printed map.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> OutScale { get; set; }
Property Value
System.Nullable<System.Double>
PrintTemplate.Report Property
The name of the report template.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Report> Report { get; set; }
Property Value
PrintTemplate.ReportItem Property
A custom report template hosted as a portal item for report printing.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.PortalItem? ReportItem { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.PortalItem
PrintTemplate.ReportOptions Property
This object links the various report elements to their data source.
ArcGIS Maps SDK for JavaScript
public string? ReportOptions { get; set; }
Property Value
PrintTemplate.ScalePreserved Property
Define whether the printed map should preserve map scale or map extent.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ScalePreserved { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintTemplate.ShowLabels Property
When true, labels will be shown on the layout.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ShowLabels { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
PrintTemplate.GetAttributionVisible() Method
Asynchronously retrieve the current value of the AttributionVisible property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetAttributionVisible();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.GetExportOptions() Method
Asynchronously retrieve the current value of the ExportOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.PrintTemplateExportOptions?> GetExportOptions();
Returns
System.Threading.Tasks.Task<PrintTemplateExportOptions>
PrintTemplate.GetForceFeatureAttributes() Method
Asynchronously retrieve the current value of the ForceFeatureAttributes property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetForceFeatureAttributes();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.GetFormat() Method
Asynchronously retrieve the current value of the Format property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat>> GetFormat();
Returns
System.Threading.Tasks.Task<System.Nullable<PrintFormat>>
PrintTemplate.GetIncludeCharts() Method
Asynchronously retrieve the current value of the IncludeCharts property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncludeCharts();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.GetIncludeTables() Method
Asynchronously retrieve the current value of the IncludeTables property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncludeTables();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.GetLayout() Method
Asynchronously retrieve the current value of the Layout property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout>> GetLayout();
Returns
System.Threading.Tasks.Task<System.Nullable<PrintLayout>>
PrintTemplate.GetLayoutItem() Method
Asynchronously retrieve the current value of the LayoutItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetLayoutItem();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem>
PrintTemplate.GetLayoutOptions() Method
Asynchronously retrieve the current value of the LayoutOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.PrintTemplateLayoutOptions?> GetLayoutOptions();
Returns
System.Threading.Tasks.Task<PrintTemplateLayoutOptions>
PrintTemplate.GetOutScale() Method
Asynchronously retrieve the current value of the OutScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetOutScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PrintTemplate.GetReport() Method
Asynchronously retrieve the current value of the Report property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Report>> GetReport();
Returns
System.Threading.Tasks.Task<System.Nullable<Report>>
PrintTemplate.GetReportItem() Method
Asynchronously retrieve the current value of the ReportItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetReportItem();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem>
PrintTemplate.GetReportOptions() Method
Asynchronously retrieve the current value of the ReportOptions property.
public System.Threading.Tasks.Task<string?> GetReportOptions();
Returns
System.Threading.Tasks.Task<System.String>
PrintTemplate.GetScalePreserved() Method
Asynchronously retrieve the current value of the ScalePreserved property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetScalePreserved();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.GetShowLabels() Method
Asynchronously retrieve the current value of the ShowLabels property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetShowLabels();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintTemplate.SetAttributionVisible(Nullable) Method
Asynchronously set the value of the AttributionVisible property after render.
public System.Threading.Tasks.Task SetAttributionVisible(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
PrintTemplate.SetExportOptions(PrintTemplateExportOptions) Method
Asynchronously set the value of the ExportOptions property after render.
public System.Threading.Tasks.Task SetExportOptions(dymaptic.GeoBlazor.Pro.Options.PrintTemplateExportOptions? value);
Parameters
value PrintTemplateExportOptions
The value to set.
Returns
PrintTemplate.SetForceFeatureAttributes(Nullable) Method
Asynchronously set the value of the ForceFeatureAttributes property after render.
public System.Threading.Tasks.Task SetForceFeatureAttributes(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
PrintTemplate.SetFormat(Nullable) Method
Asynchronously set the value of the Format property after render.
public System.Threading.Tasks.Task SetFormat(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintFormat> value);
Parameters
value System.Nullable<PrintFormat>
The value to set.
Returns
PrintTemplate.SetIncludeCharts(Nullable) Method
Asynchronously set the value of the IncludeCharts property after render.
public System.Threading.Tasks.Task SetIncludeCharts(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
PrintTemplate.SetIncludeTables(Nullable) Method
Asynchronously set the value of the IncludeTables property after render.
public System.Threading.Tasks.Task SetIncludeTables(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
PrintTemplate.SetLayout(Nullable) Method
Asynchronously set the value of the Layout property after render.
public System.Threading.Tasks.Task SetLayout(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.PrintLayout> value);
Parameters
value System.Nullable<PrintLayout>
The value to set.
Returns
PrintTemplate.SetLayoutItem(PortalItem) Method
Asynchronously set the value of the LayoutItem property after render.
public System.Threading.Tasks.Task SetLayoutItem(dymaptic.GeoBlazor.Core.Components.PortalItem? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.PortalItem
The value to set.
Returns
PrintTemplate.SetLayoutOptions(PrintTemplateLayoutOptions) Method
Asynchronously set the value of the LayoutOptions property after render.
public System.Threading.Tasks.Task SetLayoutOptions(dymaptic.GeoBlazor.Pro.Options.PrintTemplateLayoutOptions? value);
Parameters
value PrintTemplateLayoutOptions
The value to set.
Returns
PrintTemplate.SetOutScale(Nullable) Method
Asynchronously set the value of the OutScale property after render.
public System.Threading.Tasks.Task SetOutScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
PrintTemplate.SetReport(Nullable) Method
Asynchronously set the value of the Report property after render.
public System.Threading.Tasks.Task SetReport(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Report> value);
Parameters
value System.Nullable<Report>
The value to set.
Returns
PrintTemplate.SetReportItem(PortalItem) Method
Asynchronously set the value of the ReportItem property after render.
public System.Threading.Tasks.Task SetReportItem(dymaptic.GeoBlazor.Core.Components.PortalItem? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.PortalItem
The value to set.
Returns
PrintTemplate.SetReportOptions(string) Method
Asynchronously set the value of the ReportOptions property after render.
public System.Threading.Tasks.Task SetReportOptions(string? value);
Parameters
value System.String
The value to set.
Returns
PrintTemplate.SetScalePreserved(Nullable) Method
Asynchronously set the value of the ScalePreserved property after render.
public System.Threading.Tasks.Task SetScalePreserved(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
PrintTemplate.SetShowLabels(Nullable) Method
Asynchronously set the value of the ShowLabels property after render.
public System.Threading.Tasks.Task SetShowLabels(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.