react-native/docs/imagestore.md

105 lines
2.1 KiB
Markdown
Raw Normal View History

---
id: imagestore
title: ImageStore
layout: docs
category: APIs
permalink: docs/imagestore.html
next: interactionmanager
previous: imagepickerios
---
### Methods
- [`hasImageForTag`](docs/imagestore.html#hasimagefortag)
- [`removeImageForTag`](docs/imagestore.html#removeimagefortag)
- [`addImageFromBase64`](docs/imagestore.html#addimagefrombase64)
- [`getBase64ForTag`](docs/imagestore.html#getbase64fortag)
---
# Reference
## Methods
### `hasImageForTag()`
```javascript
ImageStore.hasImageForTag(uri, callback)
```
Check if the ImageStore contains image data for the specified URI.
@platform ios
---
### `removeImageForTag()`
```javascript
ImageStore.removeImageForTag(uri)
```
Delete an image from the ImageStore. Images are stored in memory and
must be manually removed when you are finished with them, otherwise they
will continue to use up RAM until the app is terminated. It is safe to
call `removeImageForTag()` without first calling `hasImageForTag()`, it
will simply fail silently.
@platform ios
---
### `addImageFromBase64()`
```javascript
ImageStore.addImageFromBase64(base64ImageData, success, failure)
```
Stores a base64-encoded image in the ImageStore, and returns a URI that
can be used to access or display the image later. Images are stored in
memory only, and must be manually deleted when you are finished with
them by calling `removeImageForTag()`.
Note that it is very inefficient to transfer large quantities of binary
data between JS and native code, so you should avoid calling this more
than necessary.
@platform ios
---
### `getBase64ForTag()`
```javascript
ImageStore.getBase64ForTag(uri, success, failure)
```
Retrieves the base64-encoded data for an image in the ImageStore. If the
specified URI does not match an image in the store, the failure callback
will be called.
Note that it is very inefficient to transfer large quantities of binary
data between JS and native code, so you should avoid calling this more
than necessary. To display an image in the ImageStore, you can just pass
the URI to an `<Image/>` component; there is no need to retrieve the
base64 data.