-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #97 from DeetsLM/master
initial report widget documentation
- Loading branch information
Showing
2 changed files
with
285 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,283 @@ | ||
#Report Widget for CMV | ||
Used in conjunction with [jsPDF-AutoTable](https://github.com/simonbengtsson/jsPDF-AutoTable) to create a multi-page PDF report from a single feature or multiple features. See jsPDF-AutoTable documentation for further information. The helper-widget reportReactor.js and its configuration are required to generate reports from the identify window. | ||
|
||
--- | ||
## Example Configuration: | ||
``` javascript | ||
report: { | ||
include: true, | ||
id: 'report', | ||
type: 'invisible', | ||
path: 'widgets/Report', | ||
options: 'config/reportWidget' | ||
}, | ||
reportReactor: { | ||
include: true, | ||
id: 'reportReactor', | ||
type: 'invisible', | ||
path: 'widgets/ReportReactor', | ||
options: { | ||
map: true | ||
} | ||
} | ||
``` | ||
|
||
## Screenshots: | ||
![Screenshot](https://tmcgee.github.io/cmv-widgets/images/report1.jpg) | ||
|
||
![Screenshot](https://tmcgee.github.io/cmv-widgets/images/report2.jpg) | ||
|
||
--- | ||
## Example Search Widget Configuration: | ||
``` javascript | ||
define(null, function () { | ||
|
||
//portrait letter | ||
var pageWidth = 612; | ||
var pageHeight = 792; | ||
var pageCenter = 306; | ||
|
||
//landscape letter | ||
//var pageWidth = 792; | ||
//var pageHeight = 612; | ||
//var pageCenter = 346; | ||
|
||
var colors = { | ||
text: [33, 33, 33], | ||
line: [15, 53, 101], | ||
border: [99, 99, 99], | ||
subheading: [15, 53, 101], | ||
heading: [15, 53, 101], | ||
transparent: [255, 255, 255, 0], | ||
white: [255, 255, 255] | ||
}; | ||
|
||
var fonts = { | ||
text: { | ||
color: colors.text, | ||
size: 11, | ||
font: 'helvetica', | ||
style: 'normal' | ||
}, | ||
heading: { | ||
color: colors.heading, | ||
size: 14, | ||
style: 'bold' | ||
}, | ||
rowHeading: { | ||
color: colors.subheading, | ||
size: 11, | ||
style: 'bold' | ||
}, | ||
footer: { | ||
color: colors.text, | ||
size: 9, | ||
style: 'italic' | ||
} | ||
}; | ||
|
||
var formatOptions = { | ||
currency: { | ||
currency: 'USD', | ||
places: 0 | ||
} | ||
}; | ||
|
||
return { | ||
map: true, | ||
|
||
topicID: 'parcelReportWidget', | ||
|
||
/* | ||
printTaskURL must be on the same server as application | ||
or the server must be configured for CORS | ||
or you can use a proxy | ||
*/ | ||
printTaskURL: 'https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task', | ||
|
||
defaultStyles: { | ||
font: fonts.text, | ||
line: { | ||
width: 0.5, | ||
color: colors.line | ||
}, | ||
rectangle: { | ||
lineWidth: 0.5, | ||
lineColor: colors.border, | ||
fillColor: colors.transparent | ||
} | ||
}, | ||
|
||
reportLayout: { | ||
layout: { | ||
orientation: 'portrait', | ||
unit: 'pt', | ||
format: 'letter' | ||
}, | ||
output: { | ||
type: 'save', | ||
options: 'report.pdf' | ||
}, | ||
margins: { | ||
top: 30, | ||
left: 30, | ||
bottom: 30, | ||
right: 30 | ||
}, | ||
metadata: { | ||
title: 'Parcel Report', | ||
author: 'MoosePoint Technology', | ||
keywords: 'parcel, moosepoint', | ||
creator: 'MoosePoint Technology' | ||
}, | ||
header: { | ||
text: [ | ||
{ | ||
text: 'Anytown USA Parcel Report', | ||
left: 306, | ||
top: 55, | ||
align: 'center', | ||
font: { | ||
color: colors.heading, | ||
size: 20, | ||
style: 'bold' | ||
} | ||
} | ||
], | ||
lines: [ | ||
{ | ||
left: 35, | ||
top: 65, | ||
bottom: 65, | ||
right: pageWidth - 35, | ||
width: 1.5, | ||
color: colors.line | ||
} | ||
], | ||
attributes: [ | ||
{ | ||
top: 35, | ||
left: pageWidth - 140, | ||
layout: 'stacked', | ||
fields: [ | ||
{ | ||
fieldName: 'APN', | ||
label: 'APN' | ||
} | ||
] | ||
} | ||
] | ||
}, | ||
footer: { | ||
text: [ | ||
{ | ||
format: 'date', | ||
left: 38, | ||
top: pageHeight - 30, | ||
font: fonts.footer | ||
}, | ||
{ | ||
format: 'pageNumber', | ||
left: pageCenter, | ||
top: pageHeight - 30, | ||
align: 'center', | ||
font: fonts.footer | ||
}, | ||
{ | ||
text: 'Anytown, USA', | ||
left: pageWidth - 38, | ||
top: pageHeight - 30, | ||
align: 'right', | ||
font: fonts.footer | ||
} | ||
], | ||
lines: [ | ||
{ | ||
left: 35, | ||
top: pageHeight - 40, | ||
bottom: pageHeight - 40, | ||
right: pageWidth - 35, | ||
width: 0.5, | ||
color: colors.line | ||
} | ||
] | ||
}, | ||
map: { | ||
top: 80, | ||
left: 35, | ||
height: 266, | ||
width: 266, | ||
dpi: 144, //multiple of 72 | ||
format: 'JPG', | ||
preserveScale: false, | ||
border: true | ||
}, | ||
text: [], | ||
lines: [], | ||
pages: [], // you can group everything related to each individual page, if desired | ||
groupedItems: [], // for grouped items such as text on top of a graphic or shape | ||
shapes: [], // types: circle, ellipse, rectangle, square, triangle | ||
tables: [], | ||
attributes: [ | ||
{ | ||
layout: 'column', | ||
options: { | ||
margin: {top: 110, left: pageCenter + 5, bottom: 35, right: 0}, | ||
tableWidth: 266, | ||
theme: 'grid', | ||
/*style: tableStyle,*/ | ||
styles: { | ||
fontSize: 10, | ||
cellPadding: 5, | ||
fillColor: colors.white, | ||
valign: 'top', // top, middle, bottom | ||
overflow: 'linebreak', // visible, hidden, ellipsize or linebreak | ||
labelWidth: 95 | ||
} | ||
}, | ||
fields: [ | ||
{ | ||
fieldName: 'SitusFormatted1', | ||
label: 'Situs Formatted 1', | ||
rowHeading: { | ||
text: 'Site Address', | ||
font: fonts.rowHeading | ||
} | ||
}, | ||
{ | ||
fieldName: 'SitusFormatted2', | ||
label: 'Situs Formatted 2' | ||
}, | ||
{ | ||
fieldName: 'MailingDBAorCareOf', | ||
label: 'DBA/Care of', | ||
rowHeading: { | ||
text: 'Mailing Address', | ||
margin: { | ||
top: 20 | ||
}, | ||
font: fonts.rowHeading | ||
} | ||
}, | ||
{ | ||
fieldName: 'MailingAddress1', | ||
label: 'Mailing Address 1' | ||
}, | ||
{ | ||
fieldName: 'MailingAddress2', | ||
label: 'Mailing Address 2' | ||
}, | ||
{ | ||
fieldName: 'MailingAddress3', | ||
label: 'Mailing Address 3' | ||
}, | ||
{ | ||
fieldName: 'MailingAddress4', | ||
label: 'Mailing Address 4' | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}; | ||
}); |