✎ save_map [Dinamica EGO]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Save Map ======

===== Description =====

Saves a map to a file. The file format is determined automatically from the filename's extension.

===== Inputs =====

^ Name  ^ Type  ^ Description  ^
| Map  | [[Map Type]]  | Map to be saved.  |
| Filename  | [[Map Filename Type]]  | Name and path of the file the map is saved to.  |

===== Optional Inputs =====

^ Name  ^ Type  ^ Description  ^ Default Value  ^
| Suffix Digits  | [[Non Negative Integer Value Type]]  | Number of digits used to render Step as a filename suffix. If Step needs more digits than this, it is used unmodified. If zero, no suffix is added. This is an advanced port.  | 2  |
| Step  | [[Non Negative Integer Value Type]]  | Model step that produced the file, appended to Filename as a numeric suffix; automatically bound to the innermost compatible container. This is an advanced port.  | .none  |
| Use Compression  | [[Boolean Value Type]]  | If true, the saved map's cells are compressed, for output formats that support it; ignored by formats that do not. This is an advanced port.  | Yes  |
| Workdir  | [[Workdir Type]]  | Work directory Filename is relative to; may be a folder or a Zip archive. When not bound, the directory containing the script is used. This is an advanced port.  | .none  |
| Ignore Costly Sparse Categories  | [[Boolean Value Type]]  | If true, a sparse categorization whose consecutive category values differ by very large gaps is discarded rather than saved, avoiding a costly representation. This is an advanced port.  | Yes  |

===== Outputs =====

None.

===== Group =====

[[Functor List#Input / Output | Input / Output]]

===== Notes =====

If Step is .none, the saved filename has no numeric suffix.

See Lesson 4, "Opening and Saving maps," for a practical example of this functor.

===== Internal Name =====

SaveMap

===== Usage examples =====

See practical examples of this functor in [[lesson_4|Lesson 4: Opening and Saving maps]]