Analysis

Analysis is the base class of 3D spatial analysis, defining methods common to all kinds of 3D spatial analysis.

Analysis can only be added to a GroupGLLayer; it cannot be added to other WebGL layers.

Note: In the 2026 source, the subclasses of Analysis include CutAnalysis (section cut), ViewshedAnalysis (viewshed), SkylineAnalysis (skyline), FloodAnalysis (flood), InSightAnalysis (intervisibility), CrossCutAnalysis (cross-section) and HeightLimitAnalysis (height limit, inheriting from FloodAnalysis). ExcavateAnalysis (excavation) does not inherit from Analysis; it inherits ExtrudePolygonLayer from @maptalks/vt, so it is out of scope for this page (verified 2026).

Methods

addTo(groupGLLayer)

Adds the analysis object to a GroupGLLayer.

Spatial analysis objects can only be added to a GroupGLLayer; they cannot be added to other WebGL layers.

Parameters:

• groupGLLayer GroupGLLayer the GroupGLLayer

Returns:

• this

remove()

Removes the spatial analysis object from the layer.

Returns:

• void

update(name, value)

Updates options data.

Parameters:

• name String the setting name
• value any the setting value

Returns:

• void

getAnalysisType()

Gets the type of the Analysis.

Returns:

• String

getDefines()

Internal method.

Returns the defines added to the shader when the Analysis is rendered.

Returns:

• Object

renderAnalysis(meshes)

Internal method.

Renders the spatial analysis scene (implemented by each analysis subclass) and returns the uniform variables required for rendering.

Parameters:

• meshes Mesh[] the scene meshes

Returns:

• Object

enable()

Enables the analysis.

Returns:

• void

disable()

Disables the analysis.

Returns:

• void

isEnable()

Whether the analysis is enabled.

Returns:

• Boolean

getExcludeLayers()

Gets the list of layer ids excluded from the analysis (these layers are ignored during the analysis).

Returns:

• String[]

setExcludeLayers(layerIds)

Sets the list of layer ids excluded from the analysis.

Parameters:

• layerIds String[] list of layer ids

Returns:

• void

exportAnalysisMap(meshes)

Exports the analysis result image (RGBA pixel data); returns null when the analysis is not enabled.

Parameters:

• meshes Mesh[] the scene meshes

Returns:

• Uint8Array

This document has been cross-checked against the @maptalks/gl-layers 2026 source (api-notes-others.md / api-notes-vt-gl.md)