API Docs for: 1.3.12
Show:

WebPageElement Class

Schema.org/WebPageElement A web page element, like a table or an image.

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

about

Thing

Schema.org/about The subject matter of the content.

accessibilityAPI

Text

Schema.org/accessibilityAPI Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values).

accessibilityControl

Text

Schema.org/accessibilityControl Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values).

accessibilityFeature

Text

Schema.org/accessibilityFeature Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values).

accessibilityHazard

Text

Schema.org/accessibilityHazard A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values).

accessibilitySummary

Text

Schema.org/accessibilitySummary A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."

accessMode

Text

Schema.org/accessMode The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual.

accessModeSufficient

Text

Schema.org/accessModeSufficient A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual.

accountablePerson

Person

Schema.org/accountablePerson Specifies the Person that is legally accountable for the CreativeWork.

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.

aggregateRating

AggregateRating

Schema.org/aggregateRating The overall rating, based on a collection of reviews or ratings, of the item.

alternateName

Text

Schema.org/alternateName An alias for the item.

alternativeHeadline

Text

Schema.org/alternativeHeadline A secondary title of the CreativeWork.

associatedMedia

MediaObject

Schema.org/associatedMedia A media object that encodes this CreativeWork. This property is a synonym for encoding.

audience

Audience

Schema.org/audience An intended audience, i.e. a group for whom something was created.

audio

AudioObject

Schema.org/audio An embedded audio object.

author

Person

Schema.org/author The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.

award

Text

Schema.org/award An award won by or for this item.

awards

Text

Schema.org/awards Awards won by or for this item.

character

Person

Schema.org/character Fictional person connected with a creative work.

citation

Text

Schema.org/citation A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.

comment

Comment

Schema.org/comment Comments, typically from users.

commentCount

Integer

Schema.org/commentCount The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.

contentLocation

Place

Schema.org/contentLocation The location depicted or described in the content. For example, the location in a photograph or painting.

contentRating

Text

Schema.org/contentRating Official rating of a piece of content—for example,'MPAA PG-13'.

contributor

Organization

Schema.org/contributor A secondary contributor to the CreativeWork or SchemaEvent.

copyrightHolder

Person

Schema.org/copyrightHolder The party holding the legal copyright to the CreativeWork.

copyrightYear

Number

Schema.org/copyrightYear The year during which the claimed copyright for the CreativeWork was first asserted.

creator

Person

Schema.org/creator The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.

dateCreated

Date

Schema.org/dateCreated The date on which the CreativeWork was created or the item was added to a DataFeed.

dateModified

DateTime

Schema.org/dateModified The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.

datePublished

Date

Schema.org/datePublished Date of first broadcast/publication.

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.

discussionUrl

URL

Schema.org/discussionUrl A link to the page containing the comments of the CreativeWork.

editor

Person

Schema.org/editor Specifies the Person who edited the CreativeWork.

educationalAlignment

AlignmentObject

Schema.org/educationalAlignment An alignment to an established educational framework.

educationalUse

Text

Schema.org/educationalUse The purpose of a work in the context of education; for example, 'assignment', 'group work'.

encoding

MediaObject

Schema.org/encoding A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.

encodings

MediaObject

Schema.org/encodings A media object that encodes this CreativeWork.

exampleOfWork

CreativeWork

Schema.org/exampleOfWork A creative work that this work is an example/instance/realization/derivation of.

fileFormat

Text

Schema.org/fileFormat Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.

funder

Person

Schema.org/funder A person or organization that supports (sponsors) something through some kind of financial contribution.

genre

URL

Schema.org/genre Genre of the creative work, broadcast channel or group.

hasPart

CreativeWork

Schema.org/hasPart Indicates a CreativeWork that is (in some sense) a part of this CreativeWork.

headline

Text

Schema.org/headline Headline of the article.

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]].

inLanguage

Language

Schema.org/inLanguage The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]].

interactionStatistic

InteractionCounter

Schema.org/interactionStatistic The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.

interactivityType

Text

Schema.org/interactivityType The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.

isAccessibleForFree

Boolean

Schema.org/isAccessibleForFree A flag to signal that the publication is accessible for free.

isBasedOn

Product

Schema.org/isBasedOn A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.

isBasedOnUrl

URL

Schema.org/isBasedOnUrl A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.

isFamilyFriendly

Boolean

Schema.org/isFamilyFriendly Indicates whether this content is family friendly.

isPartOf

CreativeWork

Schema.org/isPartOf Indicates a CreativeWork that this CreativeWork is (in some sense) part of.

keywords

Text

Schema.org/keywords Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.

learningResourceType

Text

Schema.org/learningResourceType The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.

license

CreativeWork

Schema.org/license A license document that applies to this content, typically indicated by URL.

locationCreated

Place

Schema.org/locationCreated The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.

mainEntity

Thing

Schema.org/mainEntity Indicates the primary entity described in some page or other CreativeWork.

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.

material

URL

Schema.org/material A material that something is made from, e.g. leather, wool, cotton, paper.

mentions

Thing

Schema.org/mentions Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.

name

Text

Schema.org/name The name of the item.

offers

Offer

Schema.org/offers An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event.

position

Integer

Schema.org/position The position of an item in a series or sequence of items.

potentialAction

Action

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

producer

Person

Schema.org/producer The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.).

provider

Person

Schema.org/provider The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

publication

PublicationEvent

Schema.org/publication A publication event associated with the item.

publisher

Person

Schema.org/publisher The publisher of the creative work.

publishingPrinciples

URL

Schema.org/publishingPrinciples Link to page describing the editorial principles of the organization primarily responsible for the creation of the CreativeWork.

recordedAt

SchemaEvent

Schema.org/recordedAt The SchemaEvent where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.

releasedEvent

PublicationEvent

Schema.org/releasedEvent The place and time the release was issued, expressed as a PublicationEvent.

review

Review

Schema.org/review A review of the item.

reviews

Review

Schema.org/reviews Review of the item.

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.

schemaVersion

URL

Schema.org/schemaVersion Indicates (by URL or string) a particular version of a schema used in some CreativeWork. For example, a document could declare a schemaVersion using an URL such as schema:version/2.0/ if precise indication of schema version was required by some application.

sourceOrganization

Organization

Schema.org/sourceOrganization The Organization on whose behalf the creator was working.

spatialCoverage

Place

Schema.org/spatialCoverage The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.

sponsor

Organization

Schema.org/sponsor A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event.

temporalCoverage

URL

Schema.org/temporalCoverage The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".

text

Text

Schema.org/text The textual content of this CreativeWork.

thumbnailUrl

URL

Schema.org/thumbnailUrl A thumbnail image relevant to the Thing.

timeRequired

Duration

Schema.org/timeRequired Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'P30M', 'P1H25M'.

translator

Person

Schema.org/translator Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.

typicalAgeRange

Text

Schema.org/typicalAgeRange The typical expected age range, e.g. '7-9', '11-'.

url

URL

Schema.org/url URL of the item.

version

Text

Schema.org/version The version of the CreativeWork embodied by a specified resource.

video

VideoObject

Schema.org/video An embedded video object.

workExample

CreativeWork

Schema.org/workExample Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook.