Property Value
A property-value pair.
Always use specific properties when they exist and you can populate them. Using PropertyValue
as a substitute will typically not convey as much semantic information as using the specific property. Most of the time a PropertyValue
node will need a value
property (e.g. most of the examples on https://schema.org/PropertyValue have one) so this schema make that property required. This type is mainly provided for use in Thing.identifiers
(see the notes there).
Properties​
Name | @id | Type | Description | Inherited from |
---|---|---|---|---|
value | schema:value | boolean or integer or number or string | The value of the property. See note 1. | PropertyValue |
alternateNames | schema:alternateName | Array of string | Alternate names (aliases) for the item. | Thing |
description | schema:description | Array of BlockContent or Array of InlineContent or string | A description of the item. See note 2. | Thing |
id | schema:id | string | The identifier for this item. | Entity |
identifiers | schema:identifier | Array of (PropertyValue or string) | Any kind of identifier for any kind of Thing. See note 3. | Thing |
images | schema:image | Array of (ImageObject or Format 'uri') | Images of the item. | Thing |
meta | stencila:meta | object | Metadata associated with this item. | Entity |
name | schema:name | string | The name of the item. | Thing |
propertyID | schema:propertyID | string | A commonly used identifier for the characteristic represented by the property. | PropertyValue |
url | schema:url | Format 'uri' | The URL of the item. | Thing |
Notes​
- value : This follows the expected types of https://schema.org/value except for
StructuredValue
, which at the time of writing was not implemented in this schema. - description : Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The
minItems
restriction avoids a string being coerced into an array with a single string item. - identifiers : Some identifiers have specific properties e.g the
issn
property for thePeriodical
type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using aPropertyValue
will usually be better because it allows forpropertyID
(i.e. the type of identifier).
Related​
- Parent: Thing
- Descendants: None
Available as​
- JSON-LD
- JSON Schema
- Python
class PropertyValue
- TypeScript
interface PropertyValue
- R
class PropertyValue
- Rust
struct PropertyValue
Source​
This documentation was generated from PropertyValue.schema.yaml.