ShapeDataProcessingStep

Users have to define an object that maps properties that are stored in the item's tag to the corresponding names of the Property object. It is also possible to use wildcards to automatically copy multiple tag entries.

Example 1:

Given the following tag:

node.tag = {
data: {
firstname: 'Amy',
lastname: 'Kain',
},
}

The user can automatically map both properties using a wildcard nameMap:

{
"data.": ""
}

This processing step will then create two properties: one with 'firstname' as name and 'Amy' as Property.value and one with 'lastname' as name and 'Kain' as value.

Example 2:

Given this tag

node.tag = {
firstname: {
label: 'First Name',
value: 'Amy',
prompt: 'The first name.',
},
}

And this nameMap

{
"firstname": "FirstName"
}

The processing step will create one property with name 'FirstName', Property.label 'First Name', Property.value 'Amy', and Property.prompt 'The first name'.

Example 3:

It is also possible to map property keys that differ from the VSDX cell names

node.tag = {
firstNameLabel: 'First Name',
firstNameValue: 'Amy',
}

Using a nameMap like this:

{
firstNameLabel: "firstname.label"
firstNameValue: "firstname.value"
}

The processing step will now create a property with 'firstname' as name, 'First Name' as Property.label, and 'Amy' as Property.value.

All created properties can be customized further through the callback passed to the constructor.

Example 4:

For generating complex data labels (e.g. containing spaces), a callback function can be used to set the Property.label on the property. This is required, because the ShapeDataProcessingStep only sets the Property.name, which must not contain special characters such as spaces. The VSDX Export will replace special characters in properties like Property.name during the serialization.

node.tag = {
someProperty: 'Some Value',
}
 
new ShapeDataProcessingStep(
(_, item) => INode.isInstance(item),
{
someProperty: 'Some Property',
},
(property, value, tag) => {
if (!property.label) {
  property.label = property.name
}
},
)

This processing step has to be registered to the list of IShapeProcessingSteps of the VsdxExportConfiguration.