• All Files

HTMLReportGenerator

Allows users to create a basic web report of vertically-stacked elements using the geometry and selected attributes from features. HTML output is stored in the html_content attribute for easily writing out to an HTML page using the HTML writer. Supported elements include Text, Tables, Charts (Bar, Line, and Pie), Maps featuring a variety of basemap providers (Esri Leaflet, Mapbox Leaflet, and Google Maps). Styling uses Twitter bootstrap CSS. The output of this transformer links to libraries and CSS files hosted via CDN (Content Delivery Network), so outputs require Internet connectivity to render certain features such as maps and charts.

This output of this transformer is designed to be fed into the HTMLLayouter for the creation of pages with more sophisticated bootstrap grid layouts.

Input Ports

All input is supplied through a single port. Multiple features can be used to create a single output feature storing a single output HTML page in the html_content attribute.

Output Ports

ClosedOutput

This transformer supports Group By and outputs a single feature per group (or simply a single feature if Group By is not used) containing a single HTML page in the html_content attribute. All input attributes (other than the Group By attributes) and geometries will be lost on the output feature.

Parameters

Transformer

ClosedGroup By

If the Group By parameter is set to a set of attributes, one HTML page per group will be produced.

Page Settings

ClosedPage Title

This attribute allows users to specify an HTML title for the output page. This is the title that will appear on the tab in a browser.

Page Contents

This section allows users to add, order, and remove page elements from the list. The output page will display the elements in the order that they are specified in this list. Available elements include Chart (Bar), Chart (Line), Chart (Pie), Header, Image, List, Map (Esri Leaflet), Map (Google), Map (Mapbox Leaflet), Separator, and Table.

The configuration for each element will be set up in the corresponding Content Settings box to the right.

Content Settings

Each element specified in the page contents settings can have input settings specified in the content settings. The options depend on the element type. Options for each type of element are described below:

ClosedChart (Bar)

This element creates a basic responsive bar chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a new bar along the x axis of the chart.

ClosedX Axis Label

This optional text field allows you to place an x axis label on the chart.

ClosedX Tick Label Attribute

This mandatory attribute field controls the values that will appear under each bar along the x-axis.

ClosedY Axis Label

This optional text field allows you to place an y axis label on the chart.

ClosedData Series

This table allows the user to specify multiple different data series for their bar chart. In the Data Attribute column the user should select a numeric attribute that will be plotted as the count data (or the bar height) for a given feature. The Color field allows the user to specify a unique color for each data series.

ClosedChart (Line)

This element creates a basic responsive line chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a new point along the x axis of the chart.

ClosedX Axis Label

This optional text field allows you to place an x axis label on the chart.

ClosedX Tick Label Attribute

This mandatory attribute field controls the values that will appear under each bar along the x-axis. Note that datapoints will always be evenly spaced along the x axis. If you require the flexibility to have non-uniformly spaced x axis values, consider using the ChartGenerator transformer to generate a static chart image that can be added to the page as an “Image” element.

ClosedY Axis Label

This optional text field allows you to place an y axis label on the chart.

ClosedData Series

This table allows the user to specify multiple different data series for their line chart. In the Data Attribute column the user should select a numeric attribute that will be plotted as the y axis data (or the point height) for a given feature. The Color field allows the user to specify a unique color for each data series.

ClosedChart (Pie)

This element creates a basic responsive pie chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a slice in the pie chart.

ClosedLabel Attribute

This mandatory attribute field controls the labels for each slice of the pie chart, that will be used in both the tooltip and chart legend.

ClosedData Attribute

This value of this numeric attribute will determine the size of a given slice. Slices will be weighted according to the value of this attribute.

ClosedColor Scheme

Here a color scheme can be specified for the pie chart. Options include Red to White, Blue to White, Red to Green, Rainbow, Pastel and Dark.

ClosedHeader

Allows the user to enter text either as a header or paragraph form.

ClosedText

Required parameter that allows the user to enter text to appear in the page.

ClosedHeader Level

This allows the user to set the header level of the text. If set to None, the text will be added at regular paragraph (<p> tag) size.

ClosedIdentifier

Optional parameter that allows the user to specify the id attribute for this header or paragraph element. If left blank, no id attribute will be set.

ClosedText Alignment

Allows the user to specify the alignment of the text on the page. Options include Left, Right, Center and Justified.

ClosedColor

Allows the user to specify a color for the text.

ClosedImage

This element allows the user to either link to or embed an image in their page.

ClosedAttachment Method

This setting allows the user to choose whether they want to link to an image using a URL or a relative path or to embed the actual content of the image within their page. Note that the latter option may bloat the size of the HTML page considerably for larger images.

ClosedImage URL

This option is only enabled when the Attachment Method is set to Link. It allows the user to specify an image via a relative path or external URL.

ClosedImage File

This option is only enabled when the Attachment Method is set to Embed. It allows the user to specify an image on the disk to embed within the page. This parameter expects a valid path to a png or jpeg file. If setting this path from an attribute, the user must ensure that the image exists on disk at the time the features hit this transfomer. In the event you wish to use an image dynamically created as part of a workflow, consider using the FeatureWriter transformer before this transformer to write this image to disk and use it within the report within a single workspace.

ClosedAlternate Text

This optional parameter allows one to specify text that will be displayed in the event the image fails to load.

ClosedList

Allows the user to create a list of text from an attribute.

ClosedList Item Content

The attribute that will be used to populate the list values one entry per feature.

ClosedList Item Markers

This option specifies whether the list will be marked with bullets, letters, numbers, roman numerals or nothing.

ClosedText Color

Allows the user to set a color for the list text.

ClosedBadge Content

This attribute can only be set if List Item Markers is set to None. In the event this is set, bootstrap style badges will be set on the right-hand side of the list.

ClosedMap (Esri Leaflet)

This element allows the user to create a simple webmap featuring the geometries of input features as a layer.

Note: The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use.

ClosedLabel Attribute

This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip.

ClosedLayer Color

This option allows the user to specify a color for the layer.

ClosedBasemap

This option allows the user to select from the list of available Esri Basemaps. Options include: Street, Terrain, Satellite, Gray, Dark Gray, Shaded Relief, Topographic, and National Geographic.

ClosedFeature Layer URL(s)

This parameter allows the user to specify a list of comma delimited ArcGIS Online feature layer URLs, that will be displayed as additional layers on the map.

ClosedMap (Google)

This element allows the user to create a simple webmap featuring the geometries of input features as a layer. Note that this transformer only supports a single Google map per page. To create a web page with multiple Google maps, you must create multiple pages (using Group By or multiple HTMLReportGenerator transformers) and then reassemble these into a single page using the HTMLLayouter transformer.

Note: The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use.

ClosedLabel Attribute

This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip.

ClosedLayer Color

This option allows the user to specify a color for the layer.

ClosedAccess Token

This optional field allows the user to specify their Google Maps API Access token. Note that this is not required to create a simple Google Maps webmap.

ClosedMap (Mapbox Leaflet)

This element allows the user to create a simple webmap featuring the geometries of input features as a layer. Note this page element requires the user to create or possess a Mapbox account to obtain a Mapbox access token. Visit http://www.mapbox.com to create a free account.

Note: The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use.

ClosedLabel Attribute

This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip.

ClosedLayer Color

This option allows the user to specify a color for the layer.

ClosedAccess Token

This mandatory field allows the user to specify their Mapbox API Access token. This token is required for the basemap to render correctly.

ClosedMap Id

This allows the user to input the map id of a map created with their Mapbox account. The default is set to mapbox.streets as this map should be present on all accounts.

ClosedSeparator

Allows the user to set a separator element or <hr> tag.

ClosedSeparator Thickness (pixels)

This integer parameter controls the width of the separator.

ClosedTable

This element creates a basic HTML table featuring data from attributes.

ClosedTable Style

Allows the user to choose between several bootstrap table styles including: Striped, Bordered and Condensed. The Default style is Bordered.

ClosedColumn Settings

This table allows the user to configure the columns of the output HTML table. The ‘Column Contents’ column must be set to an attribute value. These values will appear as the rows of the column. The ‘Column Name’ field allows the user to specify a name for each column.

ClosedCustom HTML

Allows the user to enter custom HTML.

ClosedCustom HTML

Raw HTML-formatted text that will be inserted into the output page. The user should ensure that the text is valid HTML.

ClosedPreview in Browser

This button at the bottom of the transformer allows the user to view a preview of the page they are creating in their default browser. Clicking this button will show a preview of the rough layout of the page. Preview generation may not work while some parameters are in the invalid state. The final page will in many cases look different as the preview is unaware of the actual values that will be sent in at run-time.

Editing Transformer Parameters

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

Transformer Categories

Format Specific

Web

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for samples and information about this transformer on the FME Community.