Skip to content
ChartForgeX

API Reference

Class

FlowArtifactStep

Edit on GitHub
Namespace ChartForgeX.VisualArtifacts
Assembly ChartForgeX
Source FlowArtifactModels.cs:318
Modifiers sealed

Describes one step in a flow artifact.

Inheritance

  • Object
  • FlowArtifactStep

Usage

Explore 2 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 1

Accepted by parameters 1

Constructors

public FlowArtifactStep(String id, String label, FlowArtifactStepKind kind = Step) #
FlowArtifactModels.cs:318

Initializes a flow step.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
kind ChartForgeX.VisualArtifacts.FlowArtifactStepKind = Step optionalposition: 2

Properties

public String Id { get; set; } #
FlowArtifactModels.cs:288

Gets or sets the step id.

public String Label { get; set; } #
FlowArtifactModels.cs:291

Gets or sets the display label.

public FlowArtifactStepKind Kind { get; set; } #
FlowArtifactModels.cs:294

Gets or sets the semantic step kind.

public String? LaneId { get; set; } #
FlowArtifactModels.cs:297

Gets or sets the optional lane id.

public VisualStatus Status { get; set; } #
FlowArtifactModels.cs:300

Gets or sets the step status.

public String? Subtitle { get; set; } #
FlowArtifactModels.cs:303

Gets or sets an optional subtitle.

public String? Icon { get; set; } #
FlowArtifactModels.cs:306

Gets or sets an optional icon id.

public String? Symbol { get; set; } #
FlowArtifactModels.cs:309

Gets or sets an optional symbol.

public String? Color { get; set; } #
FlowArtifactModels.cs:312

Gets or sets an optional accent color.

public String? Badge { get; set; } #
FlowArtifactModels.cs:315

Gets or sets an optional badge.

public Double Width { get; set; } #
FlowArtifactModels.cs:318

Gets or sets the static preview width.

public Double Height { get; set; } #
FlowArtifactModels.cs:321

Gets or sets the static preview height.

public Dictionary<String, String> Metadata { get; } #
FlowArtifactModels.cs:333

Gets step metadata for host adapters and exporters.