On this page

Type Alias StyleImageMetadata

The style's image metadata

type StyleImageMetadata = {
    content?: [number, number, number, number];
    pixelRatio: number;
    sdf: boolean;
    stretchX?: [number, number][];
    stretchY?: [number, number][];
    textFitHeight?: TextFit;
    textFitWidth?: TextFit;
}

Properties

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

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: number

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

sdf: boolean

Whether the image should be interpreted as an SDF image

stretchX?: [number, number][]

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?: [number, number][]

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?: TextFit

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

textFitWidth?: TextFit

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

Was this helpful?