Skip to main content

Images

import { Images } from '@rnmapbox/maps';

Images

Images defines the images used in Symbol etc. layers.

props

images

type Images = {
  [object Object]: union; /* FIX ME NO DESCRIPTION */
}

Specifies the external images in key-value pairs required for the shape source. Keys are names - see iconImage expressions, values can be either urls-s objects with format {uri: 'http://...'} or require('image.png') or import 'image.png'

nativeAssetImages

Array

If you have an asset under Image.xcassets on iOS and the drawables directory on android you can specify an array of string names with assets as the key ['pin']. Additionally object with keys sdf, and strechX, strechY is supported for SDF icons

Shape Source Icons

onImageMissing

func

Gets called when a Layer is trying to render an image whose key is not present in any of the Images component of the Map. signature:(imageKey:string) => void

Shape Source Icons

children

ReactElement<T> | Array<TypedReactNode<T>> | never

FIX ME NO DESCRIPTION