diff options
Diffstat (limited to 'dist/configuration.d.ts')
| -rw-r--r-- | dist/configuration.d.ts | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/dist/configuration.d.ts b/dist/configuration.d.ts new file mode 100644 index 0000000..af84a53 --- /dev/null +++ b/dist/configuration.d.ts @@ -0,0 +1,179 @@ +/** + * Returns a configuration by extending the defaults with the user overrides. + * + * @param {tConfiguration} [overrides={}] - User overrides. + * @returns {tConfiguration} The extended configuration. + */ +export function extendConfiguration(overrides?: tConfiguration): tConfiguration; +/** + * The configuration options to control the render. + */ +export type tConfiguration = { + /** + * - Options that control how the map is rendered. + */ + options: tConfigurationOptions; + /** + * - Options that control the look of the map. + */ + theme: tConfigurationTheme; +}; +/** + * Options that control how the map is rendered + */ +export type tConfigurationOptions = { + /** + * - Whether to render the background patterns. + */ + showBackground: boolean; + /** + * - Whether to activate smart label positioning. + */ + smartLabelPositioning: boolean; +}; +/** + * Options that control how the map is rendered + */ +export type tConfigurationTheme = { + /** + * - The colors of map elements. + */ + colors: tConfigurationThemeColors; + /** + * - The sizes of map elements. + */ + sizes: tConfigurationThemeSizes; + /** + * - The font family and sizes. + */ + fonts: tConfigurationThemeFonts; + /** + * - The line heights of map text. + */ + lineHeights: tConfigurationThemeLineHeights; + /** + * - Opacity of map elements. + */ + opacity: tConfigurationThemeOpacity; +}; +/** + * The colors of map elements + */ +export type tConfigurationThemeColors = { + /** + * - The color of the background. + */ + background: string; + /** + * : - The color of the axis lines at the edge of the map. + */ + axis: string; + /** + * - The color of component shapes. + */ + vertex: string; + /** + * - The color of component labels. + */ + label: string; + /** + * - The first color of the stage bitmap when the background is drawn. + */ + stageForeground: string; + /** + * - The second color of the stage bitmap when the background is drawn. + */ + stageBackground: string; + /** + * - The color of the inertia element. + */ + inertia: string; + /** + * - The color of the evolution arrow. + */ + evolution: string; + /** + * - A list of colors to use for groups. + */ + groups: Array<string>; +}; +/** + * The sizes of map elements + */ +export type tConfigurationThemeSizes = { + /** + * - The width of the map. + */ + mapWidth: number; + /** + * - The height of the map. + */ + mapHeight: number; + /** + * - The padding around the map for axis labels. + */ + padding: number; + /** + * - The default line width. + */ + lineWidth: number; + /** + * - Width of component shapes. + */ + vertexWidth: number; + /** + * - Height of component shapes. + */ + vertexHeight: number; + /** + * - Size of arrowheads. + */ + arrowheadSize: number; + /** + * - Height of stage lines. + */ + stageHeight: number; +}; +/** + * The sizes of map elements + */ +export type tConfigurationThemeFonts = { + /** + * - The font family to use, in CSS form. + */ + family: string; + /** + * - Font size of the axis labels. + */ + axisLabel: number; + /** + * - Font size of vertex labels. + */ + vertexLabel: number; + /** + * - Font size of note text. + */ + note: number; +}; +/** + * The line heights of map text + */ +export type tConfigurationThemeLineHeights = { + /** + * - Line height of vertex labels. + */ + vertexLabel: number; + /** + * - Line height of note text. + */ + note: number; +}; +/** + * The opacity of map elements. + */ +export type tConfigurationThemeOpacity = { + /** + * - Opacity of the color in groups + */ + groups: number; +}; |