Single Polygon Layer Map

Author(s)
Library ID	docs_map
Tool ID	6
Version	1.0
Menu	File \| Map Production

Description

Parameters

	Name	Type	Identifier	Description	Constraints
Input	Polygons Layer	shapes, input	`LAYER`	-	-
Options	File	file path	`FILE`	-	-
	Size	choice	`MAP_SIZE`	-	Available Choices: [0] width and height [1] width and fitted height [2] height and fitted width Default: 0
	Width	integer number	`MAP_WIDTH`	-	Minimum: 1 Default: 1000
	Height	integer number	`MAP_HEIGHT`	-	Minimum: 1 Default: 1000
	Floating Point Numbers	choice	`TABLE_FLT_STYLE`	Specify floating point decimal precision in table and similar views.	Available Choices: [0] system default [1] compact [2] fix number of decimals Default: 1
	Decimals	integer number	`TABLE_FLT_DECIMALS`	-	Minimum: 0 Default: 6
	Map Legends	boolean	`LEGEND_SHOW`	Include in map legends.	Default: 1
	Orientation	choice	`LEGEND_ORIENTATION`	-	Available Choices: [0] vertical [1] horizontal Default: 0
	Title	choice	`LEGEND_TITLE`	-	Available Choices: [0] data set [1] user defined [2] none Default: 0
	User Defined	text	`LEGEND_TITLE_TEXT`	-	Default: Title
	Field Labeling	choice	`LEGEND_FIELD`	-	Available Choices: [0] automatic [1] user defined [2] none Default: 0
	User Defined	text	`LEGEND_FIELD_TEXT`	-	Default: Label
	Show at all scales	boolean	`SHOW_ALWAYS`	-	Default: 1
	Scale Range	value range	`SHOW_RANGE`	only show within scale range; values are given as extent measured in map units	Default: 100; 1000
	Transparency	floating point number	`TRANSPARENCY`	Transparency specified as percentage.	Minimum: 0.000000 Maximum: 100.000000 Default: 0
	Type	choice	`COLOR_SYMBOLS`	-	Available Choices: [0] Single Symbol [1] Classification [2] Discrete Colors [3] Graduated Colors Default: 0
	Color	color	`SINGLE_COLOR`	-	Default: 32768
	Field	choice	`CLASSIFIED_FIELD`	-	Available Choices: [0] Default: 0
	Normalization	choice	`CLASSIFIED_NORMALIZE`	-	Available Choices: [0] Default: 0
	Look-up Table	static table	`CLASSIFIED_LUT`	-	5 Fields: - 1. [color] Color - 2. [string] Name - 3. [string] Description - 4. [8 byte floating point number] Minimum - 5. [8 byte floating point number] Maximum
	Field	choice	`STRETCH_FIELD`	-	Available Choices: [0] Default: 0
	Normalization	choice	`STRETCH_NORMALIZE`	-	Available Choices: [0] Default: 0
	Labeling	choice	`STRETCH_NORMALIZE_FORMAT`	-	Available Choices: [0] fraction [1] percentage Default: 0
	Colors	colors	`STRETCH_COLORS`	-	-
	Stretch Type	choice	`STRETCH`	Specify how to adjust histogram stretch.	Available Choices: [0] Minimum Maximum [1] Standard Deviation [2] Percent Clip [3] Manual Default: 1
	Minimum Maximum	value range	`STRETCH_LINEAR`	Apply the stretch between the minimum and maximum values specified as percentage of the full value range.	Default: 0; 100
	Standard Deviation	floating point number	`STRETCH_STDDEV`	Apply the stretch between a specified number of standard deviations.	Minimum: 0.000000 Default: 2
	Keep in Range	boolean	`STRETCH_STDDEV_RANGE`	Prevents that minimum or maximum stretch values fall outside of the actual data value range.	Default: 1
	Percent Clip	value range	`STRETCH_PERCENT`	Adjust the stretch to the percentiles specified here.	Default: 1; 99
	Range	value range	`STRETCH_RANGE`	-	Default: 0; 0
	Scaling	choice	`STRETCH_INTERVALS`	-	Available Choices: [0] linear intervals [1] increasing geometric intervals [2] decreasing geometric intervals [3] histogram equalize Default: 0
	Geometric Interval Factor	floating point number	`STRETCH_INTERVALS_LOG`	-	Minimum: 0.000000 Maximum: 16.000000 Default: 1
	Drawing Order	choice	`DRAWING_ORDER`	-	Available Choices: [0] data set [1] attribute sorting Default: 0
	Show No-Data	boolean	`NODATA_SHOW`	-	Default: 1
	Color	color	`NODATA_COLOR`	-	Default: 12632256
	Field	choice	`LABEL_FIELD`	-	Available Choices: [0] Default: 0
	Font	font	`LABEL_FIELD_FONT`	-	-
	Boundary Effect	choice	`LABEL_FIELD_EFFECT`	-	Available Choices: [0] none [1] full frame [2] top [3] top left [4] left [5] bottom left [6] bottom [7] bottom right [8] right [9] top right Default: 1
	Color	color	`LABEL_FIELD_EFFECT_COLOR`	-	Default: 16777215
	Size	integer number	`LABEL_FIELD_EFFECT_SIZE`	-	Minimum: 1 Default: 1
	Numerical Precision	choice	`LABEL_FIELD_PREC`	-	Available Choices: [0] fit to value [1] standard [2] 0 [3] 0.1 [4] 0.12 [5] 0.123 [6] 0.1234 [7] 0.12345 [8] 0.1234567 [9] 0.12345678 [10] 0.123456789 [11] 0.1234567890 [12] 0.12345678901 [13] 0.123456789012 [14] 0.1234567890123 [15] 0.12345678901234 [16] 0.123456789012345 [17] 0.1234567890123456 [18] 0.12345678901234567 [19] 0.123456789012345678 [20] 0.1234567890123456789 [21] 0.12345678901234567890 Default: 0
	Size relates to...	choice	`LABEL_FIELD_SIZE_TYPE`	-	Available Choices: [0] Screen [1] Map Units Default: 0
	Size by Attribute	choice	`LABEL_FIELD_SIZEBY`	-	Available Choices: [0] <> Default: 0
	Default Size	floating point number	`LABEL_FIELD_SIZE`	-	Minimum: 0.000000 Default: 100
	Show	boolean	`CHART_SHOW`	-	Default: 0
	Fill Style	choice	`DISPLAY_BRUSH`	-	Available Choices: [0] Opaque [1] Transparent [2] Backward Diagonal [3] Cross Diagonal [4] Forward Diagonal [5] Cross [6] Horizontal [7] Vertical Default: 0
	Outline	boolean	`OUTLINE`	-	Default: 1
	Color	color	`OUTLINE_COLOR`	-	Default: 0
	Size	integer number	`OUTLINE_SIZE`	-	Minimum: 1 Default: 1
	Boundary Effect	boolean	`BOUNDARY_EFFECT`	-	Default: 0
	Size	integer number	`BOUNDARY_SIZE`	-	Minimum: 1 Maximum: 32 Default: 4
	Color	color	`BOUNDARY_COLOR`	-	Default: 8421504
	Show Vertices	choice	`DISPLAY_POINTS`	-	Available Choices: [0] no [1] yes [2] with label Default: 0
	Show Centroids	boolean	`DISPLAY_CENTROID`	-	Default: 0
	Copy^*	boolean [GUI]	`FROM_GUI`	-	Default: 1

^* GUI only

Command Line


Usage: saga_cmd docs_map 6 [-FILE ] [-MAP_SIZE ] [-MAP_WIDTH ] [-MAP_HEIGHT ] [-SETTINGS_TABLE_FLT_STYLE ] [-SETTINGS_TABLE_FLT_DECIMALS ] [-SETTINGS_LEGEND_SHOW ] [-SETTINGS_LEGEND_ORIENTATION ] [-SETTINGS_LEGEND_TITLE ] [-SETTINGS_LEGEND_TITLE_TEXT ] [-SETTINGS_LEGEND_FIELD ] [-SETTINGS_LEGEND_FIELD_TEXT ] [-SETTINGS_SHOW_ALWAYS ] [-SETTINGS_SHOW_RANGE_MIN ] [-SETTINGS_SHOW_RANGE_MAX ] [-SETTINGS_TRANSPARENCY ] [-SETTINGS_COLOR_SYMBOLS ] [-SETTINGS_SINGLE_COLOR ] [-SETTINGS_CLASSIFIED_FIELD ] [-SETTINGS_CLASSIFIED_NORMALIZE ] [-SETTINGS_CLASSIFIED_LUT ] [-SETTINGS_STRETCH_FIELD ] [-SETTINGS_STRETCH_NORMALIZE ] [-SETTINGS_STRETCH_NORMALIZE_FORMAT ] [-SETTINGS_STRETCH_COLORS ] [-SETTINGS_STRETCH ] [-SETTINGS_STRETCH_LINEAR_MIN ] [-SETTINGS_STRETCH_LINEAR_MAX ] [-SETTINGS_STRETCH_STDDEV ] [-SETTINGS_STRETCH_STDDEV_RANGE ] [-SETTINGS_STRETCH_PERCENT_MIN ] [-SETTINGS_STRETCH_PERCENT_MAX ] [-SETTINGS_STRETCH_RANGE_MIN ] [-SETTINGS_STRETCH_RANGE_MAX ] [-SETTINGS_STRETCH_INTERVALS ] [-SETTINGS_STRETCH_INTERVALS_LOG ] [-SETTINGS_DRAWING_ORDER ] [-SETTINGS_NODATA_SHOW ] [-SETTINGS_NODATA_COLOR ] [-SETTINGS_LABEL_FIELD ] [-SETTINGS_LABEL_FIELD_EFFECT ] [-SETTINGS_LABEL_FIELD_EFFECT_COLOR ] [-SETTINGS_LABEL_FIELD_EFFECT_SIZE ] [-SETTINGS_LABEL_FIELD_PREC ] [-SETTINGS_LABEL_FIELD_SIZE_TYPE ] [-SETTINGS_LABEL_FIELD_SIZEBY ] [-SETTINGS_LABEL_FIELD_SIZE ] [-SETTINGS_CHART_SHOW ] [-SETTINGS_DISPLAY_BRUSH ] [-SETTINGS_OUTLINE ] [-SETTINGS_OUTLINE_COLOR ] [-SETTINGS_OUTLINE_SIZE ] [-SETTINGS_BOUNDARY_EFFECT ] [-SETTINGS_BOUNDARY_SIZE ] [-SETTINGS_BOUNDARY_COLOR ] [-SETTINGS_DISPLAY_POINTS ] [-SETTINGS_DISPLAY_CENTROID ] [-LAYER ]
  -FILE:                                File
	file path
  -MAP_SIZE:                            Size
	choice
	Available Choices:
	[0] width and height
	[1] width and fitted height
	[2] height and fitted width
	Default: 0
  -MAP_WIDTH:                           Width
	integer number
	Minimum: 1
	Default: 1000
  -MAP_HEIGHT:                          Height
	integer number
	Minimum: 1
	Default: 1000
  -SETTINGS_TABLE_FLT_STYLE:            Floating Point Numbers
	choice
	Available Choices:
	[0] system default
	[1] compact
	[2] fix number of decimals
	Default: 1
  -SETTINGS_TABLE_FLT_DECIMALS:         Decimals
	integer number
	Minimum: 0
	Default: 6
  -SETTINGS_LEGEND_SHOW:                Map Legends
	boolean
	Default: 1
  -SETTINGS_LEGEND_ORIENTATION:         Orientation
	choice
	Available Choices:
	[0] vertical
	[1] horizontal
	Default: 0
  -SETTINGS_LEGEND_TITLE:               Title
	choice
	Available Choices:
	[0] data set
	[1] user defined
	[2] none
	Default: 0
  -SETTINGS_LEGEND_TITLE_TEXT:          User Defined
	text
	Default: Title
  -SETTINGS_LEGEND_FIELD:               Field Labeling
	choice
	Available Choices:
	[0] automatic
	[1] user defined
	[2] none
	Default: 0
  -SETTINGS_LEGEND_FIELD_TEXT:          User Defined
	text
	Default: Label
  -SETTINGS_SHOW_ALWAYS:                Show at all scales
	boolean
	Default: 1
  -SETTINGS_SHOW_RANGE_MIN:          Scale Range
	value range
	Default: 100; 1000
  -SETTINGS_SHOW_RANGE_MAX:          Scale Range
	value range
	Default: 100; 1000
  -SETTINGS_TRANSPARENCY:            Transparency
	floating point number
	Minimum: 0.000000
	Maximum: 100.000000
	Default: 0
  -SETTINGS_COLOR_SYMBOLS:              Type
	choice
	Available Choices:
	[0] Single Symbol
	[1] Classification
	[2] Discrete Colors
	[3] Graduated Colors
	Default: 0
  -SETTINGS_SINGLE_COLOR:               Color
	color
	Default: 32768
  -SETTINGS_CLASSIFIED_FIELD:           Field
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_CLASSIFIED_NORMALIZE:       Normalization
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_CLASSIFIED_LUT:             Look-up Table
	static table
	5 Fields:
	- 1. [color] Color
	- 2. [string] Name
	- 3. [string] Description
	- 4. [8 byte floating point number] Minimum
	- 5. [8 byte floating point number] Maximum
	
  -SETTINGS_STRETCH_FIELD:              Field
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_STRETCH_NORMALIZE:          Normalization
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_STRETCH_NORMALIZE_FORMAT:   Labeling
	choice
	Available Choices:
	[0] fraction
	[1] percentage
	Default: 0
  -SETTINGS_STRETCH_COLORS:             Colors
	colors
  -SETTINGS_STRETCH:                    Stretch Type
	choice
	Available Choices:
	[0] Minimum Maximum
	[1] Standard Deviation
	[2] Percent Clip
	[3] Manual
	Default: 1
  -SETTINGS_STRETCH_LINEAR_MIN:      Minimum Maximum
	value range
	Default: 0; 100
  -SETTINGS_STRETCH_LINEAR_MAX:      Minimum Maximum
	value range
	Default: 0; 100
  -SETTINGS_STRETCH_STDDEV:          Standard Deviation
	floating point number
	Minimum: 0.000000
	Default: 2
  -SETTINGS_STRETCH_STDDEV_RANGE:       Keep in Range
	boolean
	Default: 1
  -SETTINGS_STRETCH_PERCENT_MIN:     Percent Clip
	value range
	Default: 1; 99
  -SETTINGS_STRETCH_PERCENT_MAX:     Percent Clip
	value range
	Default: 1; 99
  -SETTINGS_STRETCH_RANGE_MIN:       Range
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_MAX:       Range
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_INTERVALS:          Scaling
	choice
	Available Choices:
	[0] linear intervals
	[1] increasing geometric intervals
	[2] decreasing geometric intervals
	[3] histogram equalize
	Default: 0
  -SETTINGS_STRETCH_INTERVALS_LOG:   Geometric Interval Factor
	floating point number
	Minimum: 0.000000
	Maximum: 16.000000
	Default: 1
  -SETTINGS_DRAWING_ORDER:              Drawing Order
	choice
	Available Choices:
	[0] data set
	[1] attribute sorting
	Default: 0
  -SETTINGS_NODATA_SHOW:                Show No-Data
	boolean
	Default: 1
  -SETTINGS_NODATA_COLOR:               Color
	color
	Default: 12632256
  -SETTINGS_LABEL_FIELD:                Field
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_LABEL_FIELD_EFFECT:         Boundary Effect
	choice
	Available Choices:
	[0] none
	[1] full frame
	[2] top
	[3] top left
	[4] left
	[5] bottom left
	[6] bottom
	[7] bottom right
	[8] right
	[9] top right
	Default: 1
  -SETTINGS_LABEL_FIELD_EFFECT_COLOR:   Color
	color
	Default: 16777215
  -SETTINGS_LABEL_FIELD_EFFECT_SIZE:    Size
	integer number
	Minimum: 1
	Default: 1
  -SETTINGS_LABEL_FIELD_PREC:           Numerical Precision
	choice
	Available Choices:
	[0] fit to value
	[1] standard
	[2] 0
	[3] 0.1
	[4] 0.12
	[5] 0.123
	[6] 0.1234
	[7] 0.12345
	[8] 0.1234567
	[9] 0.12345678
	[10] 0.123456789
	[11] 0.1234567890
	[12] 0.12345678901
	[13] 0.123456789012
	[14] 0.1234567890123
	[15] 0.12345678901234
	[16] 0.123456789012345
	[17] 0.1234567890123456
	[18] 0.12345678901234567
	[19] 0.123456789012345678
	[20] 0.1234567890123456789
	[21] 0.12345678901234567890
	Default: 0
  -SETTINGS_LABEL_FIELD_SIZE_TYPE:      Size relates to...
	choice
	Available Choices:
	[0] Screen
	[1] Map Units
	Default: 0
  -SETTINGS_LABEL_FIELD_SIZEBY:         Size by Attribute
	choice
	Available Choices:
	[0] <>
	Default: 0
  -SETTINGS_LABEL_FIELD_SIZE:        Default Size
	floating point number
	Minimum: 0.000000
	Default: 100
  -SETTINGS_CHART_SHOW:                 Show
	boolean
	Default: 0
  -SETTINGS_DISPLAY_BRUSH:              Fill Style
	choice
	Available Choices:
	[0] Opaque
	[1] Transparent
	[2] Backward Diagonal
	[3] Cross Diagonal
	[4] Forward Diagonal
	[5] Cross
	[6] Horizontal
	[7] Vertical
	Default: 0
  -SETTINGS_OUTLINE:                    Outline
	boolean
	Default: 1
  -SETTINGS_OUTLINE_COLOR:              Color
	color
	Default: 0
  -SETTINGS_OUTLINE_SIZE:               Size
	integer number
	Minimum: 1
	Default: 1
  -SETTINGS_BOUNDARY_EFFECT:            Boundary Effect
	boolean
	Default: 0
  -SETTINGS_BOUNDARY_SIZE:              Size
	integer number
	Minimum: 1
	Maximum: 32
	Default: 4
  -SETTINGS_BOUNDARY_COLOR:             Color
	color
	Default: 8421504
  -SETTINGS_DISPLAY_POINTS:             Show Vertices
	choice
	Available Choices:
	[0] no
	[1] yes
	[2] with label
	Default: 0
  -SETTINGS_DISPLAY_CENTROID:           Show Centroids
	boolean
	Default: 0
  -LAYER:                               Polygons Layer
	shapes, input