API Docs for: 1.3.12
Show:

PropertyValueSpecification Class

Schema.org/PropertyValueSpecification A Property value specification.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

additionalType

URL

Schema.org/additionalType 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.

alternateName

Text

Schema.org/alternateName An alias for the item.

defaultValue

Thing

Schema.org/defaultValue The default value of the input. For properties that expect a literal, the default is a literal value, for properties that expect an object, it's an ID reference to one of the current values.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

maxValue

Number

Schema.org/maxValue The upper value of some characteristic or property.

minValue

Number

Schema.org/minValue The lower value of some characteristic or property.

multipleValues

Boolean

Schema.org/multipleValues Whether multiple values are allowed for the property. Default is false.

name

Text

Schema.org/name The name of the item.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

readonlyValue

Boolean

Schema.org/readonlyValue Whether or not a property is mutable. Default is false. Specifying this for a property that also has a value makes it act similar to a "hidden" input in an HTML form.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

stepValue

Number

Schema.org/stepValue The stepValue attribute indicates the granularity that is expected (and required) of the value in a PropertyValueSpecification.

url

URL

Schema.org/url URL of the item.

valueMaxLength

Number

Schema.org/valueMaxLength Specifies the allowed range for number of characters in a literal value.

valueMinLength

Number

Schema.org/valueMinLength Specifies the minimum allowed range for number of characters in a literal value.

valueName

Text

Schema.org/valueName Indicates the name of the PropertyValueSpecification to be used in URL templates and form encoding in a manner analogous to HTML's input@name.

valuePattern

Text

Schema.org/valuePattern Specifies a regular expression for testing literal values according to the HTML spec.

valueRequired

Boolean

Schema.org/valueRequired Whether the property must be filled in to complete the action. Default is false.