Skip to content

CoreSplit (Split Screen Control)

Create and manage split screen comparison controls for map layers.

Constructor

ts
new ge3d.control.CoreSplit(options?: CoreSplitOptions): CoreSplit

Parameters (CoreSplitOptions)

ParameterTypeDefaultDescription
leftLayerBaseTileLayer | BaseTileLayer[]-Layer(s) to display on the left side
rightLayerBaseTileLayer | BaseTileLayer[]-Layer(s) to display on the right side
isRemoveLeftLayerBooleanfalseWhether to remove left layer when exiting split screen (default removes right layer)

Properties

PropertyTypeDescription
typeStringControl type ("coreSplit")
isRemoveLeftLayerBooleanWhether to remove left layer when exiting split screen
leftLayerBaseTileLayer[]Left side layers
rightLayerBaseTileLayer[]Right side layers
showBooleanShow/hide state
enabledBooleanEnable/disable state
containerHTMLElementControl's DOM container

Methods

MethodParametersReturn ValueDescription
addToLeftLayer(layers: BaseTileLayer | BaseTileLayer[])voidAdd layer(s) to left side
removeFromLeftLayer(layers: BaseTileLayer | BaseTileLayer[])voidRemove layer(s) from left side
addToRightLayer(layers: BaseTileLayer | BaseTileLayer[])voidAdd layer(s) to right side
removeFromRightLayer(layers: BaseTileLayer | BaseTileLayer[])voidRemove layer(s) from right side
setLayerSplitDirection(layer: BaseTileLayer, splitDirection: Cesium.SplitDirection)voidSet layer split direction

Notes

  1. CoreSplit extends BaseControl and inherits all its properties and methods
  2. Supports both single layers and arrays of layers for each side
  3. Automatically handles layer visibility based on split position
  4. Supports vector data visibility control for GeoJSON layers
  5. Split position can be controlled by dragging the splitter or programmatically
  6. When isRemoveLeftLayer is true, left layers are removed when exiting split screen
  7. When isRemoveLeftLayer is false, right layers are removed when exiting split screen
  8. The control automatically manages layer split directions
  9. Supports touch gestures for mobile devices
  10. Events provide real-time feedback on split position changes
  11. Vector data (GeoJSON) visibility is automatically managed based on split position
  12. The control creates a draggable splitter UI element for user interaction