Back to Fluentui

Chart Web Components.Api

packages/charts/chart-web-components/docs/chart-web-components.api.md

4.40.2-hotfix24.7 KB
Original Source

API Report File for "@fluentui/chart-web-components"

Do not edit this file. It is a report generated by API Extractor.

ts

import { ElementStyles } from '@microsoft/fast-element';
import { ElementViewTemplate } from '@microsoft/fast-element';
import { FASTElement } from '@microsoft/fast-element';
import { FASTElementDefinition } from '@microsoft/fast-element';

// Warning: (ae-missing-release-tag) "DonutChart" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class DonutChart extends FASTElement {
    constructor();
    // (undocumented)
    activeLegend: string;
    // (undocumented)
    protected activeLegendChanged(oldValue: string, newValue: string): void;
    // (undocumented)
    chartWrapper: HTMLDivElement;
    // (undocumented)
    connectedCallback(): void;
    // Warning: (ae-forgotten-export) The symbol "ChartProps_2" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    data: ChartProps_2;
    // (undocumented)
    elementInternals: ElementInternals;
    // (undocumented)
    group: SVGGElement;
    // (undocumented)
    handleLegendClick(legendTitle: string): void;
    // (undocumented)
    handleLegendMouseoutAndBlur(): void;
    // (undocumented)
    handleLegendMouseoverAndFocus(legendTitle: string): void;
    // (undocumented)
    height: number;
    // (undocumented)
    hideLegends: boolean;
    // (undocumented)
    hideTooltip: boolean;
    // (undocumented)
    innerRadius: number;
    // (undocumented)
    isLegendSelected: boolean;
    // (undocumented)
    legendListLabel?: string;
    // Warning: (ae-forgotten-export) The symbol "Legend" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    legends: Legend[];
    // (undocumented)
    tooltipProps: {
        isVisible: boolean;
        legend: string;
        yValue: string;
        color: string;
        xPos: number;
        yPos: number;
    };
    // (undocumented)
    protected tooltipPropsChanged(oldValue: any, newValue: any): void;
    // (undocumented)
    valueInsideDonut?: string;
    // (undocumented)
    width: number;
}

// @public (undocumented)
export const DonutChartDefinition: FASTElementDefinition<typeof DonutChart>;

// @public
export const DonutChartStyles: ElementStyles;

// Warning: (ae-internal-missing-underscore) The name "DonutChartTemplate" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const DonutChartTemplate: ElementViewTemplate<DonutChart>;

// @public
export class HorizontalBarChart extends FASTElement {
    constructor();
    // (undocumented)
    activeLegend: string;
    // (undocumented)
    protected activeLegendChanged: (oldValue: string, newValue: string) => void;
    // (undocumented)
    chartContainer: HTMLDivElement;
    // (undocumented)
    chartTitle?: string;
    // (undocumented)
    connectedCallback(): void;
    // Warning: (ae-forgotten-export) The symbol "ChartProps" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    data: ChartProps[];
    // (undocumented)
    elementInternals: ElementInternals;
    // (undocumented)
    handleLegendClick: (legendTitle: string) => void;
    // (undocumented)
    handleLegendMouseoutAndBlur: () => void;
    // (undocumented)
    handleLegendMouseoverAndFocus: (legendTitle: string) => void;
    // (undocumented)
    hideLegends: boolean;
    // (undocumented)
    hideRatio: boolean;
    // (undocumented)
    hideTooltip: boolean;
    // (undocumented)
    isLegendSelected: boolean;
    // (undocumented)
    legendListLabel?: string;
    // (undocumented)
    tooltipProps: {
        isVisible: boolean;
        legend: string;
        yValue: string;
        color: string;
        xPos: number;
        yPos: number;
    };
    // Warning: (ae-forgotten-export) The symbol "ChartDataPoint" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    uniqueLegends: ChartDataPoint[];
    // Warning: (ae-forgotten-export) The symbol "Variant" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    variant?: Variant;
}

// @public
export const HorizontalBarChartDefinition: FASTElementDefinition<typeof HorizontalBarChart>;

// @public
export const HorizontalBarChartStyles: ElementStyles;

// Warning: (ae-internal-missing-underscore) The name "HorizontalBarChartTemplate" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const HorizontalBarChartTemplate: ElementViewTemplate<HorizontalBarChart>;

// (No @packageDocumentation comment for this package)