Type Alias LocationMapCustomConfig

LocationMapCustomConfig: {
    additionalLayers?: EvervizLayerSpesification[];
    additionalSources?: EvervizSourceSpecification[];
    animation?: Partial<AnimationProps>;
    caption?: { style?: CSSProperties; text: string };
    containerStyle?: CSSProperties;
    customAttribution?: Partial<CustomAttributionProps>;
    disableInternalReferenceResolutionLogic?: boolean;
    disableLayerRemoving?: boolean;
    enableFeatureEditing?: boolean;
    fullScreenControls?: Partial<FullscreenControlProps>;
    geolocateControls?: Partial<GeolocateControlsProps>;
    interactive?: boolean;
    layers?: LayerOptions[];
    locale?: string;
    logLevel?: LogLevelNames;
    mapNavigation?: Partial<MapNavigationProps>;
    mapStyle?: CSSProperties;
    markers?: CustomMarkerConfig[];
    miniMap?: Partial<MiniMapProps>;
    resolution?: LocationMapResolution;
    reuseMaps?: boolean;
    scaleControls?: Partial<ScaleControlsProps>;
    selectFeatureStrategy?: SelectFeatureStrategy;
    splashScreen?: Partial<SplashScreenProps>;
    styledThemeLayers?: LayerOptions[];
    styleOverride?: CSSProperties;
    subtitle?: { style?: CSSProperties; text: string };
    theme:
        | { data: StyleSpecification; type: "static" }
        | { type: "dynamic"; url: string };
    title?: { style?: CSSProperties; text: string };
    version: "0";
    viewState?: Partial<
        Omit<ViewStateOptions, "disableInternalReferenceResolutionLogic">,
    >;
}

Type declaration

  • OptionaladditionalLayers?: EvervizLayerSpesification[]

    Additional layers that were not added in the theme can be added here

  • OptionaladditionalSources?: EvervizSourceSpecification[]

    Additional sources that were not added in the theme can be added here

  • Optionalanimation?: Partial<AnimationProps>

    Add animations to the map. There must exist at least one keyframe and an initial viewstate to play an animation. As a default, the animation will play immediately when the map is visible on the screen. This default behavior can be disabled, and you may control the animation imperatively instead using the map reference

  • Optionalcaption?: { style?: CSSProperties; text: string }

    The map's caption. This can be used to display a caption below the map.

  • OptionalcontainerStyle?: CSSProperties

    CSS properties that will be merged into the container of the maps

  • OptionalcustomAttribution?: Partial<CustomAttributionProps>

    Edit the base attribution options of the map.

  • OptionaldisableInternalReferenceResolutionLogic?: boolean

    When a user moves around in the map, the application take the current map dimensions and set that as a reference. That means when they resize the map again, it will use these dimensions as a reference, and not those provided from LocationMapCustomConfig.viewState

  • OptionaldisableLayerRemoving?: boolean

    The application will remove layers on load that are not in use. Setting this property to true will disable that behaviour.

  • OptionalenableFeatureEditing?: boolean

    Enable editing of markers and regions inside the map. This will allow a user to drag around markers.

  • OptionalfullScreenControls?: Partial<FullscreenControlProps>

    Display a button for toggling the map in and out of fullscreen mode.

  • OptionalgeolocateControls?: Partial<GeolocateControlsProps>

    Display a button that uses the browser's geolocation API to locate the user on the map.

  • Optionalinteractive?: boolean

    If false, no mouse, touch, or keyboard listeners will be attached to the map, so it will not respond to interaction.

  • Optionallayers?: LayerOptions[]

    Deprecated

    in favor of styledThemeLayers.

  • Optionallocale?: string

    The locale of the map. If provided, the map will go through the style and edit any symbol layer to the the provided locale.

  • OptionallogLevel?: LogLevelNames

    The log level of the map. This is not a reactive prop.

  • OptionalmapNavigation?: Partial<MapNavigationProps>

    Display a control that contains zoom buttons and a compass to control the bearing and pitch of the map.

  • OptionalmapStyle?: CSSProperties

    CSS properties that will be added to the map.

  • Optionalmarkers?: CustomMarkerConfig[]

    Custom HTML markers that can be added to the map

  • OptionalminiMap?: Partial<MiniMapProps>

    Display a locator map inside the map. This can be used to give insights to the viewer where the current map view is related to an area or the world.

  • Optionalresolution?: LocationMapResolution

    The resolution of the map. It supports three modes: "Fill", "Manual", or "Aspect".

    • "Fill" mode takes the full width and height of the parent container.
    • "Manual" mode uses the provided height and width for dimensions.
    • "Aspect" mode takes the provided width to the map, and calculates the height based on the provided aspect ratio.
  • OptionalreuseMaps?: boolean

    By default, every time a map component is unmounted, all internal resources associated with the underlying Map instance are released. If the map gets mounted again, a new Map instance is constructed. If reuseMaps is set to true, when a map component is unmounted, the underlying Map instance is retained in memory. The next time a map component gets mounted, the saved instance is reused. This behavior may be desirable if an application frequently mounts/unmounts map(s), for example in a tabbed or collapsable UI, and wants to avoid recreating the Map and its data cache triggered by initialization.

  • OptionalscaleControls?: Partial<ScaleControlsProps>

    Display a widget that display the scale of the map.

  • OptionalselectFeatureStrategy?: SelectFeatureStrategy

    Must be used in conjuction with LocationMapCustomConfig.enableFeatureEditing. Defines how the map will select different features based on mouse interactions

  • OptionalsplashScreen?: Partial<SplashScreenProps>

    Add a splashscreen to the application under initialization of the map. This feature is enabled by default.

  • OptionalstyledThemeLayers?: LayerOptions[]

    Control how layers in the theme looks. For example, you may disable/enable layers inside the theme. Use LocationMapCustomConfig.additionalLayers if the layers doesn't exist in the theme.

  • OptionalstyleOverride?: CSSProperties

    CSS properties that will be added to text throughout the application.

  • Optionalsubtitle?: { style?: CSSProperties; text: string }

    The map's subtitle. This can be used to display a subtitle below the main title.

  • theme: { data: StyleSpecification; type: "static" } | { type: "dynamic"; url: string }

    The maplibre theme. It can either be an object, or a url for which the map will fetch the theme from.

  • Optionaltitle?: { style?: CSSProperties; text: string }

    The map's main title.

  • version: "0"

    Version number of the map.

  • OptionalviewState?: Partial<Omit<ViewStateOptions, "disableInternalReferenceResolutionLogic">>

    The initial viewstate of the map. This property is not reactive, and will only be applied on initialization of the map. You must provide the height and width of the map when it was created to calculate the current zoom. On initialization the map will use the current dimensions of the map, and calculate a new zoom level based on the provided reference height and width, to make sure that everything inside the map will be visisble across multiple dimensions.

Settings

Member Visibility