Type Alias TGetMapDataSharedOptions

TGetMapDataSharedOptions: {
    analytics?: {
        baseUri?: string;
        logEvents?: boolean;
        sendEvents?: boolean;
    };
    baseAuthUri?: string;
    baseUri?: string;
    environment?: ServiceEnvironment;
    mapId: string;
    onMVFParsed?: ((mvf: TMVF) => void);
    search?: TSearchOptions;
    viewId?: string;
}

Type declaration

  • Optionalanalytics?: {
        baseUri?: string;
        logEvents?: boolean;
        sendEvents?: boolean;
    }

    Analytics configuration.

    • OptionalbaseUri?: string

      Custom base URI for analytics requests. If not provided, the default analytics endpoint will be used. Use the environment setting to switch environments.

    • OptionallogEvents?: boolean

      Whether to log analytics events.

      false
      
    • OptionalsendEvents?: boolean

      Whether to send analytics events to the server.

      false
      
  • OptionalbaseAuthUri?: string

    Optionally provide a custom URI for authentication when obtaining an access token. Use the environment setting to switch environments.

  • OptionalbaseUri?: string

    Optionally provide a custom base URL for the Mappedin API request. Use the environment setting to switch environments

  • Optionalenvironment?: ServiceEnvironment

    set the target SDK environment

    'us'
    
    const mapData = getMapData({
    key: '',
    secret: '',
    environment: 'eu'
    })
  • mapId: string

    Mappedin map ID.

  • OptionalonMVFParsed?: ((mvf: TMVF) => void)

    Callback for when the Mappedin map data has been fetched and parsed as Mappedin Venue Format (MVF) data.

      • (mvf): void
      • Parameters

        • mvf: TMVF

          Parsed MVF data.

        Returns void

  • Optionalsearch?: TSearchOptions
  • OptionalviewId?: string

    Load different view of mvf data based on configId