Skip to content

TSTool / Command / GeoMapProject


Overview

This command is under development.

The GeoMapProject command processes a "GeoMap" project, which describes one or more spatial maps. A GeoMap project organizes spatial data layers and configuration data. This command is used to develop and test Java map processing code and integrate time series data visualizations with maps.

See the Open Water Foundation GeoProcessor documentation. The GeoProcessor provides extensive spatial data processing, whereas this TSTool command is mainly used to assemble and manipulate GeoMap project files that use existing spatial data files and web services. A GeoMap project file can be saved as JSON and used with web applications to describe maps for visualizations.

Time series data are accessed either by using the data as an attribute for map symbol and providing links to other pages that display time series data.

Command Editor

The command is available in the following TSTool menu:

  • Commands / Spatial Data Processing

The following dialog is used to edit the command and illustrates the command syntax. The GeoMapProject command uses sub-commands as specified by the ProjectCommand parameter to perform tasks, with tabs provided to organize parameters for each sub-command. One or more processing actions can be executed independently or combined:

  • create a new project:
    • specify project data (see the New tab)
    • copy an existing project (see the Copy tab)
    • read a project from a JSON file (see the Read tab)
  • write the project to an output JSON file (see the Write tab)

Use more than one command as needed to add and modify project content. Use the GeoMap command to configure maps within a project

GeoMapProject command editor for a new project

GeoMapProject Command Editor for New Parameters (see full-size image)

GeoMapProject command editor to copy a project

GeoMapProject Command Editor for Copy Parameters (see full-size image)

GeoMapProject command editor to read a project

GeoMapProject Command Editor for Read Parameters (see full-size image)

GeoMapProject command editor to delete a project

GeoMapProject Command Editor for Delete Parameters (see full-size image)

GeoMapProject command editor Write parameters

GeoMapProject Command Editor for Write Parameters (see full-size image)

Command Syntax

The command syntax is as follows:

GeoMapProject(Parameter="Value",...)

Command Parameters

Tab Parameter                     Description Default          
All ProjectCommand GeoMap project command to run:
  • NewProject - create a new project
  • Copy - copy an existing project
  • Read - read a project from a JSON file
  • Delete - delete a project
  • Write - write a project to a JSON file
See separate tabs for the related command parameters.
None - must be specified.
GeoMapProjectID Identifier for the GeoMap project, needed when processing an existing project. Can be specified using processor ${Property}. Must be specified except when creating a new project.
New NewGeoMapProjectID New GeoMap project identifier, used when creating a new project. Can be specified using processor ${Property}. Required for a new project.
Project Name for the project. Can be specified using processor ${Property}. Required for a new project.
Description Description for the project. Can be specified using processor ${Property}.
Properties GeoMap project properties using format Property1:Value1,Property2:Value2,.... Can be specified using processor ${Property}.
Copy Use the GeoMapProjectID and New tab parameters to copy an existing project to a new project.
Read InputFile GeoMap project JSON input file to read. Can be specified using processor ${Property}.
Delete Use the GeoMapProjectID parameter to delete an existing project.
Write OutputFile GeoMap project JSON output file to write. Can be specified using processor ${Property}.
JsonFormat Specify the format of the JSON output file:
  • Bare - no top-level geoMapProject element, project data elements are at the top level
  • Named - top-level geoMapProject element encloses project data
Named

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also