• Public
  • Public/Protected
  • All

Represents card data, and closely resembles arContent.




  name: 'My card',
  description: 'More information about the contents',
  image: '/path/to/some/image.jpg',
  url: '/path/to/more/details/'


  • CardData



Optional description

description: undefined | string

A description used for the item.

Optional disambiguatingDescription

disambiguatingDescription: undefined | string

A short description used for disambiguating the item from other similar items. Not used for rendering.

Optional image

image: undefined | string

The image for the item. For rendering images that are 16:9 are preferred.

Optional mainEntity

mainEntity: undefined | object

An additional entry for more information on the item. For example, if the url property points to a review of a website, mainEntity would point to the website itself.

Optional name

name: undefined | string

The name for the card.

Optional url

url: undefined | string

The URL for more information on the item.


  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc