AlignedStencil

Type: Class

Aligned stencils can be created using the functions on Stencil

Constructor

# Name Type Description
1. gaps
2. blueprint
3. dom
4. stencilMetadata

Properties

Name Type Description
dom Node

Holds the root of this stencil

Methods

Name Description
getGapMetadata

Get the metadata for the specified gap

The metadata describes properties of the gap, namely: type, multiplicity, requiredness and emptyness


  Arguments
# Name Type Description
1. gapId String

The id of the gap

  Returns

Type: Object

The metadata of the gap

getRange

Get a captured range.


  Arguments
# Name Type Description
1. startGapId String

The id of the gap to serve as the start of the range

2. endGapId String

The id of the gap to serve as the end of the range

  Returns
getValue

Get the contents of a given gap


  Arguments
# Name Type Description
1. gapId String

The id of the gap

  Returns

Type: Any

The contents of the gap, what is returned wil vary based on how the gap was parameterized

setValue

Set the contents of a gap


  Arguments
# Name Type Description
1. gapId String

The id of the gap to fill

2. value Node | Array<Node>

The new contents of the gap