CountryData - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > CountryData

CountryData class

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.

Signature:

export declare class CountryData

Constructors

Constructor	Modifiers	Description
(constructor)(name, isoCode, flagImage)		Creates a CountryData instance. API users do not typically construct this object directly.

Constructor

Modifiers

Description

(constructor)(name, isoCode, flagImage)

Creates a CountryData instance.

API users do not typically construct this object directly.

Properties

Property	Modifiers	Type	Description
flagImage?	`readonly`	Img \| undefined	(Optional)
isoCode	`readonly`	string
name	`readonly`	string

Methods

Method	Modifiers	Description
equals(other)		Equality comparison
hashCode()		Hash code calculation