# Class: ItemList


_a list of entities plus metadata_





URI: [schema:ItemList](http://schema.org/ItemList)






```{mermaid}
 classDiagram
    class ItemList
    click ItemList href "../ItemList"
      ItemList : additionalType
        
      ItemList : categories
        
      ItemList : description
        
      ItemList : id
        
      ItemList : itemListElements
        
          
    
    
    ItemList --> "*" ListItem : itemListElements
    click ListItem href "../ListItem"

        
      ItemList : itemMetadataMap
        
          
    
    
    ItemList --> "*" ListItem : itemMetadataMap
    click ListItem href "../ListItem"

        
      ItemList : keywords
        
      ItemList : name
        
      ItemList : numberOfItems
        
          
    
    
    ItemList --> "0..1" ItemListOrderType : numberOfItems
    click ItemListOrderType href "../ItemListOrderType"

        
      ItemList : wasGeneratedBy
        
      
```




<!-- no inheritance hierarchy -->


## Slots

| Name | Cardinality and Range | Description | Inheritance |
| ---  | --- | --- | --- |
| [id](id.md) | 0..1 <br/> [Uriorcurie](Uriorcurie.md) | The identifier of the list | direct |
| [name](name.md) | 0..1 _recommended_ <br/> [String](String.md) | The name of the list | direct |
| [description](description.md) | 0..1 _recommended_ <br/> [String](String.md) | A description of the list | direct |
| [itemListElements](itemListElements.md) | * <br/> [ListItem](ListItem.md) | The entities in the list, represented as a simple list | direct |
| [numberOfItems](numberOfItems.md) | 0..1 <br/> [ItemListOrderType](ItemListOrderType.md) | The order of the items in the list | direct |
| [itemMetadataMap](itemMetadataMap.md) | * <br/> [ListItem](ListItem.md) | The entities in the list, represented as a map keyed by item id | direct |
| [categories](categories.md) | * <br/> [Uriorcurie](Uriorcurie.md) | Controlled terms used to categorize an element | direct |
| [keywords](keywords.md) | * <br/> [String](String.md) | Keywords or tags used to describe the element | direct |
| [additionalType](additionalType.md) | * <br/> [Uriorcurie](Uriorcurie.md) | An additional type for the item, typically used for adding more specific type... | direct |
| [wasGeneratedBy](wasGeneratedBy.md) | * <br/> [Uriorcurie](Uriorcurie.md) | The provenance of the list, for example a script that generated the list | direct |





## Usages

| used by | used in | type | used |
| ---  | --- | --- | --- |
| [ItemListCollection](ItemListCollection.md) | [itemLists](itemLists.md) | range | [ItemList](ItemList.md) |




## Aliases


* list



## Identifier and Mapping Information







### Schema Source


* from schema: https://w3id.org/oak/item-list




## Mappings

| Mapping Type | Mapped Value |
| ---  | ---  |
| self | schema:ItemList |
| native | itemList:ItemList |
| close | rdf:List |







## LinkML Source

<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx -->

### Direct

<details>
```yaml
name: ItemList
description: a list of entities plus metadata
from_schema: https://w3id.org/oak/item-list
aliases:
- list
close_mappings:
- rdf:List
attributes:
  id:
    name: id
    description: The identifier of the list
    comments:
    - this is optional and hence declared as an identifier
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    domain_of:
    - ItemList
    - Thing
    range: uriorcurie
  name:
    name: name
    description: The name of the list
    examples:
    - description: mTOR-pathway
    - description: my-shopping-list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    domain_of:
    - ItemList
    - Thing
    range: string
    recommended: true
  description:
    name: description
    description: A description of the list
    examples:
    - description: A list of genes in the mTOR pathway
    - description: A list of items to buy at the supermarket
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    domain_of:
    - ItemList
    - Thing
    range: string
    recommended: true
  itemListElements:
    name: itemListElements
    description: The entities in the list, represented as a simple list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: itemListElement
    slot_uri: schema:itemListElement
    domain_of:
    - ItemList
    range: ListItem
    multivalued: true
    inlined: false
  numberOfItems:
    name: numberOfItems
    description: The order of the items in the list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: schema:numberOfItems
    domain_of:
    - ItemList
    range: ItemListOrderType
  itemMetadataMap:
    name: itemMetadataMap
    description: The entities in the list, represented as a map keyed by item id
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    domain_of:
    - ItemList
    range: ListItem
    multivalued: true
    inlined: true
  categories:
    name: categories
    description: Controlled terms used to categorize an element.
    comments:
    - if you wish to use uncontrolled terms or terms that lack identifiers then use
      the keywords element
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: category
    slot_uri: dcterms:subject
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
  keywords:
    name: keywords
    description: Keywords or tags used to describe the element
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: keyword
    slot_uri: schema:keywords
    domain_of:
    - ItemList
    range: string
    multivalued: true
  additionalType:
    name: additionalType
    description: An additional type for the item, typically used for adding more specific
      types from external vocabularies in microdata syntax. This is a relationship
      between something and a class that the thing is in. In RDFa syntax, it is better
      to use the native RDFa syntax - the 'typeof' attribute - for multiple types.
      Schema.org tools may have only weaker understanding of extra types, in particular
      those defined externally.
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: schema:additionalType
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
  wasGeneratedBy:
    name: wasGeneratedBy
    description: The provenance of the list, for example a script that generated the
      list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: prov:wasGeneratedBy
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
class_uri: schema:ItemList

```
</details>

### Induced

<details>
```yaml
name: ItemList
description: a list of entities plus metadata
from_schema: https://w3id.org/oak/item-list
aliases:
- list
close_mappings:
- rdf:List
attributes:
  id:
    name: id
    description: The identifier of the list
    comments:
    - this is optional and hence declared as an identifier
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    alias: id
    owner: ItemList
    domain_of:
    - ItemList
    - Thing
    range: uriorcurie
  name:
    name: name
    description: The name of the list
    examples:
    - description: mTOR-pathway
    - description: my-shopping-list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    alias: name
    owner: ItemList
    domain_of:
    - ItemList
    - Thing
    range: string
    recommended: true
  description:
    name: description
    description: A description of the list
    examples:
    - description: A list of genes in the mTOR pathway
    - description: A list of items to buy at the supermarket
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    alias: description
    owner: ItemList
    domain_of:
    - ItemList
    - Thing
    range: string
    recommended: true
  itemListElements:
    name: itemListElements
    description: The entities in the list, represented as a simple list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: itemListElement
    slot_uri: schema:itemListElement
    alias: itemListElements
    owner: ItemList
    domain_of:
    - ItemList
    range: ListItem
    multivalued: true
    inlined: false
  numberOfItems:
    name: numberOfItems
    description: The order of the items in the list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: schema:numberOfItems
    alias: numberOfItems
    owner: ItemList
    domain_of:
    - ItemList
    range: ItemListOrderType
  itemMetadataMap:
    name: itemMetadataMap
    description: The entities in the list, represented as a map keyed by item id
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    alias: itemMetadataMap
    owner: ItemList
    domain_of:
    - ItemList
    range: ListItem
    multivalued: true
    inlined: true
  categories:
    name: categories
    description: Controlled terms used to categorize an element.
    comments:
    - if you wish to use uncontrolled terms or terms that lack identifiers then use
      the keywords element
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: category
    slot_uri: dcterms:subject
    alias: categories
    owner: ItemList
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
  keywords:
    name: keywords
    description: Keywords or tags used to describe the element
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    singular_name: keyword
    slot_uri: schema:keywords
    alias: keywords
    owner: ItemList
    domain_of:
    - ItemList
    range: string
    multivalued: true
  additionalType:
    name: additionalType
    description: An additional type for the item, typically used for adding more specific
      types from external vocabularies in microdata syntax. This is a relationship
      between something and a class that the thing is in. In RDFa syntax, it is better
      to use the native RDFa syntax - the 'typeof' attribute - for multiple types.
      Schema.org tools may have only weaker understanding of extra types, in particular
      those defined externally.
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: schema:additionalType
    alias: additionalType
    owner: ItemList
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
  wasGeneratedBy:
    name: wasGeneratedBy
    description: The provenance of the list, for example a script that generated the
      list
    from_schema: https://w3id.org/oak/item-list
    rank: 1000
    slot_uri: prov:wasGeneratedBy
    alias: wasGeneratedBy
    owner: ItemList
    domain_of:
    - ItemList
    range: uriorcurie
    multivalued: true
class_uri: schema:ItemList

```
</details>