Edit

Share via

HyperLinkFormatOptions interface

  • Reference
Package:
azure-maps-control

Format option for hyperlink strings.

Properties

isImage

Specifies if the hyperlink is for an image. If set to true, the hyperlink will be loaded into an img tag and when clicked, will open the hyperlink to the image.
label

Specifies the text that should be displayed to the user. If not specified, the hyperlink will be displayed. If the hyperlink is an image, this will be set as the "alt" property of the img tag.
scheme

Specifies a scheme to prepend to a hyperlink such as 'mailto:' or 'tel:'.
target

Specifies the where the hyperlink should open. Default: "_blank"

Property Details

isImage

Specifies if the hyperlink is for an image. If set to true, the hyperlink will be loaded into an img tag and when clicked, will open the hyperlink to the image.

isImage?: boolean

Property Value

boolean

label

Specifies the text that should be displayed to the user. If not specified, the hyperlink will be displayed. If the hyperlink is an image, this will be set as the "alt" property of the img tag.

label?: string

Property Value

string

scheme

Specifies a scheme to prepend to a hyperlink such as 'mailto:' or 'tel:'.

scheme?: string

Property Value

string

target

Specifies the where the hyperlink should open. Default: "_blank"

target?: "_blank" | "_self" | "_parent" | "_top"

Property Value

"_blank" | "_self" | "_parent" | "_top"