Image Layered

Overview

Displays multiple unordered images layered over a base image. This face has many use cases. It is often used to visualize combine experiences where vAtoms are combined together. For example, puzzle piece vAtoms may be combined to build up a complete puzzle (displayed using the Image Layered face view).

The base image is determined by the backing vAtom, where the layers are determined by the backing vAtom's children.

Registering the face

This example below shows how to register the image face onto your vAtom's template.

POST /v1/publisher/face

{
  "template": "MyTemplateName",
  "display_url": "native://layered-image",
  "package_url": ".",
  "constraints": {
    "bluetooth_le": false,
    "contact_list": false,
    "gps": false,
    "three_d": true,
    "view_mode": "icon",
    "platform": "generic",
    "quality": "high"
  },
  "config": {
    "layerImage": "Image_X"
  }
}

Face configuration

All fields in the face's config object are optional.

Field name	Type	Default value	Description
`image`	string	`"ActivatedImage"`	The name of the image resource to be displayed for the base layer and the child layers.

Info