@amcharts/amcharts5/.internal/charts/flow/Flow.d.ts

amCharts 5

import type { DataItem } from "../../core/render/Component";
import type { Color } from "../../core/util/Color";
import type { FlowLink } from "./FlowLink";
import type { FlowNodes, IFlowNodesDataItem } from "./FlowNodes";
import type { ListTemplate } from "../../core/util/List";
import type { Bullet } from "../../core/render/Bullet";
import type * as d3sankey from "d3-sankey";
import { Series, ISeriesSettings, ISeriesDataItem, ISeriesPrivate, ISeriesEvents } from "../../core/render/Series";
import { Container } from "../../core/render/Container";
export interface IFlowDataItem extends ISeriesDataItem {
    /**
     * Link value.
     */
    value: number;
    /**
     * @ignore
     */
    valueWorking: number;
    /**
     * Associated link element.
     */
    link: FlowLink;
    /**
     * Link's color.
     */
    fill: Color;
    /**
     * @ignore
     */
    d3SankeyLink: d3sankey.SankeyLink<d3sankey.SankeyExtraProperties, d3sankey.SankeyExtraProperties>;
    /**
     * An ID of the target node.
     */
    targetId: string;
    /**
     * An ID of the source node.
     */
    sourceId: string;
    /**
     * A data item of the source node.
     */
    source: DataItem<IFlowNodesDataItem>;
    /**
     * A data item of the target node.
     */
    target: DataItem<IFlowNodesDataItem>;
}
export interface IFlowSettings extends ISeriesSettings {
    /**
     * A field in data which holds source node ID.
     */
    sourceIdField?: string;
    /**
     * A field in data which holds target node ID.
     */
    targetIdField?: string;
    /**
     * The thickness of node strip in pixels.
     *
     * @default 10
     */
    nodeWidth?: number;
    /**
     * Minimum gap between adjacent nodes.
     *
     * @default 10
     */
    nodePadding?: number;
    /**
     * Minimum size of the link.
     *
     * It's a relative value to the sum of all values in the series. If set,
     * this relative value will be used for small value nodes when calculating
     * their size. For example, if it's set to `0.01`, small nodes will be
     * sized like their value is 1% of the total sum of all values in series.
     *
     * @default 0
     * @since 5.1.5
     */
    minSize?: number;
    /**
     * Relative size of hidden links.
     *
     * Links are hidden when user clicks on nodes (if `toggleKey` on nodes is set
     * to `"disabled"`).
     *
     * This allows hidden node to remain visible so that user could click on it
     * again to show it and its links.
     *
     * @default 0.05
     * @see {@link https://www.amcharts.com/docs/v5/charts/flow-charts/#Node_toggling} for more info
     * @since 5.4.1
     */
    hiddenSize?: number;
    /**
     * Minimum value of hidden links.
     *
     * Links are hidden when user clicks on nodes (if `toggleKey` on nodes is set
     * to `"disabled"`).
     *
     * @default 0
     * @see {@link https://www.amcharts.com/docs/v5/charts/flow-charts/#Node_toggling} for more info
     * @since 5.4.1
     */
    minHiddenValue?: number;
}
export interface IFlowPrivate extends ISeriesPrivate {
    valueSum?: number;
    valueLow?: number;
    valueHigh?: number;
}
export interface IFlowEvents extends ISeriesEvents {
}
/**
 * A base class for all flow type series: [[Sankey]] and [[Chord]].
 *
 * @see {@link https://www.amcharts.com/docs/v5/charts/flow-charts/} for more info
 */
export declare abstract class Flow extends Series {
    static className: string;
    static classNames: Array<string>;
    _settings: IFlowSettings;
    _privateSettings: IFlowPrivate;
    _dataItemSettings: IFlowDataItem;
    _events: IFlowEvents;
    /**
     * @ignore
     */
    readonly nodes: FlowNodes;
    /**
     * Container series will place their links in.
     *
     * @default Container.new()
     */
    readonly linksContainer: Container;
    /**
     * @ignore
     */
    abstract readonly links: ListTemplate<FlowLink>;
    protected _nodesData: d3sankey.SankeyNodeMinimal<{}, {}>[];
    protected _linksData: {
        source: d3sankey.SankeyNodeMinimal<{}, {}>;
        target: d3sankey.SankeyNodeMinimal<{}, {}>;
        value: number;
    }[];
    protected _index: number;
    protected _nodesDataSet: boolean;
    protected _linksByIndex: {
        [index: string]: any;
    };
    protected _afterNew(): void;
    /**
     * @ignore
     */
    abstract makeLink(dataItem: DataItem<this["_dataItemSettings"]>): FlowLink;
    protected processDataItem(dataItem: DataItem<this["_dataItemSettings"]>): void;
    protected _onDataClear(): void;
    _prepareChildren(): void;
    _updateLinkColor(dataItem: DataItem<this["_dataItemSettings"]>): void;
    /**
     * @ignore
     */
    disposeDataItem(dataItem: DataItem<this["_dataItemSettings"]>): void;
    /**
     * Shows diagram's data item.
     *
     * @param   dataItem  Data item
     * @param   duration  Animation duration in milliseconds
     * @return            Promise
     */
    hideDataItem(dataItem: DataItem<this["_dataItemSettings"]>, duration?: number): Promise<void>;
    /**
     * Shows diagram's data item.
     *
     * @param   dataItem  Data item
     * @param   duration  Animation duration in milliseconds
     * @return            Promise
     */
    showDataItem(dataItem: DataItem<this["_dataItemSettings"]>, duration?: number): Promise<void>;
    _positionBullet(bullet: Bullet): void;
    protected _getBulletLocation(bullet: Bullet): number;
}
//# sourceMappingURL=Flow.d.ts.map