Home > @infiniteobjects/shopify-data-manager > AdminTypes > Image
Represents an image resource.
Signature:
export interface Image extends HasMetafields
Extends: HasMetafields
| Property | Modifiers | Type | Description |
|---|---|---|---|
| altText? | Maybe<Scalars[‘String’][‘output’]> | (Optional) A word or phrase to share the nature or contents of an image. | |
| height? | Maybe<Scalars[‘Int’][‘output’]> | (Optional) The original height of the image in pixels. Returns null if the image isn’t hosted by Shopify. |
|
| id? | Maybe<Scalars[‘ID’][‘output’]> | (Optional) A unique ID for the image. | |
| metafield? | Maybe<Metafield> | (Optional) Returns a metafield by namespace and key that belongs to the resource. | |
| metafields | MetafieldConnection | List of metafields that belong to the resource. | |
| originalSrc | Scalars[‘URL’][‘output’] | <p>The location of the original image as a URL.</p><p>If there are any existing transformations in the original source URL, they will remain and not be stripped.</p> | |
| privateMetafield? | Maybe<PrivateMetafield> | (Optional) Returns a private metafield by namespace and key that belongs to the resource. | |
| privateMetafields | PrivateMetafieldConnection | List of private metafields that belong to the resource. | |
| src | Scalars[‘URL’][‘output’] | The location of the image as a URL. | |
| transformedSrc | Scalars[‘URL’][‘output’] | <p>The location of the transformed image as a URL.</p><p>All transformation arguments are considered “best-effort”. If they can be applied to an image, they will be. Otherwise any transformations which an image type doesn’t support will be ignored.</p> | |
| url | Scalars[‘URL’][‘output’] | <p>The location of the image as a URL.</p><p>If no transform options are specified, then the original image will be preserved including any pre-applied transforms.</p><p>All transformation options are considered “best-effort”. Any transformation that the original image type doesn’t support will be ignored.</p><p>If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).</p> | |
| width? | Maybe<Scalars[‘Int’][‘output’]> | (Optional) The original width of the image in pixels. Returns null if the image isn’t hosted by Shopify. |