OBJECT
Block

Part of a sequence, roughly equivalent to a USFM paragraph
GraphQL Schema definition

type Block {
#   The length in bytes of the succinct representation of c (block items)
cBL: Int! 
#   The length in bytes of the succinct representation of bg (block grafts)
bgBL: Int! 
#   The length in bytes of the succinct representation of os (open scopes)
osBL: Int! 
#   The length in bytes of the succinct representation of is (included scopes)
isBL: Int! 
#   The length in bytes of the succinct representation of nt (nextToken at the start 
#   of the block)
ntBL: Int! 
#   The number of items in the succinct representation of c (block items)
cL: Int! 
#   The number of items in the succinct representation of bg (block grafts)
bgL: Int! 
#   The number of items in the succinct representation of os (open scopes)
osL: Int! 
#   The number of items in the succinct representation of is (included scopes)
isL: Int! 
#   A list of included scopes for this block
is: [Item!]! 
#   A list of open scopes for this block
os: [Item!]! 
#   The block scope for this block
bs: Item! 
#   A list of block grafts for this block
bg: [Item!]! 
#   The value of nextToken at the start of this block
nt: Int! 
#   A list of items from the c (content) field of the block
# 
# Arguments
#   withScopes: Only return items that are within specific scopes
#   anyScope: If true, withScopes filtering matches items within at 
#   least one of the specified scopes
#   withScriptureCV: Only return items that are within a 
#   chapterVerse range (ch or ch:v or ch:v-v or ch:v-ch:v)
#   includeContext: If true, adds scope and nextToken information 
#   to each token
items(
withScopes: [String!],
anyScope: Boolean,
withScriptureCV: String,
includeContext: Boolean
): [Item!]! 
#   A list of tokens from the c (content) field of the block
# 
# Arguments
#   withScopes: Only return tokens that are within specific scopes
#   anyScope: If true, withScopes filtering matches tokens within 
#   at least one of the specified scopes
#   withScriptureCV: Only return tokens that are within a 
#   chapterVerse range (ch or ch:v or ch:v-v or ch:v-ch:v)
#   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
#   withMatchingChars: Return tokens whose payload matches one of 
#   the specified regexes
#   withSubTypes: Return tokens with one of the specified subTypes
tokens(
withScopes: [String!],
anyScope: Boolean,
withScriptureCV: String,
includeContext: Boolean,
withChars: [String!],
withMatchingChars: [String!],
withSubTypes: [String!]
): [Item!]! 
#   The text of the block as a single string
# 
# Arguments
#   withScriptureCV: Only return text that is within a chapterVerse 
#   range (ch or ch:v or ch:v-v or ch:v-ch:v)
#   normalizeSpace: If true, converts each whitespace character to 
#   a single space
text(withScriptureCV: String, normalizeSpace: Boolean): String! 
#   'Block items grouped by scopes or milestones
# 
# Arguments
#   byScopes: Produce one itemGroup for every match of the list of 
#   scopes
#   byMilestones: Start a new itemGroup whenever a milestone in the 
#   list is encountered
itemGroups(byScopes: [String!], byMilestones: [String!]): [ItemGroup]! 
#   The block content as a string in a compact eyeballable format
dump: String! 
#   A list of the labels for the block\'s bs, os and is scopes
# 
# Arguments
#   startsWith: Only include scopes that begin with this value
scopeLabels(startsWith: [String!]): [String!]! 
}
Block

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
