Current location: Cadcorp SIS Book Plotter > Appendix

Appendix

User-defined Regular Grid File

User-defined Regular grids created by the Book Plotter are stored as text files in the following format:

14,14 Matrix size (WxH)
250,150 Cell size (WxH)

484513.383067418,106534.221236079
00001111111100
00001111111110
00001111111110
00011111111110
00011111111110
00111111111100
00111111111100
01111111111000
01111111110000
01111111110000
01111111110000
01111111111000
01111111110000
00111111110000 

The remaining lines indicate which cells are to be printed as pages, and which cells are to be omitted. Pages are numbered starting at the first 'active' cell counting from the top left, moving from left to right in each row.

It is therefore possible for a single grid matrix to cover more than one discrete area of mapping, e.g. two disjoint districts.

1=N5
2=N6
3=N7
4=N8
5=N9
....
9=M5
10=M6
[Optional]
Grid cells, numbered left to right, top to bottom, may be assigned any text as an alternative reference to the page number.
References relate only to cells flagged with 1.
Missing references will adopt the default page numbering sequence.

User-defined Flexible Grid File

User-defined Flexible Grids created by the Book Plotter are stored as xml files in the following format:

Attributes used on Book Plotter Items

User-defined Regular Grids before Saving

Before saving a user-defined Regular Grid as text file, the grid matrix is created as an array of rectangular area items each holding the following attributes:

Attribute Name  Purpose Typical value

BookCol&

 

The column number of the cell within the matrix. Columns are numbered from the left starting at 1.

1

 

BookRow&

 

The row number of the cell within the matrix. Rows are numbered from the top starting at 1.

1

 

BookPlotConfig$ The format of the matrix, as number of columns, number of rows, cell width, cell height. 14,14,250,150

BookCellRef$

 

[Optional] Any text which will be used in preference to page numbers in continuation and page number markers.

e.g A1, 3GG,
Zone 4, 6th Precinct, etc.

User-defined Flexible Grids before Saving

Before saving a user-defined Flexible Grid as an xml file, the grid matrix is created as an array of rectangular area items each holding the following attributes:

Attribute Name  Purpose Typical value

BP_mode&

 

The column number of the cell within the matrix. Columns are numbered from the left starting at 1.

1

 

BP_page&

 

The page number of the cell within the matrix. Rows are numbered from the top starting at 1.

1

 

BP_scale& The scale of the cell. 1250, 2500, etc.

BP_template$

 

The name of the template

Cadcorp Classic.A4 Portrait, Cadcorp Classic.A3 Landscape, etc.

BP_title$ The title of the grid MyGrid

Grids on the Plot Index Overlay

When the Book Plotting process is started, a grid is created on a new internal overlay named Plot Index. The entire grid is created as a single Group item. Exploding this group will decompose the grid into its constituent cells, each of which holds the following attributes:

Attribute Name Purpose Typical value

SheetNo$

 

The page or sheet number of an individual cell.

1

 

BookCellRef$

 

[Optional] The user-defined cell reference as specified in the grid file.

A1

 

Page Continuation Markers

Page Continuation Markers on a print template are detected by Book Plotter and are used to indicate the number of the adjoining page in the grid. If there is no adjoining page, the marker display will be suppressed. If user-defined cell references are used these will be substituted for the page number. Page Continuation Markers hold the following attribute:

Attribute Name Purpose Typical value

SheetNo$

 

The word North, South, East or West in the attribute value will be replaced by the adjoining page number or user-defined cell reference of the diagonally adjacent cell, if any. Diagonal markers use the words NW, NE, SW and SE, and will be replaced by the page number or user-defined cell reference of the diagonally adjacent cell, if any.

 "Continued on Page North"

 

Page Number Markers

Page Number Markers on a print template are detected by Book Plotter and are used to indicate the number of the current page in the grid. Page Number Markers hold the following attributes:

Attribute Name Purpose Typical value

Prompt$

 

If the value is "SheetN" the text of the item will be set to the current page number or user-defined cell reference, preceded by the value of the Prefix$ attribute, separated by a space.

"SheetN"


Prefix$

Prefix text for the page number.

"Page"

Page Sequence Markers

Page Number Markers on a print template are detected by Book Plotter and are used to indicate the number of the current page in the grid. Page sequences always use page numbers, irrespective of whether user-defined cell references have been set. Page Number Markers hold the following attributes:

Attribute Name Purpose Typical value

Prompt$

If the value is "SheetN_of_NN" the text of the item will be set to the current page number and the total pages, preceded by the value of the Prefix$ attribute, separated by a space.

"SheetN_of_NN"


Prefix$

Prefix text for the page number.

"Page"

The Plot Index Marker

The Plot Index Marker is a rectangular Area item holding the following attribute:

Attribute Name Purpose Typical value

PlotIndex&

 

If the value of this attribute is -1 a Plot Index of the same size and proportions will replace the area item.

-1 (True)

Overlap Styles

Overlap Styles are used when displaying the area of overlap of adjacent pages. The Map Frame item on the template holds the following attributes:

Attribute Name Purpose Typical JSON value

Overlap_Brush$

The shading of the overlap area will be displayed in this brush style.

{"Brush":{"Style":"Solid","Colour":{"RGBA":[224,224,224,59]}}}

Overlap_Pen$

The outline of the overlap area will be displayed in this pen style.

{"Pen":{"Style":"Null","Colour":{"RGBA":[0,0,0,0]}}}

 


Top of page

Send comments on this topic.

Click to return to www.cadcorp.com

© Copyright 2000-2017 Computer Aided Development Corporation Limited (Cadcorp).