Class: HexgridPlugin

HexgridPlugin

Plugin for creating and managing a hexgrid layer on the map.

new HexgridPlugin(map, pluginOptions)

GoMap/Plugins/HexgridPlugin.ts, line 28

Creates an instance of HexgridPlugin.

Name Type Description
map Go3dMap

The map instance the plugin will interact with.

pluginOptions Go3dPluginsConfig | Go3dWidgetsConfig

Configuration options for the plugin.

Extends

  • undefined

Methods

activate()

GoMap/Plugins/HexgridPlugin.ts, line 45

Activates the plugin, initializes the hexgrid layer and listens for new data.

createHexgrid(features)

GoMap/Plugins/HexgridPlugin.ts, line 94

Creates a hexgrid layer based on the given features.

Name Type Description
features any

Array of GeoJSON features to create the hexgrid from.

deactivate()

GoMap/Plugins/HexgridPlugin.ts, line 74

Deactivates the plugin, clears the hexagons and removes event listeners.

getThreeLayer(){maptalksTHREE.ThreeLayer}

GoMap/Plugins/HexgridPlugin.ts, line 172

Gets the Three.js layer associated with the plugin.

Returns:
Type Description
maptalksTHREE.ThreeLayer The Three.js layer.