Factory class that creates IMasterProviders that map yFiles styles to masters and style sheets from a given VSSX stencil file.
Remarks
The created providers have to be registered to the list of master providers of the VsdxExportConfiguration.
The VsdxExportConfiguration.evaluateFormulas property must be set to true for
correct handling of stencils.
Members
Properties
Methods
createMappedEdgeProvider
(styleType: ClassConstructor<IEdgeStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given IEdgeStyle and returns the
master from the stencil file with the given NameId.name.
createMappedEdgeProvider
(styleType: ClassConstructor<IEdgeStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given IEdgeStyle and returns the master from the stencil file with the given NameId.name.
The created master provider will copy this master together with all required style sheets to the target VsdxPackage.
Note that the VsdxObject.parent and NameId.id properties of Masters and StyleSheets of the stencil VsdxPackage will be modified to fit the target VsdxPackage.
Parameters
- styleType: ClassConstructor<IEdgeStyle>
- masterName: string
The name of the master that shall be returned by the created master provider.
Return Value
createMappedLabelProvider
(styleType: ClassConstructor<ILabelStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given ILabelStyle and returns the
master from the stencil file with the given NameId.name.
createMappedLabelProvider
(styleType: ClassConstructor<ILabelStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given ILabelStyle and returns the master from the stencil file with the given NameId.name.
The created master provider will copy this master together with all required style sheets to the target VsdxPackage.
Note that the VsdxObject.parent and NameId.id properties of Masters and StyleSheets of the stencil VsdxPackage will be modified to fit the target VsdxPackage.
Parameters
- styleType: ClassConstructor<ILabelStyle>
- masterName: string
The name of the master that shall be returned by the created master provider.
Return Value
createMappedNodeProvider
(styleType: ClassConstructor<INodeStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given INodeStyle and returns the
master from the stencil file with the given NameId.name.
createMappedNodeProvider
(styleType: ClassConstructor<INodeStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given INodeStyle and returns the master from the stencil file with the given NameId.name.
The created master provider will copy this master together with all required style sheets to the target VsdxPackage.
Note that the VsdxObject.parent and NameId.id properties of Masters and StyleSheets of the stencil VsdxPackage will be modified to fit the target VsdxPackage.
Parameters
- styleType: ClassConstructor<INodeStyle>
- masterName: string
The name of the master that shall be returned by the created master provider.
Return Value
createMappedPortProvider
(styleType: ClassConstructor<IPortStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given IPortStyle and returns the
master from the stencil file with the given NameId.name.
createMappedPortProvider
(styleType: ClassConstructor<IPortStyle>, masterName: string): IMasterProviderCreates a IMasterProvider that applies to the given IPortStyle and returns the master from the stencil file with the given NameId.name.
The created master provider will copy this master together with all required style sheets to the target VsdxPackage.
Note that the VsdxObject.parent and NameId.id properties of Masters and StyleSheets of the stencil VsdxPackage will be modified to fit the target VsdxPackage.
Parameters
- styleType: ClassConstructor<IPortStyle>
- masterName: string
The name of the master that shall be returned by the created master provider.
Return Value
Creates a IMasterProvider that calls the given mapping function which shall return
master objects from the stencil file for IModelItems.
Creates a IMasterProvider that calls the given mapping function which shall return master objects from the stencil file for IModelItems.
The created master provider will copy this master together with all required style sheets to the target VsdxPackage.
Note that the VsdxObject.parent and NameId.id properties of Masters and StyleSheets of the stencil VsdxPackage will be modified to fit the target VsdxPackage.
Parameters
- mapper: any
Return Value
Static Methods
Creates and returns a VssxStencilProviderFactory from the given VSSX stencil file.
Creates and returns a VssxStencilProviderFactory from the given VSSX stencil file.