Project Management API

Module: mls.project. This page documents 8 public functions with exact tool IDs, complete parameters, Parameters fields, and examples.

Back to the Script Tool API Reference

Functions

• open — Open an existing project file
• close_current — Close the currently active project
• save — Save the current project
• get_project_info — Get information about the currently active project, including projectPath and databasePath when available.
• list_loaded_data — List loaded data and layers in the current project. Returns id, name, type, and path/source when available. For current-project vector or table layers, path should be a dataset path such as D:/project.gpkg/layer_name.
• get_selected_data — Get currently selected data objects
• find_loaded_data — Search loaded data by name or type
• get_active_scan — Get the currently active scan station in a Georeference (.mscan) project. Returns the id, name, and type of the active scan. Use this to obtain the scan ID for subsequent operations like io_remove_scan. Only works in .mscan projects with an active scan station.

open

Open an existing project file

• Exact tool ID:project_open
• Recommended call:mls.project.open(...)
• Required parameters:path

Parameters

Example

from gvscript import mls

result = mls.project.open(
    path='D:/data/input.LiData',
)
print(result.ok, result.output, result.message)

close_current

Close the currently active project

• Exact tool ID:project_close_current
• Recommended call:mls.project.close_current(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.close_current(
)
print(result.ok, result.output, result.message)

save

Save the current project

• Exact tool ID:project_save
• Recommended call:mls.project.save(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.save(
    saveAs=False,
    path='D:/data/input.LiData',
)
print(result.ok, result.output, result.message)

get_project_info

Get information about the currently active project, including projectPath and databasePath when available.

• Exact tool ID:get_project_info
• Recommended call:mls.project.get_project_info(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.get_project_info(
)
print(result.ok, result.output, result.message)

list_loaded_data

List loaded data and layers in the current project. Returns id, name, type, and path/source when available. For current-project vector or table layers, path should be a dataset path such as D:/project.gpkg/layer_name.

• Exact tool ID:project_list_loaded_data
• Recommended call:mls.project.list_loaded_data(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.list_loaded_data(
    include_hidden=True,
    type_filter='example',
)
print(result.ok, result.output, result.message)

get_selected_data

Get currently selected data objects

• Exact tool ID:project_get_selected_data
• Recommended call:mls.project.get_selected_data(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.get_selected_data(
)
print(result.ok, result.output, result.message)

find_loaded_data

Search loaded data by name or type

• Exact tool ID:project_find_loaded_data
• Recommended call:mls.project.find_loaded_data(...)
• Required parameters:query

Parameters

Example

from gvscript import mls

result = mls.project.find_loaded_data(
    query='example',
)
print(result.ok, result.output, result.message)

get_active_scan

Get the currently active scan station in a Georeference (.mscan) project. Returns the id, name, and type of the active scan. Use this to obtain the scan ID for subsequent operations like io_remove_scan. Only works in .mscan projects with an active scan station.

• Exact tool ID:project_get_active_scan
• Recommended call:mls.project.get_active_scan(...)
• Required parameters: None

Parameters

Example

from gvscript import mls

result = mls.project.get_active_scan(
)
print(result.ok, result.output, result.message)