#Interface: IMinimapPropertyItemOptions experimental

Beta

Optional properties for Minimap property item

#Extends

• IPropertyItemOptionsBase

#Properties

#alignment?

optional alignment?: LayoutAlignment

Beta

#Remarks

Alignment of the map in the container. If not defined, LayoutAlignment.Center is used.

---

#clickable?

optional clickable?: boolean

Beta

#Remarks

Whether the minimap is clickable. If undefined, defaults to true.

---

#customMarkerIcons?

optional customMarkerIcons?: Record<string, string>

Beta

#Remarks

Custom marker icon registration. Maps the iconIdentifier (used when adding custom markers via addCustomMarker) to image resource paths for UI rendering. Only needed for Custom marker type. Multiplayer and Location use built-in icons.

---

#enable?

optional enable?: boolean

Beta

#Remarks

Initial enabled state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.enable

---

#isMeMarkerShown?

optional isMeMarkerShown?: boolean

Beta

#Remarks

Whether to show me marker on the minimap. If undefined, defaults to true.

---

#mapImageSize?

optional mapImageSize?: number | { height: number; width: number; }

Beta

#Remarks

Size of the map image. If undefined, defaults to 35.

---

#onClick?

optional onClick?: (worldX, worldY, worldZ) => void

Beta

#Parameters

#worldX

number

#worldY

number

#worldZ

number

#Returns

void

#Remarks

Called when the minimap is clicked.

---

#style?

optional style?: PaneItemStyle

Beta

#Remarks

Optional styling overrides for the item.

#Inherited from

IPropertyItemOptionsBase.style

---

#visible?

optional visible?: boolean

Beta

#Remarks

Initial visibility state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.visible

---

#visibleMarkerTypes?

optional visibleMarkerTypes?: MinimapMarkerType[]

Beta

#Remarks

Per-type marker visibility. If omitted, no marker types are shown. Only controls presentation. Markers must be added via C++ API to exist.