View Control API

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

Back to the Script Tool API Reference

Functions

  • set_visibility — Set visibility of the active 3D viewer/window or viewer overlay. Do not use this tool to show or hide project tree layers, loaded point clouds, vector layers, raster layers, or CObject/LiLayer data. For project tree data visibility, use project_resolve_loaded_data followed by layer_set_visibility. This tool requires an active central viewer.
  • fit_all — Fit all content to fill the viewer window
  • zoom_to_layer — Zoom to fit a specific layer in viewer (supports CObject-based data like point cloud, trajectory, and LiLayer-based data like vector, raster)
  • set_display_mode — Display point clouds in viewer with specified display mode (elevation, intensity, RGB, etc.)

set_visibility

Set visibility of the active 3D viewer/window or viewer overlay. Do not use this tool to show or hide project tree layers, loaded point clouds, vector layers, raster layers, or CObject/LiLayer data. For project tree data visibility, use project_resolve_loaded_data followed by layer_set_visibility. This tool requires an active central viewer.

  • Exact tool ID:viewer_set_visibility
  • Recommended call:mls.viewer.set_visibility(...)
  • Required parameters:visible

Parameters

Parameter Type Required Default Description
viewer_id string No '3D' Viewer window ID (e.g., 2D, 3D, Profile, Panorama)
visible boolean Yes — Whether to show or hide the viewer

Example

from gvscript import mls

result = mls.viewer.set_visibility(
    viewer_id='3D',
    visible=True,
)
print(result.ok, result.output, result.message)

fit_all

Fit all content to fill the viewer window

  • Exact tool ID:viewer_fit_all
  • Recommended call:mls.viewer.fit_all(...)
  • Required parameters: None

Parameters

Parameter Type Required Default Description
viewer_id string No '3D' Viewer window ID

Example

from gvscript import mls

result = mls.viewer.fit_all(
    viewer_id='3D',
)
print(result.ok, result.output, result.message)

zoom_to_layer

Zoom to fit a specific layer in viewer (supports CObject-based data like point cloud, trajectory, and LiLayer-based data like vector, raster)

  • Exact tool ID:viewer_zoom_to_layer
  • Recommended call:mls.viewer.zoom_to_layer(...)
  • Required parameters:layer_path

Parameters

Parameter Type Required Default Description
layer_path string Yes — Layer path, object name, or layer ID to zoom to (supports point cloud, trajectory, vector, raster, etc.)
viewer_id string No '3D' Viewer window ID

Example

from gvscript import mls

result = mls.viewer.zoom_to_layer(
    layer_path='D:/data/input.LiData',
    viewer_id='3D',
)
print(result.ok, result.output, result.message)

set_display_mode

Display point clouds in viewer with specified display mode (elevation, intensity, RGB, etc.)

  • Exact tool ID:viewer_set_display_mode
  • Recommended call:mls.viewer.set_display_mode(...)
  • Required parameters:point_cloud_paths

Parameters

Parameter Type Required Default Description
viewer_id string No '3D' Viewer window ID
point_cloud_paths array Yes — Point cloud file paths to display, must be absolute path
display_mode string No 'RGB' Display mode for point cloud rendering

Example

from gvscript import mls

result = mls.viewer.set_display_mode(
    viewer_id='3D',
    point_cloud_paths=['D:/data/input.LiData'],
    display_mode='RGB',
)
print(result.ok, result.output, result.message)

results matching ""

    No results matching ""