bpmn-visualization API Documentation
    Preparing search index...

    Type Alias RendererOptions

    Global configuration for the rendering of the BPMN elements.

    0.35.0

    type RendererOptions = {
        ignoreBpmnActivityLabelBounds?: boolean;
        ignoreBpmnColors?: boolean;
        ignoreBpmnLabelStyles?: boolean;
        ignoreBpmnTaskLabelBounds?: boolean;
    }
    Index

    Properties

    ignoreBpmnActivityLabelBounds? ignoreBpmnColors? ignoreBpmnLabelStyles? ignoreBpmnTaskLabelBounds?

    Properties

    ignoreBpmnActivityLabelBounds?: boolean

    If set to true, ignore the label bounds configuration defined in the BPMN diagram for all activities. This forces the use of default label positioning instead of the bounds specified in the BPMN source. Activities include tasks, sub-processes, and call activities.

    false

    0.48.0

    ignoreBpmnColors?: boolean

    If set to false, support the "BPMN in Color" specification with a fallback with bpmn.io colors. For more details about the support, see https://github.com/process-analytics/bpmn-visualization-js/pull/2614.

    Otherwise, disable the support.

    true
    ignoreBpmnLabelStyles?: boolean

    If set to true, ignore the font configurations defined in the BPMN LabelStyles. This ensures font consistency in the rendered diagram.

    false

    0.48.0

    ignoreBpmnTaskLabelBounds?: boolean

    If set to true, ignore the label bounds configuration defined in the BPMN diagram for tasks only. This forces the use of default label positioning for tasks instead of the bounds specified in the BPMN source. This option is more restrictive than ignoreBpmnActivityLabelBounds as it only affects tasks, not sub-processes or call activities.

    Note: When ignoreBpmnActivityLabelBounds is true, this option is ignored as the more general activity option takes precedence.

    false

    0.48.0

    Settings

    Member Visibility

    On This Page

    Properties