@microsoft/windows-admin-center-sdk/angular/src/controls/horizontal-bar-chart/stacked-horizontal-bar-chart.component.d.ts

Microsoft - Windows Admin Center Shell

import { Injector, OnChanges, OnInit, SimpleChanges } from '@angular/core';
import { Strings } from '../../generated/Strings';
import { CapacityBase } from '../common/capacity-base.component';
import { LegendEntryData } from '../legend/legend-entry/legend-entry.component';
import { HorizontalBar } from './custom-horizontal-bar-chart-data.interface';
import * as i0 from "@angular/core";
/**
 *
 * @smeDoc {@label Stacked Horizontal Bar Chart @id sme-stacked-horizontal-bar-chart-dev-guide}
 *
 * @overview
 * @file {@filepath ./examples/overview.md}
 *
 * @example {@label Stacked horizontal bar chart @id horizontal-bar-chart}
 * @file {@filename component.html @filepath ./examples/horizontal-bar-chart.component.html}
 * @file {@filename component.ts @filepath ./examples/horizontal-bar-chart.component.ts}
 *
 * @example {@label Stacked horizontal bar chart with custom color @id horizontal-bar-chart-custom-color}
 * @file {@filename component.html @filepath ./examples/horizontal-bar-chart-custom-color.component.html}
 * @file {@filename component.ts @filepath ./examples/horizontal-bar-chart-custom-color.component.ts}
 *
 */
export declare class StackedHorizontalBarChartComponent extends CapacityBase implements OnInit, OnChanges {
    /**
     * The source name to use for logging
     */
    protected get logSourceName(): string;
    /**
     *  Input binding for height of bar chart in pixels
     */
    height?: number;
    /**
     *  Input binding for capacity bars data
     */
    bars: HorizontalBar[];
    /**
     * Whether or not to use a generated legend
     * If legendData is specified a legend will be shown regardless of showLegend value
     */
    showLegend?: boolean;
    /**
     * the legend data to put into the legend
     */
    legendData?: LegendEntryData[];
    /**
     * the total legend value
     * The color and right alignment are handled in the bar chart itself.
     */
    legendTotalValue?: any;
    /**
     * the total legend label
     */
    legendTotalLabel?: string;
    /**
     * Title shown for the chart
     */
    chartTitle?: string;
    /**
     * True to display the chart title
     */
    showTitle?: boolean;
    /**
     * Legend data for the total of the chart.
     * This data will take priority over legendTotalValue & legendTotalLabel.
     */
    legendTotalData?: LegendEntryData[];
    /**
     * Aria description for the bar chart
     */
    description?: string;
    heightStyle: string;
    strings: Strings;
    constructor(injector: Injector);
    /**
     * Angular lifecycle hook, called after the component is initialized
     */
    ngOnInit(): void;
    /**
     * Implementation of angular OnChanges interface
     * @param changes - the changes that occurred
     */
    ngOnChanges(changes: SimpleChanges): void;
    /**
     * Update the total legend entry
     */
    updateLegendTotal(): void;
    private setAriaLabel;
    static ɵfac: i0.ɵɵFactoryDeclaration<StackedHorizontalBarChartComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<StackedHorizontalBarChartComponent, "sme-stacked-horizontal-bar-chart", never, { "height": "height"; "bars": "bars"; "showLegend": "showLegend"; "legendData": "legendData"; "legendTotalValue": "legendTotalValue"; "legendTotalLabel": "legendTotalLabel"; "chartTitle": "chartTitle"; "showTitle": "showTitle"; "legendTotalData": "legendTotalData"; "description": "description"; }, {}, never, never, false, never>;
}