CartoBuilder (Groovy Documentation)

```
interface CartoBuilder
```
Create a cartographic map
Authors:
Jared Erickson

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract void`	`build(java.io.OutputStream outputStream)` Write the cartographic document to the OutputStream
	`abstract CartoBuilder`	`dateText(DateTextItem dateTextItem)` Add a date
	`abstract CartoBuilder`	`grid(GridItem gridItem)` Add a grid (usually for visually placing other items)
	`abstract CartoBuilder`	`image(ImageItem imageItem)` Add an image
	`abstract CartoBuilder`	`legend(LegendItem legendItem)` Add a legend
	`abstract CartoBuilder`	`line(LineItem lineItem)` Add a line
	`abstract CartoBuilder`	`map(MapItem mapItem)` Add a Map
	`abstract CartoBuilder`	`northArrow(NorthArrowItem northArrowItem)` Add a north arrow
	`abstract CartoBuilder`	`overViewMap(OverviewMapItem overviewMapItem)` Add an overview Map
	`abstract CartoBuilder`	`paragraph(ParagraphItem paragraphItem)` Add a paragraph
	`abstract CartoBuilder`	`rectangle(RectangleItem rectangleItem)` Add a rectangle
	`abstract CartoBuilder`	`scaleBar(ScaleBarItem scaleBarItem)` Add scale bar
	`abstract CartoBuilder`	`scaleText(ScaleTextItem scaleTextItem)` Add scale text
	`abstract CartoBuilder`	`table(TableItem tableItem)` Add a table
	`abstract CartoBuilder`	`text(TextItem textItem)` Add text

- Method Detail
  - abstract void build(java.io.OutputStream outputStream)
    
    Write the cartographic document to the OutputStream
    Parameters:
    outputStream - The OutputStream
  - abstract CartoBuilder dateText(DateTextItem dateTextItem)
    
    Add a date
    Parameters:
    dateTextItem - The DateTextItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder grid(GridItem gridItem)
    
    Add a grid (usually for visually placing other items)
    Parameters:
    gridItem - The GridItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder image(ImageItem imageItem)
    
    Add an image
    Parameters:
    imageItem - The ImageItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder legend(LegendItem legendItem)
    
    Add a legend
    Parameters:
    legendItem - The LegendItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder line(LineItem lineItem)
    
    Add a line
    Parameters:
    lineItem - The LineItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder map(MapItem mapItem)
    
    Add a Map
    Parameters:
    mapItem - The MapItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder northArrow(NorthArrowItem northArrowItem)
    
    Add a north arrow
    Parameters:
    northArrowItem - The NorthArrowItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder overViewMap(OverviewMapItem overviewMapItem)
    
    Add an overview Map
    Parameters:
    overviewMapItem - The OverviewMapItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder paragraph(ParagraphItem paragraphItem)
    
    Add a paragraph
    Parameters:
    paragraphItem - The ParagraphItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder rectangle(RectangleItem rectangleItem)
    
    Add a rectangle
    Parameters:
    rectangleItem - The RectangleItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder scaleBar(ScaleBarItem scaleBarItem)
    
    Add scale bar
    Parameters:
    scaleBarItem - The ScaleBarItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder scaleText(ScaleTextItem scaleTextItem)
    
    Add scale text
    Parameters:
    scaleTextItem - The ScaleTextItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder table(TableItem tableItem)
    
    Add a table
    Parameters:
    tableItem - The TableItem
    Returns:
    The CartoBuilder
  - abstract CartoBuilder text(TextItem textItem)
    
    Add text
    Parameters:
    textItem - The TextItem
    Returns:
    The CartoBuilder

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Interface CartoBuilder

Methods Summary

Method Detail

abstract void build(java.io.OutputStream outputStream)

abstract CartoBuilder dateText(DateTextItem dateTextItem)

abstract CartoBuilder grid(GridItem gridItem)

abstract CartoBuilder image(ImageItem imageItem)

abstract CartoBuilder legend(LegendItem legendItem)

abstract CartoBuilder line(LineItem lineItem)

abstract CartoBuilder map(MapItem mapItem)

abstract CartoBuilder northArrow(NorthArrowItem northArrowItem)

abstract CartoBuilder overViewMap(OverviewMapItem overviewMapItem)

abstract CartoBuilder paragraph(ParagraphItem paragraphItem)

abstract CartoBuilder rectangle(RectangleItem rectangleItem)

abstract CartoBuilder scaleBar(ScaleBarItem scaleBarItem)

abstract CartoBuilder scaleText(ScaleTextItem scaleTextItem)

abstract CartoBuilder table(TableItem tableItem)

abstract CartoBuilder text(TextItem textItem)