Type Alias UILayout

Type Declaration

• layoutCard

  Describes how to layout data using a card.

  • card: { body: object[]; title: string }

    • body: object[]

      Card Body

    • title: string

      Card Title

• layoutDataset

  Dataset Layout

  Used by any instance of DataSetList.

  Using a string value for the column, must be a valid field name.

  Using an object as the value enables any field to be setup so that it is a link to any of the urls within apiObject

  • dataset: { columns: [[string | object]] }

• layoutDetail

  This layout is for displaying a single object from a dataset.

  • detail: { layout: "single" | "double"; left: object; name: "detail"; right: object }

    Detail Layout

    Used by any instance of DetailLayout.

    • layout: "single" | "double"

    • left: object

    • name: "detail"

      Layout type that is to be used to render the data.

    • right: object

• layoutTable

  Table Layout

  if an entry in the array, is itself an array, this will render as collapsible under the row in question.

  Just like the dataset.columns keys, the value can be a link object. see UILayout.dataset for an example on the object and its keys.

  Used by any instance of DisplayTable

  • table: [string | object]

    This layout is for displaying multiple objects within a dataset.

• layoutTicket

  Ticket Layout

  • ticket: { blocks?: string; sidebar: [string] }

    This layout is for displaying data that is considered a work item, a ticket.

    • Optionalblocks?: string

      The string value for this field must be derived from apiObject._urls. Ensure that the model for this layout has UILayout.dataset defined as part of its layout.

      This URL will then be used to perform a query to the backend using the url. The results returned will then be displayed in DataSetList format via the CardDataSet card.

    • sidebar: [string]

      Fields to display in the sidebar

      Each value placed here must be an existing key as defined APIMetadata.fields of the current APIMetadata object being used.