Skip to main content

@uniformdev/project-map

Digital Experience Composition (DXC) Catalyst Customers Only

This feature is currently only available through our Digital Experience Composition (DXC) Catalyst Customer Success program. If you're interested in joining this program, please reach out to your Uniform contact or email us at customer-success@uniform.dev.

Keep an eye on our social media and What's New page to be the first to know when this feature is generally available.

This package enables you to interact with the Project Map in Uniform Canvas.

Classes

ProjectMapClient

Represents the client that can be used to interact with Project Map.
- Constructor
ProjectMapClient(options)
Creates a new object using the specified options.
Parameters:
  • optionsClientOptions
    + show child attributes
- Members
getProjectMapDefinitions(projectId)
Gets all project map definitions.
Parameters:
  • projectIdstring- Project Map UUID
Returns: Promise<ProjectMapDefinition>
+ show child attributes
getProjectMapDefinition(options)
Gets array of one project map, specified by Project Map Id or default project map.
Parameters:
  • optionsobject
    + show child attributes
Returns: Promise<ProjectMapDefinition>
+ show child attributes
upsertProjectMap(body)
Update or create project map definition.
Parameters:
  • bodyobject
    + show child attributes
Returns: Promise<string>
deleteProjectMap(body)
Update or create project map definition.
Parameters:
  • bodyobject
    + show child attributes
Returns: Promise<void>
upsertProjectMapNodes(body)
Update or create project map definition.
Parameters:
  • bodyobject
    + show child attributes
Returns: Promise<void>
deleteProjectMapNode(options)
Called to delete a particular projectMap node by id or path
Parameters:
  • optionsobject
    + show child attributes
Returns: Promise<void>
getSubtree(options)
Called to get a list of nodes belonging to a specific path or Id
Parameters:
  • optionsobject
    + show child attributes
Returns: Promise<object>
+ show child attributes
getNodes(options)
Called to get a tree of nodes belonging to a specific path or Id
Parameters:
  • optionsobject
    + show child attributes
Returns: Promise<object>
+ show child attributes