Skip to content

StyleImageMetadata

StyleImageMetadata = object

Defined in: style/style_image.ts:59

The style's image metadata

Properties

content?

optional content?: [number, number, number, number]

Defined in: style/style_image.ts:79

If icon-text-fit is used in a layer with this image, this option defines the part of the image that can be covered by the content in text-field.


pixelRatio

pixelRatio: number

Defined in: style/style_image.ts:63

The ratio of pixels in the image to physical pixels on the screen


sdf

sdf: boolean

Defined in: style/style_image.ts:67

Whether the image should be interpreted as an SDF image


stretchX?

optional stretchX?: [number, number][]

Defined in: style/style_image.ts:71

If icon-text-fit is used in a layer with this image, this option defines the part(s) of the image that can be stretched horizontally.


stretchY?

optional stretchY?: [number, number][]

Defined in: style/style_image.ts:75

If icon-text-fit is used in a layer with this image, this option defines the part(s) of the image that can be stretched vertically.


textFitHeight?

optional textFitHeight?: TextFit

Defined in: style/style_image.ts:87

If icon-text-fit is used in a layer with this image, this option defines constraints on the vertical scaling of the image.


textFitWidth?

optional textFitWidth?: TextFit

Defined in: style/style_image.ts:83

If icon-text-fit is used in a layer with this image, this option defines constraints on the horizontal scaling of the image.