Scale Intelligence■ Docs
Docs / The model / ListMapping

ListMapping.

How the items of a list field become entities of a kind, each keyed by the first of its key paths that holds a value, with one connection of a registered kind between the object's own entity and each item

Figure 1ListMappingspecified
LISTMAPPINGvalue at none scopethe list field of the source objectfieldtextkindKindOfEntitykey_namespacetextthe first path that holds a value keys the itemkey_paths[text]put before the key's value, for a platform-and-handle keykey_prefixtextoptionalname_pathtextoptionalconnectionKindOfConnectionoptionalthe object's entity's roleown_roletextoptionaleach item's roleitem_roletextoptionalthe item fields kept as long texts of the item's entity, each a claim stated by the source under the field's name, as the object's own texts aretexts[text]optionalthe item fields that are counts, each a reading of the measure on the item's entity at the time the page was readreadings[KindOfMeasure]optionalthe thing each item belongs to, when the item carries its keyparentListParentoptionalKINDOFENTITYthrough kindKINDOFCONNECTIONthrough connectionKINDOFMEASUREthrough readingsLISTPARENTthrough parent
ListMapping is a value at none scope. The drawing shows its fields and the objects that they point at.
kind
value
scope
none
key
none
store
none
family
sources

Fields#

fieldtyperequirednote
fieldtextyesthe list field of the source object
kindKindOfEntityyes
key_namespacetextyes
key_paths[text]yesthe first path that holds a value keys the item
key_prefixtextnoput before the key’s value, for a platform-and-handle key
name_pathtextno
connectionKindOfConnectionno
own_roletextnothe object’s entity’s role
item_roletextnoeach item’s role
texts[text]nothe item fields kept as long texts of the item’s entity, each a claim stated by the source under the field’s name, as the object’s own texts are
readingsKindOfMeasurenothe item fields that are counts, each a reading of the measure on the item’s entity at the time the page was read
parentListParentnothe thing each item belongs to, when the item carries its key

Routes that use it#

No route takes or returns ListMapping directly. The record holds it, and the objects that point at it reach it.