Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DesignModelDescription

Detailed human-readable information about a design model.

Hierarchy

  • DesignModelDescription

Index

Properties

Optional citation

citation: string

Plain-text written citations for images, description, or the design model itself.

default

(empty)

description

description: string

A long-form written description of the design model. Separate paragraphs with two newlines (\n\n).

Optional imageURL

imageURL: string | string[]

One or more URLs to use as image sources. Implementers may choose not to display images or to restrict valid image origins for security reasons.

In the Design Awareness app, images will only be shown when online.

default

(empty)

Optional moreInfoURL

moreInfoURL: string

Link the user can follow to learn more about the design model.

default

(empty)

Generated using TypeDoc