Interface: ImageSchema¶
A schema representing a return value or object property that is provided as a string, which Superhuman Docs should interpret as an image.
Extends¶
BaseStringSchema<ImageReference|ImageAttachment>
Properties¶
codaType¶
codaType:
ImageReference|ImageAttachment
Instructs Superhuman Docs to render this value as an Image.
Overrides¶
BaseStringSchema.codaType
description?¶
optionaldescription:string
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?¶
optionalheight:string|number
How tall to render the image (supports number or formula). Use 0 for default.
imageCornerStyle?¶
optionalimageCornerStyle:ImageCornerStyle
ImageCornerStyle type specifying style of corners on images. If unspecified, default is Rounded.
imageOutline?¶
optionalimageOutline:ImageOutline
ImageOutline type specifying style of outline on images. If unspecified, default is Solid.
imageShapeStyle?¶
optionalimageShapeStyle:ImageShapeStyle
ImageShapeStyle type specifying shape of image. If unspecified, default is Auto.
type¶
type:
String
Identifies this schema as a string.
Inherited from¶
BaseStringSchema.type
width?¶
optionalwidth:string|number
How wide to render the image (supports number or formula). Use 0 for default.