@amcharts/amcharts5
Version:
amCharts 5
61 lines • 2.19 kB
TypeScript
import { Color } from "../core/util/Color";
import { Theme } from "../core/Theme";
import type { Root } from "../core/Root";
/**
* Options for {@link MonochromeTheme}.
*/
export interface IMonochromeThemeSettings {
/**
* Base color the single-hue ramp is built from. Accepts a hex number, a
* CSS string, or a [[Color]].
*
* If omitted, the ramp defaults to a blue base (`#2e7c9e`).
*/
color?: number | string | Color;
/**
* Optional accent color applied to the **first** series only, so one series
* stands out against the monochrome ramp (like the "Dataviz" theme's single
* color). Accepts a hex number, a CSS string, or a [[Color]].
*/
accent?: number | string | Color;
/**
* Produce a dark variant (dark background + interface colors, and a ramp
* that runs light-to-mid so series read on the dark ground).
*
* @default false
*/
dark?: boolean;
/**
* Number of steps in the series ramp.
*
* @default 7
*/
count?: number;
}
/**
* "Monochrome" — a black-and-white (or single-accent) theme whose series
* palette is a perceptually-even, single-hue lightness ramp generated in OKLCH.
*
* Because a theme cannot take constructor parameters, this ships as a **factory
* function** rather than a class:
*
* ```TypeScript
* root.setThemes([
* am5themes_Monochrome(root, { color: 0x2c6e91, dark: true })
* ]);
* ```
*
* With nothing set, the theme defaults to a blue ramp (`#2e7c9e`). Pass `color`
* for a different single-hue ramp, and an optional `accent` to give the first
* series a distinct pop (like the "Dataviz" theme's single color). This theme is
* additive; it does not modify any built-in theme.
*
* @see {@link https://www.amcharts.com/docs/v5/concepts/themes/} for more info
* @important
*/
export declare function MonochromeTheme(root: Root, settings?: IMonochromeThemeSettings): Theme;
export declare namespace MonochromeTheme {
var _a: (root: Root, settings?: IMonochromeThemeSettings) => Theme;
export { _a as new };
}
//# sourceMappingURL=MonochromeTheme.d.ts.map