/* *
 *
 *  Organization chart module
 *
 *  (c) 2018-2026 Highsoft AS
 *  Author: Torstein Hønsi
 *
 *  Integration of this software requires a license.
 *  - For commercial use, see www.highcharts.com/license
 *  - For non-commercial, see www.highcharts.com/license-eula
 *
 *
 * */

/* *
 *
 *  Imports
 *
 * */

import type ColorString from '../../Core/Color/ColorString';
import type OrganizationDataLabelOptions from './OrganizationDataLabelOptions';
import type {
    SankeySeriesLevelOptions,
    SankeySeriesNodeOptions,
    SankeySeriesOptions
} from '../Sankey/SankeySeriesOptions';
import type { SeriesStatesOptions } from '../../Core/Series/SeriesOptions';
import type {
    SeriesLinkOptionsBase
} from '../Networkgraph/NetworkgraphSeriesOptions';

/* *
 *
 *  Declarations
 *
 * */

declare module '../Sankey/SankeySeriesOptions' {
    interface SankeySeriesOptions {
        /** @requires OrganizationSeries */
        linkColor?: OrganizationSeriesOptions['linkColor'];
        /** @requires OrganizationSeries */
        linkLineWidth?: OrganizationSeriesOptions['linkLineWidth'];
        /** @requires OrganizationSeries */
        link?: OrganizationSeriesOptions['link'];
    }
}

export type OrganizationLinkTypeValues = 'curved' | 'straight' | 'orthogonal';

export type OrganizationNodesLayoutValue = ('normal'|'hanging');

export interface OrganizationLinkOptions extends SeriesLinkOptionsBase {
    curveFactor?: number;
    lineWidth?: number;
    linkOpacity?: number;
    offset?: number;
    radius?: number;
    type?: OrganizationLinkTypeValues;
}

export type OrganizationHangingIndentTranslationValue = (
    'inherit'|'cumulative'|'shrink'
);


export interface OrganizationSeriesLevelOptions extends SankeySeriesLevelOptions {
    borderRadius?: number;
    linkColor?: ColorString;
    linkLineWidth?: number;
    link?: OrganizationLinkOptions;
    states: SeriesStatesOptions<OrganizationSeriesOptions>;
}

export interface OrganizationSeriesNodeOptions extends SankeySeriesNodeOptions {
    description?: string;
    image?: string;
    layout?: OrganizationNodesLayoutValue;
    title?: string;
}

export interface OrganizationSeriesOptions extends SankeySeriesOptions {
    dataLabels: OrganizationDataLabelOptions;
    hangingIndent?: number;
    hangingIndentTranslation?: OrganizationHangingIndentTranslationValue;
    hangingSide?: 'left' | 'right';
    levels?: Array<OrganizationSeriesLevelOptions>;
    link: OrganizationLinkOptions;
    linkColor?: ColorString;
    linkLineWidth?: number;
    linkRadius?: number;
    minNodeLength?: number;
    nodes?: Array<OrganizationSeriesNodeOptions>;
    states?: SeriesStatesOptions<OrganizationSeriesOptions>;
}

/* *
 *
 *  Default Export
 *
 * */

export default OrganizationSeriesOptions;