{{ documents }}

documents Summary

Contains multiple documents.

documents Properties

FieldTypeDescription
object_typestring"documents"
is_validtrue/falsetrue if this contains at least one document
prependedlist of documentsdocuments that will be listed at the beginning of the items list
fetchedlist of documentsThe primary list of documents to be included in the items list
appendedlist of documentsdocuments that will be listed at the end of the items list
appended_uniquelist of documentsdocuments that will be listed at the end of the items list, excluding any documents that are already included in either the prepended or fetched lists
itemslist of documentsThe full list of documents in the proper order and uniqueness, including prepended, fetched, and appended documents
sizenumberThe total number of items in the list of items, including prepended, fetched, and appended documents
limitnumberThe maximum number of documents that could have been fetched dynamically from the database
startnumberThe 1-based index of the first document that was (or would have been) dynamically fetched from the database
pagenumberThe 1-based index of the first "page" of documents that could have been fetched dynamically from the database - as determined by the start and limit properties
total_countnumberThe total number of documents in the database that matched the provided filter parameters when fetching the list of fetched documents
total_pagesnumberThe total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched documents - as determined by the total_count and limit properties
outputhtmlThe default output that the documents will produce when it is output directly to the template - using the "output_in_list" property of each document in the items list