Mappedin JS - v6.14.0
    Preparing search index...

    Interface TGetMapDataWithCredentialsOptions

    Fetch map data using a key/secret pair and additional options.

    Data-model note: The key you supply determines which data model the API returns.

    • Keys starting with "mik_" use the Maker data model (LocationProfile, LocationCategory).
    • All other keys use the CMS / Enterprise data model (EnterpriseLocation, EnterpriseCategory).

    Using the wrong data types for your key type will return empty results.

    interface TGetMapDataWithCredentialsOptions {
        analytics?: {
            baseUri?: string;
            logEvents?: boolean;
            sendEvents?: boolean;
        };
        baseAuthUri?: string;
        baseUri?: string;
        environment?: ServiceEnvironment;
        fallbackToNavigatorLanguage?: boolean;
        key: string;
        language?: string;
        mapId: string;
        onMVFParsed?: (mvf: TMVF) => void;
        prefetchTokens?: boolean;
        search?: TSearchOptions;
        secret: string;
        viewId?: string;
    }
    Index

    Properties

    analytics? baseAuthUri? baseUri? environment? fallbackToNavigatorLanguage? key language? mapId onMVFParsed? prefetchTokens? search? secret viewId?

    Properties

    analytics?: { baseUri?: string; logEvents?: boolean; sendEvents?: boolean }

    Analytics configuration.

    Type Declaration

    • 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
    baseAuthUri?: string

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

    baseUri?: string

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

    environment?: ServiceEnvironment

    set the target SDK environment

    'us'

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

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

    true
    key: string

    Mappedin auth key.

    Keys starting with "mik_" use the Maker data model (LocationProfile, LocationCategory). All other keys use the CMS/Enterprise data model (EnterpriseLocation, EnterpriseCategory). Using the wrong data types for your key type will return empty results.

    language?: 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.

    onMVFParsed?: (mvf: TMVF) => void

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

    Type Declaration

      • (mvf: TMVF): void

      • Parameters

        • mvf: TMVF

          Parsed MVF data.

        Returns void

    prefetchTokens?: boolean

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

    true
    search?: TSearchOptions
    secret: string

    Mappedin auth secret.

    viewId?: string

    Load different view of mvf data based on configId

    Settings

    Member Visibility

    On This Page

    Properties