capabilities.json

{
  "dataRoles": [
    {
      "name": "id",
      "displayName": "Document Id",
      "description": "Unique ID for the document",
      "kind": 0
    },
    {
      "name": "articleValue",
      "displayName": "Enable Highlights",
      "description": "Bind anything to this field to enable entity highlights",
      "kind": 1
    },
    {
      "name": "title",
      "displayName": "Title",
      "description": "Title of the document; shown on thumbnails and in the reader",
      "kind": 0
    },
    {
      "name": "summary",
      "displayName": "Summary",
      "description": "Summary of the content; only displayed on thumbnails",
      "kind": 0
    },
    {
      "name": "content",
      "displayName": "Content",
      "description": "Full content; only displayed in the reader",
      "kind": 0
    },
    {
      "name": "imageUrl",
      "displayName": "Title Image (url)",
      "description": "Main image for the document; displayed on thumbnails and in the reader",
      "kind": 0
    },
    {
      "name": "author",
      "displayName": "Author",
      "description": "Author for the byline displayed on thumbnails and in the reader",
      "kind": 0
    },
    {
      "name": "source",
      "displayName": "Source",
      "description": "Source domain for the document; shown in the reader header bar",
      "kind": 0
    },
    {
      "name": "sourceUrl",
      "displayName": "Source URL",
      "description": "Source link for the document; accessed by clicking the reader header bar",
      "kind": 0
    },
    {
      "name": "sourceImage",
      "displayName": "Source Image (url)",
      "description": "URL for an image to display in the top-right corner of the thumbnail",
      "kind": 0
    },
    {
      "name": "articleDate",
      "displayName": "Source Date",
      "description": "Date for the byline displayed on thumbnails and in the reader",
      "kind": 0
    },
    {
      "name": "entityId",
      "displayName": "Entity ID",
      "description": "Unique ID for each distinct entity; when working with uncertain data, used to merge entities that differ in Entity Type",
      "kind": 0
    },
    {
      "name": "entityType",
      "displayName": "Entity Type",
      "description": "Type or category of an entity",
      "kind": 0
    },
    {
      "name": "entityName",
      "displayName": "Entity Name",
      "description": "Display name of an entity; shown in Outline tooltips",
      "kind": 0
    },
    {
      "name": "entityPosition",
      "displayName": "Entity Position",
      "description": "Normalized position of an entity within the document; used to layout entity icons in Outlines",
      "kind": 0
    },
    {
      "name": "bucket",
      "displayName": "Segmented By",
      "description": "Used to segment entities with uncertain Entity Type",
      "kind": 0
    },
    {
      "name": "entityTypeColor",
      "displayName": "Entity Icon Color",
      "description": "Color of the entity's Outline icon",
      "kind": 0
    },
    {
      "name": "entityTypeClass",
      "displayName": "Entity Icon Class",
      "description": "Category of the entity used to select an icon for display on the Outline",
      "kind": 0
    },
    {
      "name": "dummySortingField",
      "displayName": "Sorting Field",
      "description": "Field that can be used to sort the visual's data based on an arbitrary column",
      "kind": 2
    }
  ],
  "dataViewMappings": [
    {
      "conditions": [
        {
          "id": {
            "max": 1
          },
          "title": {
            "max": 1
          },
          "summary": {
            "max": 1
          },
          "content": {
            "max": 1
          },
          "imageUrl": {
            "max": 1
          },
          "author": {
            "max": 1
          },
          "source": {
            "max": 1
          },
          "sourceUrl": {
            "max": 1
          },
          "articleDate": {
            "max": 1
          },
          "sourceImage": {
            "max": 1
          },
          "entityId": {
            "max": 1
          },
          "entityType": {
            "max": 1
          },
          "entityName": {
            "max": 1
          },
          "entityPosition": {
            "max": 1
          },
          "entityTypeColor": {
            "max": 1
          },
          "entityTypeClass": {
            "max": 1
          },
          "articleValue": {
            "max": 1
          },
          "bucket": {
            "max": 1
          }
        }
      ],
      "categorical": {
        "categories": {
          "select": [
            {
              "bind": {
                "to": "id"
              }
            },
            {
              "bind": {
                "to": "title"
              }
            },
            {
              "bind": {
                "to": "summary"
              }
            },
            {
              "bind": {
                "to": "content"
              }
            },
            {
              "bind": {
                "to": "imageUrl"
              }
            },
            {
              "bind": {
                "to": "author"
              }
            },
            {
              "bind": {
                "to": "source"
              }
            },
            {
              "bind": {
                "to": "sourceUrl"
              }
            },
            {
              "bind": {
                "to": "sourceImage"
              }
            },
            {
              "bind": {
                "to": "articleDate"
              }
            },
            {
              "bind": {
                "to": "entityType"
              }
            },
            {
              "bind": {
                "to": "entityId"
              }
            },
            {
              "bind": {
                "to": "entityName"
              }
            },
            {
              "bind": {
                "to": "entityPosition"
              }
            },
            {
              "bind": {
                "to": "entityTypeColor"
              }
            },
            {
              "bind": {
                "to": "entityTypeClass"
              }
            },
            {
              "bind": {
                "to": "bucket"
              }
            }
          ],
          "dataReductionAlgorithm": {
            "window": {
              "count": 200
            }
          }
        },
        "values": {
          "select": [
            {
              "bind": {
                "to": "articleValue"
              }
            }
          ],
          "dataReductionAlgorithm": {
            "window": {
              "count": 200
            }
          }
        }
      }
    }
  ],
  "objects": {
    "presentation": {
      "properties": {
        "strippetType": {
          "type": {
            "enumeration": [
              {
                "displayName": "Outlines",
                "value": "outlines"
              },
              {
                "displayName": "Thumbnails",
                "value": "thumbnails"
              }
            ]
          },
          "displayName": "Default",
          "description": "Determines Initial Strippet to Display"
        },
        "viewControls": {
          "type": {
            "bool": true
          },
          "displayName": "Switch",
          "description": "If true, view controls to switch between the strippet types will be displayed."
        },
        "wrap": {
          "type": {
            "bool": true
          },
          "displayName": "Wrap",
          "description": "If true, thumbnail cards wraps on overflow."
        }
      },
      "displayName": "Configuration"
    },
    "content": {
      "properties": {
        "readerContentType": {
          "type": {
            "enumeration": [
              {
                "displayName": "HTML",
                "value": "html"
              },
              {
                "displayName": "Readability URL",
                "value": "readability"
              }
            ]
          },
          "displayName": "Type",
          "description": "Specify the content format."
        },
        "summaryUrl": {
          "type": {
            "bool": true
          },
          "displayName": "Auto Summary URL",
          "description": "If true, populate Summary from Content's Readability URL, if applicable. Warning: this may quickly hit your request cap."
        }
      },
      "displayName": "Content"
    }
  },
  "supportsHighlight": true,
  "sorting": {
    "default": {}
  },
  "suppressDefaultTitle": true
}