# Interface: ImageSchema

Defined in: [schema.ts:738](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L738)

A schema representing a return value or object property that is provided as a string, which Coda should interpret as an image.

## Extends

- `BaseStringSchema`\<[`ImageReference`](../../enumerations/ValueHintType/#imagereference) | [`ImageAttachment`](../../enumerations/ValueHintType/#imageattachment)>

## Properties

### codaType

> **codaType**: [`ImageReference`](../../enumerations/ValueHintType/#imagereference) | [`ImageAttachment`](../../enumerations/ValueHintType/#imageattachment)

Defined in: [schema.ts:740](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L740)

Instructs Coda to render this value as an Image.

#### Overrides

`BaseStringSchema.codaType`

______________________________________________________________________

### description?

> `optional` **description**: `string`

Defined in: [schema.ts:285](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L285)

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

#### Inherited from

`BaseStringSchema.description`

______________________________________________________________________

### height?

> `optional` **height**: `string` | `number`

Defined in: [schema.ts:750](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L750)

How tall to render the image (supports number or formula). Use 0 for default.

______________________________________________________________________

### imageCornerStyle?

> `optional` **imageCornerStyle**: [`ImageCornerStyle`](../../enumerations/ImageCornerStyle/)

Defined in: [schema.ts:744](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L744)

ImageCornerStyle type specifying style of corners on images. If unspecified, default is Rounded.

______________________________________________________________________

### imageOutline?

> `optional` **imageOutline**: [`ImageOutline`](../../enumerations/ImageOutline/)

Defined in: [schema.ts:742](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L742)

ImageOutline type specifying style of outline on images. If unspecified, default is Solid.

______________________________________________________________________

### imageShapeStyle?

> `optional` **imageShapeStyle**: [`ImageShapeStyle`](../../enumerations/ImageShapeStyle/)

Defined in: [schema.ts:746](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L746)

ImageShapeStyle type specifying shape of image. If unspecified, default is Auto.

______________________________________________________________________

### type

> **type**: [`String`](../../enumerations/ValueType/#string)

Defined in: [schema.ts:807](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L807)

Identifies this schema as a string.

#### Inherited from

`BaseStringSchema.type`

______________________________________________________________________

### width?

> `optional` **width**: `string` | `number`

Defined in: [schema.ts:748](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L748)

How wide to render the image (supports number or formula). Use 0 for default.
