OBJECT

cIndex

A chapter index entry

link GraphQL Schema definition

  • type cIndex {
  • # The chapter number
  • chapter: Int!
  • # The zero-indexed number of the block where the chapter starts
  • startBlock: Int
  • # The zero-indexed number of the block where the chapter ends
  • endBlock: Int
  • # The zero-indexed position of the item where the chapter starts
  • startItem: Int
  • # The zero-indexed position of the item where the chapter ends
  • endItem: Int
  • # The value of nextToken at the beginning of the chapter
  • nextToken: Int
  • # A list of items for this chapter
  • #
  • # Arguments
  • # includeContext: If true, adds scope and nextToken information
  • # to each token
  • items(includeContext: Boolean): [Item]!
  • # The items as a string in a compact eyeballable format
  • dumpItems: String
  • # A list of tokens for this chapter
  • #
  • # Arguments
  • # includeContext: If true, adds scope and nextToken information
  • # to each token
  • # withChars: Return tokens whose payload is an exact match to one
  • # of the specified strings
  • # withSubTypes: Return tokens with one of the specified subTypes
  • tokens(includeContext: Boolean, withChars: [String!], withSubTypes: [String!]): [Item]!
  • # The text of the chapter as a single string
  • #
  • # Arguments
  • # normalizeSpace: If true, converts each whitespace character to
  • # a single space
  • text(normalizeSpace: Boolean): String!
  • }