#Interface: IMinimapPropertyItem experimental

Beta

A property item which supports Minimap properties

#Extends

• IPropertyItemBase

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#mapId

readonly mapId: string

Beta

#Remarks

Id of the map.

---

#mapImageHeight

readonly mapImageHeight: number

Beta

#Remarks

Height of the map image.

---

#mapImageWidth

readonly mapImageWidth: number

Beta

#Remarks

Width of the map image.

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#isMarkerTypeVisible()

isMarkerTypeVisible(type): boolean

Beta

#Parameters

#type

MinimapMarkerType

The marker type to query.

#Returns

boolean

#Remarks

Get visibility for a specific marker type.

---

#isMeMarkerShown()

isMeMarkerShown(): boolean

Beta

#Returns

boolean

#Remarks

Get me marker visibility.

---

#registerCustomMarkerIcon()

registerCustomMarkerIcon(iconIdentifier, imagePath): void

Beta

#Parameters

#iconIdentifier

string

The iconIdentifier string.

#imagePath

string

The image resource path.

#Returns

void

#Remarks

Register a custom marker icon for UI rendering.

---

#resizeMapImage()

resizeMapImage(width, height): void

Beta

#Parameters

#width

number

New width of the image.

#height

number

New height of the image.

#Returns

void

#Remarks

Updates the size of the map image.

---

#setMarkerTypeVisible()

setMarkerTypeVisible(type, visible): void

Beta

#Parameters

#type

MinimapMarkerType

The marker type to toggle.

#visible

boolean

Whether the marker type should be visible.

#Returns

void

#Remarks

Set visibility for a specific marker type.

---

#setMeMarkerShown()

setMeMarkerShown(shown): void

Beta

#Parameters

#shown

boolean

#Returns

void

#Remarks

Set me marker visibility.

---

#unregisterCustomMarkerIcon()

unregisterCustomMarkerIcon(iconIdentifier): void

Beta

#Parameters

#iconIdentifier

string

The iconIdentifier string.

#Returns

void

#Remarks

Unregister a custom marker icon.