API Reference

Class

SequenceArtifact

Namespace ChartForgeX.VisualArtifacts

Assembly ChartForgeX

Implements

IVisualRenderable

Modifiers sealed

Describes a reusable product-neutral sequence or interaction diagram artifact.

Inheritance

Object
SequenceArtifact

Usage

Explore 20 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 14

Method MarkupSequenceParser.Parse
Method MarkupSequenceParser.ParseBlock
Extension method MermaidSequenceDocument.ToSequenceArtifact
Method MermaidSequenceRendering.ToSequenceArtifact
Method SequenceArtifact.AddActivation
Method SequenceArtifact.AddBlock
Method SequenceArtifact.AddBranch
Method SequenceArtifact.AddMessage
Method SequenceArtifact.AddNote
Method SequenceArtifact.AddParticipant
Method SequenceArtifact.Create
Method SequenceArtifact.WithSize
Method SequenceArtifact.WithSubtitle
Method SequenceArtifact.WithTitle

Accepted by parameters 6

Extension method SequenceArtifact.ToPng parameter sequence
Extension method SequenceArtifact.ToSvg parameter sequence
Extension method SequenceArtifact.ToVisualArtifact parameter sequence
Method SequenceArtifactRendering.ToPng parameter sequence
Method SequenceArtifactRendering.ToSvg parameter sequence
Method SequenceArtifactRendering.ToVisualArtifact parameter sequence

Constructors

public SequenceArtifact() #

Methods

public SequenceArtifact AddActivation(String participantId, Boolean active, Int32 stepIndex) #

Returns: SequenceArtifact

Adds a standalone participant activation or deactivation.

Parameters

participantId System.String requiredposition: 0
active System.Boolean requiredposition: 1
stepIndex System.Int32 requiredposition: 2

public SequenceArtifact AddBlock(SequenceArtifactBlockKind kind, String text, Int32 startStepIndex, Int32 endStepIndex, Boolean isEmpty = false, Int32 depth = 0)

Returns: SequenceArtifact

Adds a block span.

Parameters

kind ChartForgeX.VisualArtifacts.SequenceArtifactBlockKind requiredposition: 0
text System.String requiredposition: 1
startStepIndex System.Int32 requiredposition: 2
endStepIndex System.Int32 requiredposition: 3
isEmpty System.Boolean = false optionalposition: 4
depth System.Int32 = 0 optionalposition: 5

public SequenceArtifact AddBranch(SequenceArtifactBlockKind parentKind, String kind, String text, Int32 startStepIndex, Int32 endStepIndex, Int32 depth = 0, Boolean isEmpty = false)

Returns: SequenceArtifact

Adds a branch span within a sequence block.

Parameters

parentKind ChartForgeX.VisualArtifacts.SequenceArtifactBlockKind requiredposition: 0
kind System.String requiredposition: 1
text System.String requiredposition: 2
startStepIndex System.Int32 requiredposition: 3
endStepIndex System.Int32 requiredposition: 4
depth System.Int32 = 0 optionalposition: 5
isEmpty System.Boolean = false optionalposition: 6

public SequenceArtifact AddMessage(String sourceId, String targetId, String? text = null, SequenceArtifactMessageLineStyle lineStyle = Solid, SequenceArtifactMessageKind kind = Call)

Returns: SequenceArtifact

Adds a message.

Parameters

sourceId System.String requiredposition: 0
targetId System.String requiredposition: 1
text System.String? = null optionalposition: 2
lineStyle ChartForgeX.VisualArtifacts.SequenceArtifactMessageLineStyle = Solid optionalposition: 3
kind ChartForgeX.VisualArtifacts.SequenceArtifactMessageKind = Call optionalposition: 4

public SequenceArtifact AddNote(SequenceArtifactNotePlacement placement, IEnumerable<String> participantIds, String text)

Returns: SequenceArtifact

Adds a note.

Parameters

placement ChartForgeX.VisualArtifacts.SequenceArtifactNotePlacement requiredposition: 0
participantIds System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
text System.String requiredposition: 2

public SequenceArtifact AddParticipant(String id, String? label = null, SequenceArtifactParticipantKind kind = Participant)

Returns: SequenceArtifact

Adds or updates a participant.

Parameters

id System.String requiredposition: 0
label System.String? = null optionalposition: 1
kind ChartForgeX.VisualArtifacts.SequenceArtifactParticipantKind = Participant optionalposition: 2

public static SequenceArtifact Create(String id) #

Returns: SequenceArtifact

Creates a sequence artifact.

Parameters

id System.String requiredposition: 0

public PreparedVisual Prepare(VisualRenderContext context) #

Returns: PreparedVisual

Prepares measured participants, messages, activations, notes and interaction fragments into a detached native scene.

Parameters

context ChartForgeX.Rendering.VisualRenderContext requiredposition: 0

public SequenceArtifact WithSize(Double width, Double height) #

Returns: SequenceArtifact

Sets the natural preview size.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1

public SequenceArtifact WithSubtitle(String subtitle) #

Returns: SequenceArtifact

Sets the subtitle.

Parameters

subtitle System.String requiredposition: 0

public SequenceArtifact WithTitle(String title) #

Returns: SequenceArtifact

Sets the title.

Parameters

title System.String requiredposition: 0

Inherited Methods

Properties

public VisualAccessibility Accessibility { get; } #

Gets accessible naming for static sequence previews.

public String Id { get; set; } #

Gets or sets a stable sequence artifact id.

public String Title { get; set; } #

Gets or sets the sequence title.

public String Subtitle { get; set; } #

Gets or sets the sequence subtitle.

public Double Width { get; set; } #

Gets or sets the natural preview width.

public Double Height { get; set; } #

Gets or sets the natural preview height.

public Double Padding { get; set; } #

Gets or sets the preview padding.

public VisualArtifactExportFormat ExportFormats { get; set; } #

Gets or sets supported static export formats.

public IReadOnlyList<SequenceArtifactParticipant> Participants { get; } #

Gets participants in display order.

public IReadOnlyList<SequenceArtifactMessage> Messages { get; } #

Gets messages in chronological order.

public IReadOnlyList<SequenceArtifactActivation> Activations { get; } #

Gets standalone activation changes in source order.

public IReadOnlyList<SequenceArtifactNote> Notes { get; } #

Gets notes in chronological order.

public IReadOnlyList<SequenceArtifactBlock> Blocks { get; } #

Gets block spans.

public IReadOnlyList<SequenceArtifactBranch> Branches { get; } #

Gets branch spans within alternative, parallel, and critical blocks.

public Dictionary<String, String> Metadata { get; } #

Gets artifact metadata for host adapters.

Extension Methods

public static Byte[] ToPng(SequenceArtifact sequence) #

Returns: Byte[]

Renders the same native measured sequence scene directly to PNG.

Parameters

sequence ChartForgeX.VisualArtifacts.SequenceArtifact requiredposition: 0: The source model; its width, height and padding supply the default request.

Returns

PNG bytes using the shared raster defaults.

public static String ToSvg(SequenceArtifact sequence) #

Returns: String

Renders a sequence to shared SVG with measured content expansion beyond its authored minimum size.

Parameters

sequence ChartForgeX.VisualArtifacts.SequenceArtifact requiredposition: 0: The source model; its width, height and padding supply the default request.

Returns

Script-free SVG from a native prepared scene.

public static VisualArtifact ToVisualArtifact(SequenceArtifact sequence, VisualArtifactSourceLanguage sourceLanguage = Native)

Returns: VisualArtifact

Wraps authored sequence semantics without preparing a preview or changing the source model.

Parameters

sequence ChartForgeX.VisualArtifacts.SequenceArtifact requiredposition: 0: The sequence source model.
sourceLanguage ChartForgeX.VisualArtifacts.VisualArtifactSourceLanguage = Native optionalposition: 1: The source language that produced the model.

Returns

A lazy source envelope; prepare explicitly before ToArtifact when a detached display snapshot is required.