Class ComponentScriptContext

• Object
  • dw.experience.ComponentScriptContext

This is the context that is handed over to the render and serialize function of the respective component type script.

String : render( [ComponentScriptContext](class_dw_experience_ComponentScriptContext.html) context) Object : serialize( [ComponentScriptContext](class_dw_experience_ComponentScriptContext.html) context)

Properties

component : Component Read Only

The component for which the corresponding component type script is currently executed.

componentRenderSettings : ComponentRenderSettings Read Only

As components are implicitly rendered as part of their hosting region via PageMgr.renderRegion(Region, RegionRenderSettings) there is the possibility to define render settings for the region itself but also for its contained components. The latter will be provided here so you further set or refine them for your component as part of the render function, i.e. to drive the shape of the component wrapper element.

content : Map Read Only

The processed version of the underlying unprocessed raw values (also see Component.getAttribute(String)) of this component's attributes which you can use in your respective component type render and serialize function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.

1. expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
2. conversion - the raw value (see Component.getAttribute(String)) is resolved into an actual DWScript object depending on the type of the attribute as specified in its respective attribute definition
   • boolean -> boolean
   • category -> Category
   • custom -> Map
   • cms_record -> CMSRecord
   • enum -> either string or integer
   • file -> MediaFile
   • image -> Image
   • integer -> integer
   • markup -> string
   • page -> string
   • product -> Product
   • string -> string
   • text -> string
   • url -> string

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getComponent() : Component

Returns the component for which the corresponding component type script is currently executed.

getComponentRenderSettings() : ComponentRenderSettings

As components are implicitly rendered as part of their hosting region via PageMgr.renderRegion(Region, RegionRenderSettings) there is the possibility to define render settings for the region itself but also for its contained components.

getContent() : Map

Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute(String)) of this component's attributes which you can use in your respective component type render and serialize function implementing your business and rendering/serialization functionality.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getComponent

getComponent() : Component

Returns the component for which the corresponding component type script is currently executed.

Returns:

the currently rendered component

getComponentRenderSettings

getComponentRenderSettings() : ComponentRenderSettings

As components are implicitly rendered as part of their hosting region via PageMgr.renderRegion(Region, RegionRenderSettings) there is the possibility to define render settings for the region itself but also for its contained components. The latter will be provided here so you further set or refine them for your component as part of the render function, i.e. to drive the shape of the component wrapper element.

Returns:

the component render settings

getContent

getContent() : Map

Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute(String)) of this component's attributes which you can use in your respective component type render and serialize function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.

1. expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
2. conversion - the raw value (see Component.getAttribute(String)) is resolved into an actual DWScript object depending on the type of the attribute as specified in its respective attribute definition
   • boolean -> boolean
   • category -> Category
   • custom -> Map
   • cms_record -> CMSRecord
   • enum -> either string or integer
   • file -> MediaFile
   • image -> Image
   • integer -> integer
   • markup -> string
   • page -> string
   • product -> Product
   • string -> string
   • text -> string
   • url -> string

Returns:

processed content attributes of the component