Open Pioneer Trails Packages
    Preparing search index...

    Interface CoordinateInputProps

    Props for the CoordinateInput component.

    interface CoordinateInputProps {
        input?: Coordinate;
        map?: MapModel;
        mapId?: string;
        onClear?: () => void;
        onSelect?: (event: CoordinatesSelectEvent) => void;
        placeholder?: string | Coordinate;
        projections?: ProjectionInput[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    input? map? mapId? onClear? onSelect? placeholder? projections?

    Properties

    input?: Coordinate

    Insert input value and overwrite user input.

    map?: MapModel

    The map model to use.

    mapId?: string

    The id of the map. The map will be looked up in the MapRegistry service.

    Use the map property instead.

    DefaultMapProvider

    onClear?: () => void

    Optional event that gets called if the input is cleared.

    onSelect?: (event: CoordinatesSelectEvent) => void

    Optional event that gets called if (valid) coordinates are entered or projection is changed by the user.

    placeholder?: string | Coordinate

    Placeholder text to display when no input is present. Common usages:

    • hint for the user ("enter coordinate here")
    • example coordinate ("12.345 67.890")
    • current mouse position

    If a coordinate is given, it has to be in the current projection of the map.

    projections?: ProjectionInput[]

    List of projection options, only projections that are known by the map as projection are shown. Each projection can have an individual precision of coordinates.

    If no precision is given, the default precision is used.

    Settings

    Member Visibility

    On This Page

    Properties