Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "coordinates/react-hooks/coordinate-list"

Index

Functions

Functions

Const useCoordinateList

  • useCoordinateList(initCoordinates: [number, number][], initSelectedIndex: number): object
  • Adds an interface for editing a list of coordinates to a react component

    Parameters

    • initCoordinates: [number, number][]

      array of default [lon, lat] coordinate values

    • initSelectedIndex: number

      default selected index

    Returns object

    { coordinateList - array of [lon, lat] coordinate values setCoordinateList - sets coordinateList setSelectedIndex - selected index into coordinateList addCoordinateBefore - adds a new empty coordinate before the selected index addCoordinateAfter - adds a new empty coordinate after the selected index deleteCoordinate - deletes coordinate at selected index setCoordinate - sets the coordinate at selected index }

    • addCoordinateAfter: function
        • (): void
        • Returns void

    • addCoordinateBefore: function
        • (): void
        • Returns void

    • coordinateList: [number, number][]
    • deleteCoordinate: function
        • (): void
        • Returns void

    • lat: number
    • lon: number
    • selectedIndex: number
    • setCoordinate: function
    • setCoordinateList: function
        • (value: [number, number][]): void
        • Parameters

          • value: [number, number][]

          Returns void

    • setSelectedIndex: function
        • (value: number): void
        • Parameters

          • value: number

          Returns void

Generated using TypeDoc