Type Alias Stroke

Type declaration

• Optionalcolor?:
      | "default"
      | "inherit"
      | "none"
      | "swimlane"
      | string

  Possible values are all HTML color names or HEX codes, as well as special keywords such as:

  • default to use the color defined in the BPMN element default style.
  • inherit to apply the stroke color of the direct parent element.
  • none for no color.
  • swimlane to apply the stroke color of the nearest parent element with the type ShapeBpmnElementKind.LANE or ShapeBpmnElementKind.POOL.

  Notes about the default special keyword:

  • It can be used when the style is first updated and then needs to be reset to its initial value.
  • It doesn't use the color set in the BPMN source when the "BPMN in Color" support is enabled. It uses the color defined in the BPMN element default style.

• Optionalwidth?: "default" | number

  Defines the stroke width in pixels.

  The value must be between 1 and 50.

  If the set value is less than 1, the used value is 1. If the set value is greater than 50, the used value is 50.

  To hide the stroke, set the color property to none.

  The default value resets the width to the value defined in the default style of the BPMN element. It can be used when the style is first updated and then needs to be reset to its initial value.

  WARNING: Changing the stroke width of Activities may be misleading as the default stroke widths have a meaning according to the BPMN Specification. For example, updating the stroke width of a task using the same value as the default stroke width of a Call Activity can be confusing. In this case, you should also change another property such as the stroke color to allow the user to differentiate between them.