@magiclane/maps-sdk
    Preparing search index...

    Class CountryData

    Compact country metadata including display name, ISO code and flag.

    This value object is returned by several MapDetails helpers (for example, MapDetails.getCountryData and MapDetails.allCountriesData) and can be used by clients to display country information or retrieve flag images.

    MapDetails - Utilities for querying map metadata and country information.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Creates a CountryData instance.

      API users do not typically construct this object directly.

      Parameters

      • name: string

        Human-readable country name

      • isoCode: string

        ISO 3166-1 alpha-3 country code (e.g. USA)

      • OptionalflagImage: Img

        Optional flag image object; undefined when not present

      Returns CountryData

    Properties

    flagImage?: Img

    Optional flag image object; undefined when not present

    isoCode: string

    ISO 3166-1 alpha-3 country code (e.g. USA)

    name: string

    Human-readable country name

    Methods

    • Equality comparison

      Parameters

      Returns boolean

    • Hash code calculation

      Returns number