Class: ShapeStepHandle
A StepHandle allows for managing the state of a specific step in a workflow. This class abstracts away the complexities of dealing with a step directly and allows for using high level concepts instead of dealing with the underlying data structures.
Extends
Implements
CustomColorSupport
Constructors
Constructor
new ShapeStepHandle(
manager,step,tags):ShapeStepHandle
Parameters
manager
step
tags
string[]
Returns
ShapeStepHandle
Overrides
Methods
executeAnimations()
executeAnimations(
immediate?):void
Fires any configured animations on the 3D preview for this step. This includes camera & model animations. If the preview is unavailable this function will do nothing.
Parameters
immediate?
boolean
Returns
void
Inherited from
getAllVariants()
getAllVariants():
Promise<Variant[]>
Returns
Promise<Variant[]>
A list of all variants for this step, including disabled ones.
Inherited from
getAvailableVariants()
getAvailableVariants():
Promise<Variant[]>
Returns
Promise<Variant[]>
A list of valid variants for this step. Does not include disabled variants.
Inherited from
StepHandle.getAvailableVariants
getColors()
getColors():
Promise<object[]>
Get available colors for the shape.
Returns
Promise<object[]>
A list of color definitions that are currently applied to the illustration.
getCurrentVariant()
getCurrentVariant():
Variant|undefined
Gets the currently selected variant, or undefined if no variant is selected.
Returns
Variant | undefined
Inherited from
getCustomColor()
getCustomColor():
string
Get the custom color that is currently set on the step.
Returns
string
Implementation of
CustomColorSupport.getCustomColor
getGlobalPropertyAspects()
getGlobalPropertyAspects(
configurationId):string[]
Retrieves the identifiers of all of the configured aspects for the specified Global Property Configuration.
Parameters
configurationId
string
The ID of the Global Property Configuration. You can usually find this with bundle.getGlobalPropertyConfiguration()?.id
Returns
string[]
An array of strings matching the keys of all the Global Property Aspects in the Configuration that this step is configured to use.
Inherited from
StepHandle.getGlobalPropertyAspects
getHelpText()
getHelpText():
string|undefined
Returns
string | undefined
A message that can accompany the step name in UI components. Used to describe the purpose of the step in more detail.
Inherited from
getId()
getId():
string
Returns
string
A unique identifier for this step within the workflow.
Inherited from
getMandatory()
getMandatory():
boolean
Returns
boolean
True if the step is required to be filled by the customer. False otherwise.
Inherited from
getName()
getName():
string
Returns
string
The name of the step
Inherited from
getOverrideGlobalPropertyConfiguration()
getOverrideGlobalPropertyConfiguration(
type):boolean
Parameters
type
The AspectType to fetch the value for.
Returns
boolean
A boolean indicating whether this step should override Global Properties. Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties, and when this step is associated with one or more Global Property Aspects.
Inherited from
StepHandle.getOverrideGlobalPropertyConfiguration
getRaw()
getRaw():
Step<ShapeStepData>
Returns
The underlying data for this step. Favor using the step handle methods instead of this.
Inherited from
getTags()
getTags():
string[]
Returns
string[]
Returns all of the tags that are present on this step.
Inherited from
getType()
getType():
StepType
Returns
The type of the step handle.
Inherited from
hasTag()
hasTag(
tag):boolean
Parameters
tag
string
The tag to check for.
Returns
boolean
True if the step has the specified tag, false otherwise.
Inherited from
isVariantCategoriesEnabled()
isVariantCategoriesEnabled():
boolean
Returns
boolean
selectVariant()
selectVariant(
variant):Promise<void>
Most step types have a base option type that variants can be selected for. Selects a specific variant for this step. This will execute all required changes to the design and update the metadata to include the new selection. Any conditions that would be triggered will also be executed.
Parameters
variant
Returns
Promise<void>
Overrides
setColor()
setColor(
color):Promise<void>
Sets the color of the shape.
Parameters
color
The color option to use.
Returns
Promise<void>
A promise resolving when the color has changed in the design.
Deprecated
The shape step can now pass through colors returned by getColors via selectVariant. Please swap setColor for selectVariant.
setCustomColor()
setCustomColor(
color):void
Allows for setting a custom color when the custom variant is selected. Will throw when a non-custom variant is selected.
Parameters
color
string
Returns
void
Implementation of
CustomColorSupport.setCustomColor
setOverrideGlobalPropertyConfiguration()
setOverrideGlobalPropertyConfiguration(
type,value):void
Sets whether or not this step should override Global Properties. Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties, and when this step is associated with one or more Global Property Aspects.
Parameters
type
The AspectType to override.
value
boolean
Returns
void