Type Alias TGetMapDataSharedOptions

TGetMapDataSharedOptions: {
    analytics?: {
        baseUri?: string;
        logEvents?: boolean;
        sendEvents?: boolean;
    };
    baseAuthUri?: string;
    baseUri?: string;
    environment?: ServiceEnvironment;
    fallbackToNavigatorLanguage?: boolean;
    language?: string;
    mapId: string;
    onMVFParsed?: (mvf: TMVF) => void;
    prefetchTokens?: boolean;
    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.

      Default

      false
    • OptionalsendEvents?: boolean

      Whether to send analytics events to the server.

      Default

      false
  • OptionalbaseAuthUri?: string

    Optionally provide a custom base URL 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

    Default

    'us'

    Example

    const mapData = getMapData({
     key: '',
     secret: '',
     environment: 'eu'
    })
  • OptionalfallbackToNavigatorLanguage?: boolean

    Whether to use browser's language settings as fallback if the supplied language code is not available.

    Default

    true
  • Optionallanguage?: string

    The language of the map data. The ISO 639-1 language code to change to (e.g., 'en' for English, 'fr' for French). Check (EnterpriseVenue.languages) for available languages

  • 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.

  • OptionalprefetchTokens?: boolean

    Fetch bearer and SAS tokens for the map ahead of time and keep them up to date in the background.

    Default

    true
  • Optionalsearch?: TSearchOptions
  • OptionalviewId?: string

    Load different view of mvf data based on configId

Settings

Member Visibility