@formant/ava 3.4.1-formant

package/lib/ckb/ckb.d.ts

@@ -0,0 +1,8 @@
+import type { ChartKnowledgeBase, CkbConfig } from './types';
+/**
+ * Get a CKB object.
+ *
+ * @param ckbCfg - CKB Configuration {@link CkbConfig}
+ * @public
+ */
+export declare function ckb(ckbCfg?: CkbConfig): ChartKnowledgeBase;

package/lib/ckb/ckb.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ckb = void 0;
+var tslib_1 = require("tslib");
+var base_1 = require("./base");
+/**
+ * A cheap way to get a copy of base.
+ */
+function newBase() {
+    return JSON.parse(JSON.stringify(base_1.base));
+}
+/**
+ * Process ckb config to given CKB object.
+ *
+ * 根据配置项处理 CKB 内容，得到最终使用的 CKB
+ *
+ * @param ckbCfg - CKB Configuration {@link CkbConfig}
+ * @returns CKB for actual use
+ */
+function processCkbCfg(ckb, ckbCfg) {
+    var ckbBase = ckb;
+    var exclude = ckbCfg.exclude, include = ckbCfg.include, custom = ckbCfg.custom;
+    // step 1: exclude charts from original CKB.
+    // ---
+    // 步骤一：如果有 exclude 项，先从给到的 CKB 中剔除部分选定的图表类型
+    if (exclude) {
+        exclude.forEach(function (chartType) {
+            if (Object.keys(ckbBase).includes(chartType)) {
+                delete ckbBase[chartType];
+            }
+        });
+    }
+    // step 2: only include charts from former CKB.
+    // ---
+    // 步骤二：如果有 include 项，则从当前（剔除后的）CKB中，只保留 include 中的图表类型。
+    if (include) {
+        Object.keys(ckbBase).forEach(function (chartType) {
+            if (!include.includes(chartType)) {
+                delete ckbBase[chartType];
+            }
+        });
+    }
+    // step 3: concat customized charts, may add or override chart types.
+    // ---
+    // 步骤三：在处理后的 CKB 最后，加入（可能存在的）自定义图表类型，实现图表类型的添加或覆写。
+    var finalCkbBase = tslib_1.__assign(tslib_1.__assign({}, ckbBase), custom);
+    return finalCkbBase;
+}
+/**
+ * Get a CKB object.
+ *
+ * @param ckbCfg - CKB Configuration {@link CkbConfig}
+ * @public
+ */
+function ckb(ckbCfg) {
+    var base = newBase();
+    return ckbCfg ? processCkbCfg(base, ckbCfg) : base;
+}
+exports.ckb = ckb;

package/lib/ckb/constants.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Array of standard IDs for each chart type.
+ *
+ * 所有图表类型的标准 ID
+ *
+ * @public
+ */
+export declare const CHART_IDS: readonly ["line_chart", "step_line_chart", "area_chart", "stacked_area_chart", "percent_stacked_area_chart", "column_chart", "grouped_column_chart", "stacked_column_chart", "percent_stacked_column_chart", "range_column_chart", "waterfall_chart", "histogram", "bar_chart", "stacked_bar_chart", "percent_stacked_bar_chart", "grouped_bar_chart", "range_bar_chart", "radial_bar_chart", "bullet_chart", "pie_chart", "donut_chart", "nested_pie_chart", "rose_chart", "scatter_plot", "bubble_chart", "non_ribbon_chord_diagram", "arc_diagram", "chord_diagram", "treemap", "sankey_diagram", "funnel_chart", "mirror_funnel_chart", "box_plot", "heatmap", "density_heatmap", "radar_chart", "wordcloud", "candlestick_chart", "compact_box_tree", "dendrogram", "indented_tree", "radial_tree", "flow_diagram", "fruchterman_layout_graph", "force_directed_layout_graph", "fa2_layout_graph", "mds_layout_graph", "circular_layout_graph", "spiral_layout_graph", "radial_layout_graph", "concentric_layout_graph", "grid_layout_graph"];
+/**
+ * Array of chart families.
+ *
+ * 所有图表家族
+ *
+ * @public
+ */
+export declare const FAMILIES: readonly ["LineCharts", "ColumnCharts", "BarCharts", "PieCharts", "AreaCharts", "ScatterCharts", "FunnelCharts", "HeatmapCharts", "RadarCharts", "TreeGraph", "GeneralGraph", "PolygonLayer", "LineLayer", "PointLayer", "HeatmapLayer", "Table", "Others"];
+/**
+ * Array of analysis purposes.
+ *
+ * 所有分析目的
+ *
+ * @public
+ */
+export declare const PURPOSES: readonly ["Comparison", "Trend", "Distribution", "Rank", "Proportion", "Composition", "Relation", "Hierarchy", "Flow", "Spatial", "Anomaly", "Value"];
+/**
+ * Array of coordinate systems.
+ *
+ * 所有坐标系类型
+ *
+ * @public
+ */
+export declare const COORDINATE_SYSTEMS: readonly ["NumberLine", "Cartesian2D", "SymmetricCartesian", "Cartesian3D", "Polar", "NodeLink", "Radar", "Geo", "Other"];
+/**
+ * Array of graphic categories.
+ *
+ * 所有图形大类
+ *
+ * @public
+ */
+export declare const GRAPHIC_CATEGORIES: readonly ["Statistic", "Diagram", "Graph", "Map", "Other"];
+/**
+ * Array of shapes.
+ *
+ * 所有形状
+ *
+ * @public
+ */
+export declare const SHAPES: readonly ["Lines", "Bars", "Round", "Square", "Area", "Scatter", "Symmetric", "Network", "Map", "Other"];
+/**
+ * Array of level of measurements.
+ *
+ * 所有度量水平
+ *
+ * @public
+ */
+export declare const LEVEL_OF_MEASUREMENTS: readonly ["Nominal", "Ordinal", "Interval", "Discrete", "Continuous", "Time"];
+/**
+ * Array of channels.
+ *
+ * 所有通道
+ *
+ * @public
+ */
+export declare const CHANNELS: readonly ["Position", "Length", "Color", "Area", "Angle", "ArcLength", "Direction", "Size", "Opacity", "Stroke", "LineWidth", "Lightness"];
+/**
+ * Array of recommend ratings.
+ * Recommend - For chart types you can safely recommend
+ * Use with Caution - Not recommended unless you understand the pitfalls of these chart types.
+ * Not Recommended - We know this chart type exists in the community, but it's really not recommended.
+ *
+ * 所有推荐评级
+ * Recommend - 可以安全推荐的图表类型
+ * Use with Caution - 除非你了解这些图表类型的缺陷，否则不推荐使用
+ * Not Recommended - 我们知道这种图表类型在社区里存在，但真的不建议使用
+ *
+ * @public
+ * @name RECOMMEND_RATINGS
+ */
+export declare const RECOMMEND_RATINGS: readonly ["Recommended", "Use with Caution", "Not Recommended"];

package/lib/ckb/constants.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RECOMMEND_RATINGS = exports.CHANNELS = exports.LEVEL_OF_MEASUREMENTS = exports.SHAPES = exports.GRAPHIC_CATEGORIES = exports.COORDINATE_SYSTEMS = exports.PURPOSES = exports.FAMILIES = exports.CHART_IDS = void 0;
+/**
+ * Array of standard IDs for each chart type.
+ *
+ * 所有图表类型的标准 ID
+ *
+ * @public
+ */
+exports.CHART_IDS = [
+    'line_chart',
+    'step_line_chart',
+    'area_chart',
+    'stacked_area_chart',
+    'percent_stacked_area_chart',
+    'column_chart',
+    'grouped_column_chart',
+    'stacked_column_chart',
+    'percent_stacked_column_chart',
+    'range_column_chart',
+    'waterfall_chart',
+    'histogram',
+    'bar_chart',
+    'stacked_bar_chart',
+    'percent_stacked_bar_chart',
+    'grouped_bar_chart',
+    'range_bar_chart',
+    'radial_bar_chart',
+    'bullet_chart',
+    'pie_chart',
+    'donut_chart',
+    'nested_pie_chart',
+    'rose_chart',
+    'scatter_plot',
+    'bubble_chart',
+    'non_ribbon_chord_diagram',
+    'arc_diagram',
+    'chord_diagram',
+    'treemap',
+    'sankey_diagram',
+    'funnel_chart',
+    'mirror_funnel_chart',
+    'box_plot',
+    'heatmap',
+    'density_heatmap',
+    'radar_chart',
+    'wordcloud',
+    'candlestick_chart',
+    'compact_box_tree',
+    'dendrogram',
+    'indented_tree',
+    'radial_tree',
+    'flow_diagram',
+    'fruchterman_layout_graph',
+    'force_directed_layout_graph',
+    'fa2_layout_graph',
+    'mds_layout_graph',
+    'circular_layout_graph',
+    'spiral_layout_graph',
+    'radial_layout_graph',
+    'concentric_layout_graph',
+    'grid_layout_graph',
+];
+/**
+ * Array of chart families.
+ *
+ * 所有图表家族
+ *
+ * @public
+ */
+exports.FAMILIES = [
+    'LineCharts',
+    'ColumnCharts',
+    'BarCharts',
+    'PieCharts',
+    'AreaCharts',
+    'ScatterCharts',
+    'FunnelCharts',
+    'HeatmapCharts',
+    'RadarCharts',
+    'TreeGraph',
+    'GeneralGraph',
+    'PolygonLayer',
+    'LineLayer',
+    'PointLayer',
+    'HeatmapLayer',
+    'Table',
+    'Others',
+];
+/**
+ * Array of analysis purposes.
+ *
+ * 所有分析目的
+ *
+ * @public
+ */
+exports.PURPOSES = [
+    'Comparison',
+    'Trend',
+    'Distribution',
+    'Rank',
+    'Proportion',
+    'Composition',
+    'Relation',
+    'Hierarchy',
+    'Flow',
+    'Spatial',
+    'Anomaly',
+    'Value',
+];
+/**
+ * Array of coordinate systems.
+ *
+ * 所有坐标系类型
+ *
+ * @public
+ */
+exports.COORDINATE_SYSTEMS = [
+    'NumberLine',
+    'Cartesian2D',
+    'SymmetricCartesian',
+    'Cartesian3D',
+    'Polar',
+    'NodeLink',
+    'Radar',
+    'Geo',
+    'Other',
+];
+/**
+ * Array of graphic categories.
+ *
+ * 所有图形大类
+ *
+ * @public
+ */
+exports.GRAPHIC_CATEGORIES = ['Statistic', 'Diagram', 'Graph', 'Map', 'Other'];
+/**
+ * Array of shapes.
+ *
+ * 所有形状
+ *
+ * @public
+ */
+exports.SHAPES = [
+    'Lines',
+    'Bars',
+    'Round',
+    'Square',
+    'Area',
+    'Scatter',
+    'Symmetric',
+    'Network',
+    'Map',
+    'Other',
+];
+/**
+ * Array of level of measurements.
+ *
+ * 所有度量水平
+ *
+ * @public
+ */
+exports.LEVEL_OF_MEASUREMENTS = ['Nominal', 'Ordinal', 'Interval', 'Discrete', 'Continuous', 'Time'];
+/**
+ * Array of channels.
+ *
+ * 所有通道
+ *
+ * @public
+ */
+exports.CHANNELS = [
+    'Position',
+    'Length',
+    'Color',
+    'Area',
+    'Angle',
+    'ArcLength',
+    'Direction',
+    'Size',
+    'Opacity',
+    'Stroke',
+    'LineWidth',
+    'Lightness',
+];
+/**
+ * Array of recommend ratings.
+ * Recommend - For chart types you can safely recommend
+ * Use with Caution - Not recommended unless you understand the pitfalls of these chart types.
+ * Not Recommended - We know this chart type exists in the community, but it's really not recommended.
+ *
+ * 所有推荐评级
+ * Recommend - 可以安全推荐的图表类型
+ * Use with Caution - 除非你了解这些图表类型的缺陷，否则不推荐使用
+ * Not Recommended - 我们知道这种图表类型在社区里存在，但真的不建议使用
+ *
+ * @public
+ * @name RECOMMEND_RATINGS
+ */
+exports.RECOMMEND_RATINGS = ['Recommended', 'Use with Caution', 'Not Recommended'];

package/lib/ckb/i18n/index.d.ts

@@ -0,0 +1,10 @@
+import { CkbDictionary, I18nLanguage } from './types';
+/**
+ * Get CKB dictionary of specific language except English.
+ *
+ * 得到除英文外的所有语言词汇表
+ *
+ * @param lang i18n Language code
+ * @returns TranslateList or null
+ */
+export declare function ckbDict(lang: I18nLanguage): CkbDictionary;

package/lib/ckb/i18n/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ckbDict = void 0;
+var zh_CN_1 = require("./zh-CN");
+/**
+ * Mapping from languages to translation lists.
+ *
+ * 从语言类型到翻译表的映射
+ */
+var translateMapping = {
+    'zh-CN': zh_CN_1.zhCN,
+};
+/**
+ * Get CKB dictionary of specific language except English.
+ *
+ * 得到除英文外的所有语言词汇表
+ *
+ * @param lang i18n Language code
+ * @returns TranslateList or null
+ */
+function ckbDict(lang) {
+    if (!lang || !Object.keys(translateMapping).includes(lang)) {
+        throw new Error("No CKB Dictionary for lang code ".concat(lang, "!"));
+    }
+    return translateMapping[lang];
+}
+exports.ckbDict = ckbDict;

package/lib/ckb/i18n/types.d.ts

@@ -0,0 +1,52 @@
+import type { GraphicCategory, Family, Purpose, CoordinateSystem, Shape, Channel, LevelOfMeasurement, RecommendRating, ChartId } from '../types';
+/**
+ * TS type of translated terms for all concepts (properties) involved in chart knowledge.
+ *
+ * 图表信息中涉及到的所有概念（属性）的翻译词汇表的 TS 类型
+ */
+type Concepts = {
+    /** Chart families */
+    family: Record<Family, string>;
+    /** Graphic categories */
+    category: Record<GraphicCategory, string>;
+    /** Analysis purposes */
+    purpose: Record<Purpose, string>;
+    /** Coordinate systems */
+    coord: Record<CoordinateSystem, string>;
+    /** Shapes */
+    shape: Record<Shape, string>;
+    /** Encoding channels */
+    channel: Record<Channel, string>;
+    /** Level of measurements */
+    lom: Record<LevelOfMeasurement, string>;
+    /** Recommend ratings */
+    recRate: Record<RecommendRating, string>;
+};
+/**
+ * TS type of properties that need to be internationalised in each chart knowledge.
+ *
+ * 图表知识中需要被国际化的属性的 TS 类型
+ */
+export type TransKnowledgeProps = {
+    name: string;
+    alias: string[];
+    def: string;
+};
+/**
+ * TS type of complete translation dictionary of a CKB.
+ *
+ * 完整的翻译内容结构的 TS 类型
+ */
+export type CkbDictionary = {
+    concepts: Concepts;
+    chartTypes: Record<ChartId, TransKnowledgeProps>;
+};
+/**
+ * Language Code other than en-US.
+ */
+export type I18nLanguage = 'zh-CN';
+/**
+ * Language Code
+ */
+export type Language = 'en-US' & I18nLanguage;
+export {};

package/lib/ckb/i18n/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/ckb/i18n/zh-CN.d.ts

@@ -0,0 +1,7 @@
+import type { CkbDictionary } from './types';
+/**
+ * Translate list of Chinese.
+ *
+ * 中文翻译表
+ */
+export declare const zhCN: CkbDictionary;