Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 1.24 KB

the-representation-type-object-6f467c5.md

File metadata and controls

86 lines (57 loc) · 1.24 KB

The Representation Type Object

Note:

This step is required only if you want to define your own representation types in addition to the predefined ones shipped with APF. For more information, see Predefined Representation Types.

The representation type object defines how data is depicted on the UI. It has the following format:


{
  "type" : "representationType",    // optional
  "id" : "<id>",
  "constructor" : <constructor>,
  "picture" : "<path/file>",    // relative to Web application root
  "label" : <label>
}

The properties used in the representation type object denote the following:

Properties

Description

id

Unique ID of type string.

constructor

Defines the implementing function object of the representation.

picture

Icon indicating the representation type.

label

Defines the label text.