Type Alias LocationMapRef

Type declaration

• { mapDefined: false }

  • mapDefined: false

    The core map is not defined, other functions are not available until the is defined
• {
      flyTo: (
          options: FlyToOptions,
          calculateZoom: boolean,
          origin: "external" | "user",
      ) => void;
      getAnimationControls: () => {
          pause: () => void;
          play: () => void;
          seek: (time: number) => void;
          stop: () => void;
      };
      getAnimationState: () => {
          enabled: boolean;
          isPlaying: boolean;
          progress: number;
      };
      getMapEngine: () => Map;
      getMapResolution: () => { height: number; width: number };
      getViewState: () => MapViewState;
      jumpTo: (
          options: JumpToOptions,
          calculateZoom: boolean,
          origin: "external" | "user",
      ) => void;
      mapDefined: true;
  }

  • flyTo: (
        options: FlyToOptions,
        calculateZoom: boolean,
        origin: "external" | "user",
    ) => void

    Fly to a location

  • getAnimationControls: () => {
        pause: () => void;
        play: () => void;
        seek: (time: number) => void;
        stop: () => void;
    }

    Get an object to control map animations

  • getAnimationState: () => { enabled: boolean; isPlaying: boolean; progress: number }

    Get the current animation state

  • getMapEngine: () => Map

    Get the underlying map engine

  • getMapResolution: () => { height: number; width: number }

    Get the map dimensions

  • getViewState: () => MapViewState

    Get the current view state

  • jumpTo: (
        options: JumpToOptions,
        calculateZoom: boolean,
        origin: "external" | "user",
    ) => void

    Jump to a location

  • mapDefined: true

    The core map is defined