Class ImageData

A class representing image link data within the map.

Hierarchy

default
- ImageData

Index

Properties

Accessors

altText name url

Methods

Properties

`Readonly`id

id: string

The identity of the map metadata.

Accessors

altText

get altText(): undefined | string
Gets the alt text of the image.

Returns undefined | string
The alt text of the image.

name

get name(): undefined | string
Gets the alt text of the image.

Returns undefined | string
The alt text of the image.

Deprecated
Use altText instead.

url

get url(): undefined | string
Gets the url of the image.

Returns undefined | string
The url of the image.

Methods

toJSON

toJSON(): { id: string; name: undefined | string; url: undefined | string }
/**
- Serializes the image data to JSON.
Returns { id: string; name: undefined | string; url: undefined | string }
An object representing the image.

`Static`is

is(instance: object): instance is ImageData
Checks if the provided instance is of type Image.
Parameters
- instance: object
  The instance to check.
Returns instance is ImageData
True if the instance is a Image, false otherwise.