@quickbi/bi-types 3.0.49 → 3.0.50

package/cjs/standard-model.d.ts

@@ -1,497 +0,0 @@
-/**
- * @author 凌亦
- * @description 图表统一输入模型
- */
-/**
- * -------------------------------------------------------------------------------------------
- * | areas区域模型
- * -------------------------------------------------------------------------------------------
- */
-import type { EmptyValueDisplayConfig, SecondDataType } from './cube/cube-model';
-import type { FieldCollectionType, TopNParams } from './data-panel';
-/** 字段信息 */
-export interface FieldModel {
-    /** @deprecated 请优先使用 uuid
-     *  唯一Id */
-    fieldId: string;
-    /** qbi中对应pathId */
-    pathId?: string;
-    /** 字段名 */
-    fieldName: string;
-    /** 最终展示别名 */
-    showName: string;
-    /** 字段描述 */
-    comments?: string;
-    /** 是否计算字段 */
-    isCalc?: boolean;
-    /** 是否显示字段 */
-    isHidden?: boolean;
-    /** 如：calc */
-    skin?: string;
-    /** 值的类型 */
-    valueType?: FieldValueType;
-    /** 字段类型: 维度或度量 */
-    fieldType: FieldCommonType;
-    /** 聚合方式 */
-    aggregation?: FieldAggregation | string;
-    /** [QBI特有] 数据渲染形式，目前有imageUrl, imageFileId用于交叉表、排行榜图片渲染 */
-    displayType?: SecondDataType.imageUrl | SecondDataType.imageFileId | SecondDataType.geographic | '';
-    /** [QBI特有] 数据集格式化配置，如#,##0.00% */
-    rawFormat?: string;
-    /** [QBI特有] 数据集维度类型, TimeRegionInBackend, 需迁移，防止循环依赖 */
-    dimGranularity?: any;
-    /** [FBI特有] 日期格式 */
-    dateFormat?: string;
-    /** 最终格式化配置（注：qbi目前是放在styleConfig中，该字段并未被使用） */
-    /** ！！首先得产品层面统一 */
-    format?: QbiFormatModel | FbiFormatModel;
-    /** 排序 */
-    order?: FieldOrder;
-    /** 自定义排序 */
-    customOrder?: string[];
-    /** [FBI特有] 排序优先级（大的排前面） */
-    orderPriority?: number;
-    /** 高级计算：同环比等 */
-    advancedCalculation?: 'year-to-year' | 'month-to-year';
-    /** 当前图表的过滤条件集合 */
-    complexFilter: {
-        limitNum: number;
-        filter: any;
-    };
-    uuid: string;
-    /** 字段排名信息 */
-    rank?: string;
-    /** 累计计算日期类型 */
-    granularity?: string;
-    /** [FBI特有] 时间类型 */
-    dateStep?: 'year' | 'year-financial' | 'quarter' | 'month' | 'week-last7' | 'week' | 'week-monday' | 'week-tuesday' | 'week-wednesday' | 'week-thursday' | 'week-friday' | 'week-saturday' | 'day' | 'hour' | 'minute' | 'second';
-    /** 不同图表字段特殊扩展信息 */
-    extends?: FieldModelExtends;
-    fdow?: number;
-    timeFormat?: string;
-    refCustomRegion?: string;
-    /** topn 参数 */
-    topNParams?: TopNParams;
-    /** 累计计算参数 */
-    countParams?: string;
-    /** 百分位参数 */
-    percentileParams?: string;
-    /** 字段集类型 */
-    fieldCollectionType?: FieldCollectionType | null;
-    /** 是否来自于字段组全选字段 */
-    fromFieldGroup?: boolean;
-    /** 空值展示配置 */
-    emptyValueDisplayConfig?: EmptyValueDisplayConfig;
-}
-/** 通用字段聚合方式 */
-export type FieldAggregation = 'sum' | 'avg' | 'max' | 'min' | 'count' | 'countd';
-/** 通用字段类型（维度/度量） */
-export type FieldCommonType = 'dimension' | 'measure';
-/** 通用字段值类型 */
-export type FieldValueType = 'number' | 'string' | 'date' | 'datetime' | 'geographic' | 'calc' | 'unknown';
-/** 通用字段排序 */
-export type FieldOrder = 'asc' | 'desc' | 'custom' | null;
-/** 不同图表字段特殊扩展信息 */
-export type FieldModelExtends = any;
-/** 区域信息，例如：区分x值轴、y值轴、颜色、细分、尺寸等等，qbi、fbi 要统一映射 */
-export type AreaType = 'row' | 'column' | 'xAxis' | 'yAxis' | 'yMainAxis' | 'ySecondaryAxis' | 'color' | 'legend' | 'size' | 'tooltip' | 'drill' | 'filters' | 'dimValues' | 'area_measure' | 'area_target_measure' | 'area_value' | 'time' | 'mainMeasure' | 'secondaryMeasure' | 'from_dim' | 'to_dim' | 'tooltip' | 'floor' | 'facet' | 'image' | 'sampling';
-export interface AreaModel {
-    /** 区域类型 */
-    areaType: AreaType;
-    /** 区域名称 */
-    areaName?: string;
-    /** 字段信息 */
-    fields: FieldModel[];
-    /** 各图表的扩展信息 */
-    extends?: AreaModelExtends;
-}
-export type AreaModelExtends = any;
-/** QBI format模型 */
-export interface QbiFormatModel {
-    fmt: string;
-    fmtType: 'CN' | 'KMG' | 'CNT' | 'Custom' | 'None';
-    decimalPlaces: number;
-    thousandth: boolean;
-    showPercent: boolean;
-}
-/** fbi format */
-export type FbiFormatModel = any;
-/**
- * -------------------------------------------------------------------------------------------
- * | 数据集合
- * | NOTE: Cellset中不含头部
- * -------------------------------------------------------------------------------------------
- */
-/** 单元格数据值 */
-export interface DataCell {
-    uuid?: string;
-    /**
-     * @deprecated
-     *【请使用uuid】所属字段id（一般是度量）
-     * */
-    fieldId?: string;
-    /** 原始值 */
-    originValue: string;
-    /** 展示值 */
-    value: string;
-    geoInfo?: object;
-    /** 敏感字段 */
-    dataMask?: boolean;
-    props?: {
-        dataMask?: boolean;
-        supportDrill?: boolean;
-    };
-    /** 是否可下钻，例如下一层级数据为空会返回false */
-    supportDrill?: boolean;
-    /** 是维度组合并时，合并对应的字段 */
-    mergedFields?: FieldModel[];
-    /** 其他内容 */
-    [key: string]: any;
-}
-/** 数据值集合 */
-export type Cellset = DataCell[][];
-export interface RowColumnHeaderCell extends DataCell {
-    /** fbi中代表数据集建模后的字段类型, qbi中需要梳理？ */
-    dataType?: string;
-    latitude?: string;
-    longitude?: string;
-    props?: {
-        fid: string;
-        guid: string;
-        type: string;
-        aggregator?: string;
-        granularity?: string;
-        label: string;
-        description?: string;
-        format: string;
-        dataMask?: boolean;
-        hidden: boolean;
-        supportDrill?: boolean;
-    };
-}
-export interface RowColumnHeader {
-    /** 是否为总计行或列 */
-    total: boolean;
-    /** 是否为小计行或列 */
-    subtotal: boolean;
-    /** 行或列内单元（注：列头下是按一列一列来组织的） */
-    cells: RowColumnHeaderCell[];
-    /** 分组名称(表格类图表有用到) */
-    groupName?: string;
-    /** 分组信息 */
-    groups?: string[];
-    /** 是否是迷你图 */
-    isCellChart?: boolean;
-}
-/**
- * -------------------------------------------------------------------------------------------
- * | 最终输入模型
- * -------------------------------------------------------------------------------------------
- */
-export type ChartInputModel<S = StyleConfigModel> = {
-    /** @todo @凌亦 charts-qbi 依赖了 getCachedThemeConfig, 因此需要传 pageId, 这块后续要去掉这个依赖 */
-    pageId: string;
-    /** 区域及字段信息 */
-    areas: AreaModel[];
-    /** 配置信息 */
-    styleConfig: S;
-    /** 数据集高级配置 */
-    advancedConfig?: AdvancedConfigModel;
-    /** 数值区域的数据 */
-    rows: Cellset;
-    /** 保留全部rows，只看排除交互式分析操作会对rows进行筛选，图表内部仍需要全部rows */
-    originRows?: Cellset;
-    /** 全局配置 */
-    globalConfig?: GlobalConfig;
-    /** 行头数据（仅轴查询（交叉表）下有此值） */
-    rowHeaders?: RowColumnHeader[];
-    /** 列头数据（非轴查询下，此数据可能与areas中的数据相同） */
-    columnHeaders?: RowColumnHeader[];
-    /** 组件id */
-    id?: string;
-    /** 大屏场景，会将组建名称挂载在这里 */
-    componentName?: string;
-    /** 运行时信息，大屏场景用到了 */
-    runtimeData?: Record<string, any>;
-    /** 移动端图表相关配置 */
-    mobileOptions?: MobileChartOptions;
-} & S;
-/** 图表样式配置 */
-export interface StyleConfigModel {
-    [key: string]: any;
-}
-/** 移动端图表下特有的配置项 */
-export interface MobileChartOptions {
-    /** 是否是全屏模式 */
-    fullScreen?: boolean;
-    /** 手机是否处于是横屏模式 */
-    isHorizontal?: boolean;
-    /** 被默认选择的数据index */
-    legendIndex?: number;
-    /** 移动端哪些图例没有被选中 */
-    uncheckedResult?: {
-        field: string;
-        uncheckedItems: any[];
-    }[];
-    /** 移动端默认最小高度,用户修改布局后失效 */
-    chartMinHeight?: number;
-    /** 移动端栅格布局配置 */
-    mobileTileLayout?: any;
-    /** 是否是栅格布局 */
-    isGridLayout?: boolean;
-    /** 是否是自适应高度 */
-    isAutoHeight?: boolean;
-    /** 是否是在移动预览模式 */
-    isMobileView?: boolean;
-}
-/** 数据集高级配置 */
-export interface AdvancedConfigModel {
-    [key: string]: any;
-    /** 合并单元格 */
-    mergeCell?: boolean;
-    /** 跨区域维度对齐配置 */
-    alignmentConfig?: DimensionAlignmentItem[];
-}
-/** 跨区块对齐信息 */
-export interface DimensionAlignmentItem {
-    id: string;
-    /** 当前区块维度 */
-    currentFieldId: string;
-    /** 当前数据集id */
-    currentBindId: string;
-    /** 关联区块 */
-    colIndex: number;
-    /** 关联区块维度 */
-    correlationFieldId: string;
-    /** 关联数据集id */
-    correlationBindId: string;
-}
-/**
- * 摘要洞察类型
- * 值由后端提供，不要修改
- */
-export declare enum ReportSummaryInsightType {
-    /**
-     * 统一分析（从xxx看）
-     */
-    OVERALL_ANALYSIS = "OVERALL_ANALYSIS",
-    /**
-     * 日期统一分析（从最初时间到最终时间）
-     */
-    TIME_OVERALL_ANALYSIS = "TIME_OVERALL_ANALYSIS",
-    /**
-     * 日期最新分析（从最新时间到环比）
-     */
-    TIME_LATEST_ANALYSIS = "TIME_LATEST_ANALYSIS",
-    /**
-     * 维度分析（找最高和最低的）
-     */
-    TOP_DIMENSION_COMBO_ANALYSIS = "TOP_DIMENSION_COMBO_ANALYSIS",
-    /**
-     * 问数侧的日期分析（默认选取第一个，优先选取同环比）
-     */
-    LLM_CUBE_TIME_ANALYSIS = "LLM_CUBE_TIME_ANALYSIS"
-}
-/** 报表摘要结果 */
-export interface ReportSummaryItem {
-    /** 摘要的内容元素，直接按顺序拼接成完整的一句话 */
-    summaryElements: {
-        /** 静态文本 */
-        staticText?: string;
-        /** 动态值 */
-        valueName?: string;
-    }[];
-    /** 动态值（虚拟字段）的具体信息 */
-    summaryValues: {
-        /** 与 summaryElements 中元素的 valueName 对应 */
-        name: string;
-        /** 实际值 */
-        value: string;
-        /** 描述信息 */
-        description: string;
-        /** 类型，是文本还是数值 */
-        type?: string;
-        /** 默认数值展示格式 */
-        format?: string;
-    }[];
-    /** 附加信息 */
-    summaryExtra?: {
-        /** 洞察类型 */
-        insightType?: ReportSummaryInsightType;
-        /** 组件 id */
-        componentId?: string;
-        /** cubeId */
-        cubeId?: string;
-        /** 时间类型 */
-        dateLevel?: string;
-        /** deltaRatio */
-        deltaRatio?: number;
-        /** 维值id */
-        dimensionFieldId?: string;
-        /** 维值 */
-        dimensionValue?: string;
-        /** 原始点信息 */
-        firstValue?: string;
-        /** 对比点信息 */
-        secondValue?: string;
-        /** 对比点信息 */
-        secondDimensionValue?: string;
-        /** 对比点值 */
-        originValue?: number;
-        /** totalValue */
-        totalValue?: number;
-        /** 差值 */
-        deltaValue?: number;
-        /** 维度id */
-        measureFieldId?: string;
-        /** 维度 */
-        measureName?: string;
-        /** 影子数据集 */
-        cubeShadow?: string;
-        /** 原字段信息 */
-        fields?: {
-            /** 字段前端 id */
-            guid: string;
-            /** 数据集字段 id */
-            fid: string;
-            /** 取数类型 */
-            areaType?: 'row' | 'column';
-            /** 聚合方式 */
-            aggregate?: string;
-        }[];
-        /** 取数 limit  */
-        limit?: number;
-    };
-}
-export declare enum Env {
-    /** 电子表格 */
-    excel = "excel",
-    /** pc */
-    pc = "pc",
-    /** 移动 */
-    mobile = "mobile"
-}
-/** 高级分析对应的返回结果 */
-interface AdvancedResultItem {
-    /** 异常值检测返回的结果 */
-    anomalyDetectionResults?: any[];
-    /** 预测返回的结果 */
-    forecastResults?: any[];
-    /** 辅助线返回的结果 */
-    summarizeResults?: any[];
-    /** 趋势线返回的结果 */
-    trendLineResults?: any[];
-    /** 聚类返回结果 */
-    clusteringResults?: any[];
-    /** 词云图频次/分词结果 */
-    wordCloudResult?: {
-        /** 维度fieldId */
-        dimFieldId?: string;
-        /** 度量fieldId, 频次就为undefined */
-        measureFieldId?: string;
-        /** 具体词云数据 */
-        data?: any[];
-    };
-    /** 报表摘要动态指标结果 */
-    dynamicMetricResult?: ReportSummaryItem;
-}
-export interface DataCompareResultItem {
-    /** 数据对比支持的日期粒度枚举类型 */
-    type: string;
-    /** 对比周期对应的数据集 */
-    cellset?: any[][];
-    /** 对比周期对应的高级分析结果 */
-    advancedResult?: AdvancedResultItem;
-    /** 对比结果对应的新的数据模型 */
-    rows?: Cellset;
-}
-export interface AnnotationResult {
-    inflectionPointAnnotationResults: {
-        id: string;
-        inflectionPointAnnotationMeasureResults: {
-            measure: string;
-            legendValue: string;
-            legend: string;
-            dimensions: string[];
-            dimensionValues: (string | number)[];
-        }[];
-    }[];
-    measureThresholdResults: {
-        id: string;
-        legend: string;
-        legendValue: string;
-        measure: string;
-        type: string;
-        values: {
-            [key: string]: string | number;
-        };
-    }[];
-}
-/** 图表全局配置 */
-export interface GlobalConfig {
-    /** 高级分析结果 */
-    advancedResult?: AdvancedResultItem;
-    /** 数据对比结果 */
-    dataCompareResult?: DataCompareResultItem[];
-    /** 指标计算方式 */
-    indicatorCalculation: 'latest' | 'summary';
-    /** 阶段汇总数据结果 */
-    totalResult?: {
-        rows?: Cellset;
-    };
-    /** 标注计算结果 */
-    annotationResult?: AnnotationResult;
-    /** 是否钻取 */
-    isDrill?: boolean;
-    /** 下钻别名 */
-    drillCaptions?: any;
-    /** 被钻取的维度 */
-    originDrillDimPathId?: string;
-    /** 图表接收的卡片上交互式分析的信息, 栈结构保留了历史操作记录 */
-    chartSelectParams?: any;
-    /** 图表接收到卡片通过右上角菜单进入标注模式 */
-    annotationParam: {
-        isEnter: boolean;
-    };
-    /** 当前被钻取到的维度 */
-    currentDrillDimPathId?: string;
-    /** 联动维度 */
-    relationDim?: string;
-    /** 联动类型, 如果配置了, 现在都是x */
-    relationType?: string;
-    /** 环境 给自定义组件使用，误删 */
-    env?: Env[];
-    /**
-     * 环境变量，结构同pageSchema.environment,但是无法引用RenderEnvironment类型，迁移改动大，暂不修改
-     */
-    environment?: {
-        /** 当前页面类型（目前支持：仪表板、电子表格，默认为仪表板） */
-        pageType: string;
-        /** 当前页面展示模式 */
-        displayMode: string;
-        /** 端设备（默认pc） */
-        device?: string;
-    };
-    /** 表格分页信息 */
-    page?: {
-        limit: number;
-        offset: number;
-        count: number;
-    };
-    /** 表格条件格式 */
-    conditionalFormatResults?: any[];
-    /** 是否有总计结果 */
-    hasTotalResult?: boolean;
-}
-/** CrossTableCell图的最终输入配置 */
-export interface CellChartInputModel<S = StyleConfigModel> {
-    /** @todo @凌亦 charts-qbi 依赖了 getCachedThemeConfig, 因此需要传 pageId, 这块后续要去掉这个依赖 */
-    pageId: string;
-    /** 区域及字段信息 */
-    areas: AreaModel[];
-    /** mini图对应的数据 */
-    rows: Cellset;
-    /** mini图的样式配置 */
-    styleConfig: S;
-}
-export {};

package/cjs/ui/page-header.d.ts

@@ -1,14 +0,0 @@
-/**
- * 头部相关的类型定义
- */
-/** 各个资源页头部按钮组别枚举 */
-export declare enum ResourcePageHeaderGroupEnum {
-    /** 设置操作按钮组 例如 页面设置、全局参数、替换数据集 */
-    setting = "setting",
-    /** 状态操作按钮组 例如 预览、保存、发布 */
-    state = "state",
-    /** 动作操作按钮组 例如 分享、导出 */
-    action = "action",
-    /** 收进更多的操作按钮 */
-    menu = "menu"
-}