Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Geometry

JMap.Application.Geometry

You can manage everything related to app geometry creation or update here.

Index

Functions

closePanel

  • closePanel(): void
  • JMap.Application.Geometry.closePanel

    Closes the geometry creation or update panel without confirmation message.

    example
    
    // close the geometry panel
    JMap.Application.Geometry.closePanel()

    Returns void

finishCreate

  • finishCreate(): void
  • JMap.Application.Geometry.finishCreate

    Finishes geometry creation.

    throws

    if panel is not in creation mode, or if geometry has not yet been created.

    example
    
    // finishe creating or updating the geometry
    JMap.Application.Geometry.finishCreate()

    Returns void

finishUpdate

  • finishUpdate(): Promise<void>
  • JMap.Application.Geometry.finishUpdate

    Finishes geometry update.

    throws

    if panel is not in update mode

    example
    
    // finishe updating the geometry
    JMap.Application.Geometry.finishUpdate()

    Returns Promise<void>

openPanelForCreation

  • openPanelForCreation(): void
  • JMap.Application.Geometry.openPanelForCreation

    Opens the geometry panel in order to create a new feature.

    throws

    if no layer is editable

    example
    
    // will open the geometry panel
    JMap.Application.Geometry.openPanelForCreation()

    Returns void

openPanelForUpdate

  • JMap.Application.Geometry.openPanelForUpdate

    Opens the geometry panel in order to update a feature geometry.

    throws

    if the given layer or feature are not editable

    example
    
    // will open the geometry panel in order to update the feature geometry
    JMap.Application.Geometry.openPanelForUpdate()

    Parameters

    Returns void

selectLayer

  • selectLayer(layerId: JId): void
  • JMap.Application.Geometry.selectLayer

    Selects the layer that will be used to create the geometry and the feature.

    throws

    if layer not found

    example
    
    // will select the layer id=3
    JMap.Application.Geometry.selectLayer(3)

    Parameters

    • layerId: JId

      The JMap layer id

    Returns void

startCreationDrawing

  • startCreationDrawing(): void
  • JMap.Application.Geometry.startCreationDrawing

    Enables drawing of the geometry on the map.

    throws

    if no layer is selected

    example
    
    // enable drawing of the geometry on the map
    JMap.Application.Geometry.startCreationDrawing()

    Returns void

stopCreationDrawing

  • stopCreationDrawing(): void
  • JMap.Application.Geometry.stopCreationDrawing

    Stops the geometry creation, when drawing on the map, and displays the layer selection panel.

    example
    
    // stop drawing the geometry on the map
    JMap.Application.Geometry.stopCreationDrawing()

    Returns void