Back to Devexpress

DxSankeyLabelSettings.Overlap Property

blazor-devexpress-dot-blazor-dot-dxsankeylabelsettings-a0e62066.md

latest3.1 KB
Original Source

DxSankeyLabelSettings.Overlap Property

Specifies how the component displays overlapped labels.

Namespace : DevExpress.Blazor

Assembly : DevExpress.Blazor.v25.2.dll

NuGet Package : DevExpress.Blazor

Declaration

csharp
[DefaultValue(SankeyLabelOverlap.Ellipsis)]
[Parameter]
public SankeyLabelOverlap Overlap { get; set; }

Property Value

TypeDefaultDescription
SankeyLabelOverlapEllipsis

An enumeration value.

|

Available values:

NameDescription
Ellipsis

Truncates overlapped labels with ellipsis.

| | Hide |

Hides overlapped labels.

| | None |

Leaves labels overlapped.

|

Remarks

Use the Overlap property to specify how the <DxSankey> component resolves label overlapping.

Example

The following example hides overlapped labels:

razor
<DxSankey Data="@Data"
          Width="100%"
          Height="440px"
          SourceFieldName="Source"
          TargetFieldName="Target"
          WeightFieldName="Weight">
    <DxSankeyNodeSettings Width="8" Spacing="30" />
    <DxSankeyLabelSettings Overlap="SankeyLabelOverlap.Hide">
        <DxFontSettings Size="28" Opacity="0.6"/>
    </DxSankeyLabelSettings>
    <DxSankeyLinkSettings ColorMode="SankeyLinkColorMode.Gradient" />
    <DxTitleSettings Text="Commodity Turnover" />
</DxSankey>

@code {
    IEnumerable<SankeyDataPoint> Data = Enumerable.Empty<SankeyDataPoint>();
    protected override void OnInitialized() {
        Data = GenerateData();
    }
}
csharp
public List<SankeyDataPoint> GenerateData() {
    return new List<SankeyDataPoint>() {
        new SankeyDataPoint("Spain", "United States of America", 2),
        new SankeyDataPoint("Germany", "United States of America", 8),
        new SankeyDataPoint("France", "United States of America", 4),
        new SankeyDataPoint("Germany", "Great Britain", 2),
        new SankeyDataPoint("France", "Great Britain", 4),
        new SankeyDataPoint("United States of America", "Australia", 6),
        new SankeyDataPoint("United States of America", "New Zealand", 5),
        new SankeyDataPoint("United States of America", "Japan", 3),
        new SankeyDataPoint("Great Britain", "New Zealand", 4),
        new SankeyDataPoint("Great Britain", "Japan", 1),
    };
}
public class SankeyDataPoint {
    public string Source { get; set; }
    public string Target { get; set; }
    public int Weight { get; set; }
    public SankeyDataPoint(string source, string target, int weight) {
        Source = source;
        Target = target;
        Weight = weight;
    }
}

See Also

DxSankeyLabelSettings Class

DxSankeyLabelSettings Members

DevExpress.Blazor Namespace