com.shopify.buy3

Class Storefront.ImageQuery

java.lang.Object

<any>

com.shopify.buy3.Storefront.ImageQuery

Enclosing class:

Storefront

public static class Storefront.ImageQuery
extends <any>

Represents an image resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.ImageQuery.TransformedSrcArguments
static interface	Storefront.ImageQuery.TransformedSrcArgumentsDefinition

Method Summary

Modifier and Type	Method and Description
Storefront.ImageQuery	altText() A word or phrase to share the nature or contents of an image.
Storefront.ImageQuery	height() The original height of the image in pixels.
Storefront.ImageQuery	id() A unique identifier for the image.
Storefront.ImageQuery	originalSrc() The location of the original image as a URL.
Storefront.ImageQuery	src() Deprecated. Previously an image had a single `src` field. This could either return the original image location or a URL that contained transformations such as sizing or scale. These transformations were specified by arguments on the parent field. Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. `originalSrc` - the original unmodified image URL `transformedSrc` - the image URL with the specified transformations included To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. Before: ```graphql { shop { productImages(maxWidth: 200, scale: 2) { edges { node { src } } } } } ``` After: ```graphql { shop { productImages { edges { node { transformedSrc(maxWidth: 200, scale: 2) } } } } } ```
Storefront.ImageQuery	transformedSrc() The location of the transformed image as a URL.
Storefront.ImageQuery	transformedSrc(Storefront.ImageQuery.TransformedSrcArgumentsDefinition argsDef) The location of the transformed image as a URL.
Storefront.ImageQuery	width() The original width of the image in pixels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

altText

public Storefront.ImageQuery altText()

A word or phrase to share the nature or contents of an image.

height

public Storefront.ImageQuery height()

The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify.

id

public Storefront.ImageQuery id()

A unique identifier for the image.

originalSrc

public Storefront.ImageQuery originalSrc()

The location of the original image as a URL. If there are any existing transformations in the original source URL, they will remain and not be stripped.

src

@Deprecated
public Storefront.ImageQuery src()

Deprecated. Previously an image had a single `src` field. This could either return the original image location or a URL that contained transformations such as sizing or scale. These transformations were specified by arguments on the parent field. Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. `originalSrc` - the original unmodified image URL `transformedSrc` - the image URL with the specified transformations included To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. Before: ```graphql { shop { productImages(maxWidth: 200, scale: 2) { edges { node { src } } } } } ``` After: ```graphql { shop { productImages { edges { node { transformedSrc(maxWidth: 200, scale: 2) } } } } } ```

The location of the image as a URL.

transformedSrc

public Storefront.ImageQuery transformedSrc()

The location of the transformed image as a URL. 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 does not support will be ignored.

transformedSrc

public Storefront.ImageQuery transformedSrc(Storefront.ImageQuery.TransformedSrcArgumentsDefinition argsDef)

The location of the transformed image as a URL. 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 does not support will be ignored.

width

public Storefront.ImageQuery width()

The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify.