@situm/react-native
    Preparing search index...

    Type Alias MapViewConfiguration

    type MapViewConfiguration = {
        apiDomain?: string;
        buildingIdentifier: string;
        directionality?: string;
        language?: string;
        profile?: string;
        remoteIdentifier?: string;
        situmApiKey?: string;
        viewerDomain?: string;
    }
    Index

    Properties

    apiDomain? buildingIdentifier directionality? language? profile? remoteIdentifier? situmApiKey? viewerDomain?

    Properties

    apiDomain?: string

    A String parameter that allows you to choose the API you will be retrieving our cartography from. Default is "api.situm.com". In most cases this parameter shouldn't be changed.

    buildingIdentifier: string

    ** Required ** The building that will be loaded on the map. In case you set a buildingIdentifier in your remote configuration, it will be prioritized over MapViewConfiguration.buildingIdentifier parameter.

    directionality?: string

    Sets the directionality of the texts that will be displayed inside MapView. Default is "ltr".

    language?: string

    Sets the UI language based on the given ISO 639-1 code. Checkout the Situm docs to see the list of supported languages.

    profile?: string

    A String that specifies the selected profile name for configuring the MapView with its corresponding remote settings.

    remoteIdentifier?: string

    Use profile instead. A String identifier that allows you to remotely configure all map settings.

    situmApiKey?: string

    Your Situm API key. Find your API key at your Situm dashboard's profile

    Since 3.17.0 version this parameter is not required. Instead, you should specify your apiKey at the root of your app with SitumProvider.apiKey for the correct usage of the plugin. If MapViewConfiguration.situmApiKey is specified, SitumProvider.apiKey will be ignored.

    viewerDomain?: string

    A String parameter that allows you to specify which domain will be displayed inside our webview. Defaults to "https://maps.situm.com/". In most cases this parameter shouldn't be changed.

    Settings

    Member Visibility

    On This Page

    Properties