Skip to content
ParaShape

Image

A SceneObject whose data is { "type": "image", …ImageRecord } — the tag plus every field of ImageRecord.

ImageRecord

Used by: CellType, PieceData, RenderCell.

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ImageEntity } from "./ImageEntity.js";

export type ImageRecord = { 
/**
 * geometry — the placed image entities.
 */
images: Array<ImageEntity>, };
fieldtypeoptionalclassdoc
imagesArray<ImageEntity>nogeometrygeometry — the placed image entities.

ImageEntity

Used by: ImageRecord.

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

export type ImageEntity = { 
/**
 * intent — free-form record data.
 */
attributes?: Record<string, unknown>, 
/**
 * identity — the image's address (`data:` / `https:`).
 */
url: string, 
/**
 * geometry — the rectangle's origin corner, mm.
 */
origin: [number, number, number], 
/**
 * geometry — the rectangle's width axis, unit.
 */
xAxis: [number, number, number], 
/**
 * geometry — the rectangle's height axis, unit.
 */
yAxis: [number, number, number], 
/**
 * geometry — extent along `x_axis`, mm.
 */
width: number, 
/**
 * geometry — extent along `y_axis`, mm.
 */
height: number, };
fieldtypeoptionalclassdoc
attributesRecord<string, unknown>yesintentintent — free-form record data.
urlstringnoidentityidentity — the image's address (data: / https:).
origin[number, number, number]nogeometrygeometry — the rectangle's origin corner, mm.
xAxis[number, number, number]nogeometrygeometry — the rectangle's width axis, unit.
yAxis[number, number, number]nogeometrygeometry — the rectangle's height axis, unit.
widthnumbernogeometrygeometry — extent along x_axis, mm.
heightnumbernogeometrygeometry — extent along y_axis, mm.
📖 1 min read