ag-charts-community/dist/types/src/chart/themes/axisThemeTemplate.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

/**
 * Title defaults for axes that render a title (cartesian + radius). Composed via
 * `mergeDefaults` into the relevant module `themeTemplate`s so the Normalised
 * `title` R-list keys are guaranteed populated post-theme-merge.
 */
export declare const titleAxisThemeTemplate: {
    title: {
        enabled: boolean;
        text: string;
        spacing: number;
        fontWeight: {
            $ref: string;
        };
        fontSize: {
            $rem: number;
        };
        fontFamily: {
            $ref: string;
        };
        color: {
            $ref: string;
        };
        wrapping: string;
        truncate: boolean;
    };
};
/**
 * Parent-level defaults for time-style cartesian axes (`time`, `unit-time`,
 * `ordinal-time`). Composed via `mergeDefaults` into those modules'
 * `themeTemplate`s so the Normalised `parentLevel` R-list keys are guaranteed
 * populated post-theme-merge.
 */
export declare const parentLevelAxisThemeTemplate: {
    parentLevel: {
        enabled: boolean;
        label: {
            enabled: {
                $path: string;
            };
            border: {
                enabled: {
                    $or: ({
                        $isUserOption: (string | boolean)[];
                        $path?: undefined;
                    } | {
                        $path: string;
                        $isUserOption?: undefined;
                    })[];
                };
                strokeWidth: {
                    $path: string;
                };
                stroke: {
                    $path: string;
                };
            };
            fill: {
                $path: string;
            };
            fontSize: {
                $path: string;
            };
            fontFamily: {
                $path: string;
            };
            fontWeight: string;
            spacing: {
                $path: string;
            };
            color: {
                $path: string;
            };
            cornerRadius: {
                $path: string;
            };
            padding: {
                $path: string;
            };
            avoidCollisions: {
                $path: string;
            };
        };
        tick: {
            enabled: {
                $path: string;
            };
            width: {
                $path: string;
            };
            size: {
                $path: string;
            };
            stroke: {
                $path: string;
            };
        };
    };
};
/**
 * Shared axis theme defaults composed into every axis module's `themeTemplate`.
 *
 * Per `defaults.md`, module `themeTemplate`s are the canonical home for runtime
 * defaults. Each axis module merges this constant via `mergeDefaults` so the
 * Normalised label / line / tick / gridLine R-list keys are guaranteed
 * populated post-theme-merge.
 */
export declare const commonAxisThemeTemplate: {
    reverse: boolean;
    label: {
        enabled: boolean;
        fontSize: {
            $ref: string;
        };
        fontFamily: {
            $ref: string;
        };
        fontWeight: {
            $ref: string;
        };
        spacing: number;
        color: {
            $ref: string;
        };
        avoidCollisions: boolean;
        cornerRadius: number;
        border: {
            enabled: boolean;
            strokeWidth: number;
            stroke: {
                $foregroundOpacity: number;
            };
        };
        padding: {
            $if: (number | {
                $path: string;
                left?: undefined;
                right?: undefined;
                top?: undefined;
                bottom?: undefined;
            } | {
                left: number;
                right: number;
                top: number;
                bottom: number;
                $path?: undefined;
            })[];
        };
    };
    line: {
        enabled: boolean;
        width: number;
        stroke: {
            $ref: string;
        };
    };
    tick: {
        enabled: boolean;
        size: number;
        width: number;
        stroke: {
            $ref: string;
        };
    };
    gridLine: {
        enabled: boolean;
        width: number;
        style: {
            $apply: ({
                fillOpacity: number;
                stroke: {
                    $ref: string;
                };
                strokeWidth: {
                    $path: string;
                };
                lineDash: never[];
            } | {
                fillOpacity: number;
                stroke: {
                    $ref: string;
                };
                strokeWidth: {
                    $path: string;
                };
                lineDash: never[];
            }[])[];
        };
    };
};