Interface StyleImageOptions

Options for a style image, as the [sprite](https://maplibre.org/maplibre-style-spec/sprite/) spec describes them.

See mln_style_image_options in the C API reference.

interface StyleImageOptions {
    content?: ImageContent;
    keepUnused?: boolean;
    pixelRatio?: number;
    sdf?: boolean;
    stretchX?: readonly ImageStretch[];
    stretchY?: readonly ImageStretch[];
    textFitHeight?: StyleImageTextFit;
    textFitWidth?: StyleImageTextFit;
}

Index

Properties

content? keepUnused? pixelRatio? sdf? stretchX? stretchY? textFitHeight? textFitWidth?

Properties

`Optional`content

content?: ImageContent

`Optional`keepUnused

keepUnused?: boolean

Keeps the image after no layer uses it. Without this, the map can remove an image that it asked for through RuntimeEventType.mapStyleImageMissing.

`Optional`pixelRatio

pixelRatio?: number

`Optional`sdf

sdf?: boolean

`Optional`stretchX

stretchX?: readonly ImageStretch[]

The ranges of columns that stretch, in increasing order without overlap.

`Optional`stretchY

stretchY?: readonly ImageStretch[]

The ranges of rows that stretch, in increasing order without overlap.

`Optional`textFitHeight

textFitHeight?: StyleImageTextFit

`Optional`textFitWidth

textFitWidth?: StyleImageTextFit