用于自定义图例的 Angular ngx-charts 选项？

Posted 2023-02-16

【中文标题】用于自定义图例的 Angular ngx-charts 选项？

【英文标题】：Angular ngx-charts options for customizing the Legend?

【发布时间】：2019-01-27 12:44:58

【问题描述】：

我目前正在为 Angular2 使用 ngx-charts，我想自定义一些图例，例如将图例放在图表下方，或重命名图例字段，或使图例更宽（部分文本被截断..）等。

自定义图例有什么好的选择吗？还是通常不可能，或者最好的方法是什么？ 目前，我的图表图例如下所示：

有些图例太宽，有些被截断，我想将图例放置在图表下方...

【问题讨论】：

您是否设法自定义了图例？我也在为此苦苦挣扎。

不，没有机会...

【参考方案1】：

图例位置

要将图例定位在图表下方，您可以使用legendPosition 输入：

<ngx-charts-chart [legendPosition]="'below'" [results]="chartData" [legend]="true"></ngx-charts-chart>

legendPosition 的唯一选项是“右”（默认）和“下方”。

重命名图例字段

似乎没有自定义图例字段的选项（高级饼图中有一个更可自定义的图例，但您的示例是其他类型的图表。）我认为最好的解决方法是传递字段标题完全按照您希望它们出现在图例中的方式输入您的 chartData 的 chartData[i].name 值，然后自定义您的工具提示以在此处显示不同的字段名称。

This answer gives an overview of how to customize tooltips. 从那里，我整理了一个带有折线图的示例，该示例看起来像默认工具提示，但字段名称不同：

<ngx-charts-line-chart [legendPosition]="'right'" [results]="chartData" [legend]="true">
    <ng-template #tooltipTemplate let-model="model">
        <xhtml:div class="area-tooltip-container">
            <span class="tooltip-label"> formatFieldName(model.series)  •  formatXvalue(model.name) </span>
            <span class="tooltip-val"> formatYvalue(model.value) </span>
        </xhtml:div>
    </ng-template>
    <ng-template #seriesTooltipTemplate let-model="model">
        <xhtml:div class="area-tooltip-container">
            <xhtml:div *ngFor="let tooltipItem of model" class="tooltip-item">
                <span class="tooltip-item-color" [style.background-color]="tooltipItem.color">
                </span>
                 formatFieldName(tooltipItem.series) :  formatYvalue(tooltipItem.value) 
            </xhtml:div>
        </xhtml:div>
    </ng-template>
</ngx-charts-line-chart>

更改图例宽度

图例宽度在其他图表扩展的ngx-charts-chart 组件中计算。它会将宽度设置为图表容器的大约 1/6 或 1/12，具体取决于您的数据类型。无法为此图例输入不同的宽度，因此您最简单的解决方案是在自动宽度不适合您时将legendPosition 设置为“低于”。

但是，您不需要使用图表中内置的图例！这是一个更复杂（但更精细）的替代方案：在图表中设置[legend]="false"，然后在图表外添加一个新的ngx-charts-legend 组件。

您可以为此外部图例输入宽度和高度，也可以将其包装在一个 div 中，以便更快地处理大小调整。使用后一种方法时，我必须将图例的宽度设置为其容器的 100%。

要使此解决方案正常工作，您必须将外部图例激活事件绑定到图表，并设置一些图例输入属性 onInit。在包含图表的组件中，您需要这样的东西：

import  ColorHelper  from '@swimlane/ngx-charts';
...
export class ChartContainerComponent implements OnInit 
    public activeEntries: any[];
    public chartData:  name: string, series:  name: string, value?: string | number [] [];
    public chartNames: string[];
    public colors: ColorHelper;
    public colorScheme =  domain: ['#0000FF', '#008000'] ; // Custom color scheme in hex

    public legendLabelActivate(item: any): void 
        this.activeEntries = [item];
    

    public legendLabelDeactivate(item: any): void 
        this.activeEntries = [];
    

    public ngOnInit(): void 
        // Get chartNames
        this.chartNames = this.chartData.map((d: any) => d.name);
        // Convert hex colors to ColorHelper for consumption by legend
        this.colors = new ColorHelper(this.colorScheme, 'ordinal', this.chartNames, this.colorScheme);
    

然后我的模板（图表和图例各占一半宽度）看起来像：

<div fxLayout="row">
    <div fxFlex="50%">
        <ngx-charts-line-chart [legend]="false" [activeEntries]="activeEntries" [results]="chartData" [scheme]="colorScheme"></ngx-charts-line-chart>
    </div>
    <div fxFlex="50%">
        <ngx-charts-legend fxFlex="100%" class="chart-legend" [data]="chartNames" [title]="'Legend Title'" [colors]="colors" (labelActivate)="legendLabelActivate($event)" (labelDeactivate)="legendLabelDeactivate($event)"></ngx-charts-legend>
    </div>
</div>

【讨论】：

您的建议几乎可行，需要改进：public colorScheme = ['#0000FF', '#008000']; 需要：public colorScheme = domain: ['#0000FF', '#008000'];

当该系列中的某个点悬停在图例上时，有没有办法突出显示图例中的相关项目（与legendLabelActivate 正在做的事情相反）？

如果你有控制台错误，可能你忘了初始化一些东西。例如public activeEntries: any[] = [];

查看此处的 cmets，了解使用不同类型图表所需的特定格式 - github.com/swimlane/ngx-charts/issues/951

【参考方案2】：

如果您正在寻找纯 CSS 解决方案，这应该是一个很好的起点。在我的应用程序中，我们有一个半屏大小的图表，其中的图例截断了较长的标签。

使用版本 12.0.1。这在很大程度上取决于 DOM 结构，因此如果在未来的版本中发生更改，这可能无法正常工作。

图表的父容器中必须有额外的空间，否则图例将包裹在图表下方。在此示例中，假设父容器宽度 > 800px，并且图表使用宽度为 620px 的固定视图。您还必须关闭组件的视图封装。

在组件文件中：

@Component(
   ...
   encapsulation: ViewEncapsulation.None
)

在 CSS 文件中：

/* Makes the chart container expand to the full width of the parent container*/
.ngx-charts-outer 
    width: 100% !important;


/* Sets the legend width to auto expand to fit labels, but caps at 200px */
.chart-legend > div 
    width: auto !important;
    max-width: 200px;


/* Some extra space is needed to offset the way the labels display */
.legend-labels 
    width: calc(100% + 10px) !important;


/* Wrap the label text if it ends up being longer than the max width */
.legend-label-text 
    white-space: normal !important;
    width: 100% !important;

【参考方案3】：

如果有人得到了@Maya Sol 的帮助，但想知道与@Ollie 相同的事情，那么您可以这样做。我正在添加答案，因为我没有足够的声誉来添加 cmets。

修改 legendLabelActivate 函数以执行以下操作：

public legendLabelActivate(item: any): void 
    // The if statement is here so both legend  
    // and chart element mouse over events will work.
    if (item.value === undefined) 
        this.activeEntries = [item];
     else 
        this.activeEntries = [ name: item.value.name ];
    

然后，使用来自@Maya Sol ... 在 ngx-charts-line-chart 和 ngx-charts-legend 中的示例 html 执行以下操作：

<div fxLayout="row">
    <div fxFlex="50%">
        <ngx-charts-line-chart [legend]="false"
                               [activeEntries]="activeEntries" 
                               (activate)="legendLabelActivate($event)" 
                               (deactivate)="legendLabelDeactivate($event)"
                               [results]="chartData"
                               [scheme]="colorScheme">
        </ngx-charts-line-chart>
    </div>
    <div fxFlex="50%">
        <ngx-charts-legend fxFlex="100%" 
                           class="chart-legend" 
                           [data]="chartNames" 
                           [title]="'Legend Title'" 
                           [colors]="colors"
                           [activeEntries]="activeEntries" 
                           (labelActivate)="legendLabelActivate($event)" 
                           (labelDeactivate)="legendLabelDeactivate($event)">
        </ngx-charts-legend>
    </div>
</div>

【讨论】：

谢谢你我使用并欣赏你的例子。它奏效了。

【参考方案4】：

这是为图例添加更好定位的好方法。

请务必在开始时将您的 activeEntries 变量设置为空数组以避免错误。

 public activeEntries = [];

【参考方案5】：

我设法通过在组件的 CSS 文件中手动覆盖其 CSS 类来自定义图例。

我设法通过添加如下所示的 CSS 语法删除了添加到图例中的 alpha 值。

图例的格式基于一个名为 legend-labels 的类，为了修改这一点，我将这个类包装在一个 ng-deep 中。

::ng-deep
  .legend-labels
    background: none !important;