@newview/ui 0.0.1

package/types/HtmlJson.d.ts

@@ -0,0 +1,824 @@
+export interface IHtmlResult {
+    pages: IHtmlPage[]
+}
+
+export interface IHtmlPage {
+    name: string,
+    index: string,
+    status: string,
+    order: number,
+    zoomRatio: number, // sheet zoom ratio 10%-400%
+    showGridLines: string, // show grid lines
+    /**
+     * 宽度
+     */
+    width: number,
+    /**
+     * 高度
+     */
+    height: number,
+    /**
+     * 原始宽度 canvas绘制的宽度
+     */
+    orgWidth: number,
+    /**
+     * 原始高度 canvas绘制的高度
+     */
+    orgHeight: number,
+    /**
+     * 横纵表
+     * portrait：纵表
+     * landscape：横表
+     */
+    oriantation: 'portrait' | 'landscape',
+    /**
+     * 总行数
+     */
+    row: number,
+    /**
+     * 列行数
+     */
+    col: number,
+    /**
+     * 行高配置
+     */
+    rowHeights: any,
+    /**
+     * 列宽配置
+     */
+    columnWidths: any,
+    /**
+     * 边框
+     */
+    tdBorders: IHtmlTdBorders,
+    /**
+     * 内容
+     */
+    html: string,
+    /**
+     * 打印设置 边距
+     */
+    printSet: IHtmlPrintSet,
+    /**
+     * 单元格
+     */
+    cells: IHtmlCells,
+    /**
+     * 合并的单元格
+     */
+    merges: any,
+    /**
+     * 开始边框行
+     */
+    startTopBorder: number,
+    /**
+     * 结束边框行
+     */
+    endTopBorder: number
+}
+
+export interface IHtmlTD {
+    value: string | IHtmlTDValue | IHtmlTDValue[],
+    style?: any,
+    tdStyle?: any,
+    colspan?: number,
+    rowspan?: number,
+    isRender?: boolean,
+    isMerge?: boolean,
+    tdContent?: string,
+    isEdit?: boolean,
+    edit?: IEdit,
+    tag?: any,
+    editIndex: number,
+    rowIndex: number,
+    colIndex: number
+}
+
+/**
+ * 编辑配置
+ */
+export interface IEdit {
+    /**
+     * 属性组Id
+     */
+    PropertyGroupId: number,
+    /**
+     * 属性组类型 item table
+     */
+    PropertyGroupType: string,
+    /**
+     * 属性Id
+     */
+    PropertyId?: number,
+    /**
+     * 字段名称
+     */
+    FieldName: string,
+    /**
+     * 字段Label
+     */
+    FieldLabel: string,
+    /**
+     * 字段类型
+     * input 文本框
+     * textarea 文本域
+     * date 日期
+     * select 下拉框
+     * radio 单选框
+     * checkbox 多选框
+     * button 按钮
+     * img 图片
+     */
+    FieldType: string,
+    /**
+     * 字段配置
+     */
+    FieldOption: any,
+    /**
+     * 是否为数组
+     */
+    IsArray?: boolean,
+    /**
+     * 表格渲染类型 
+     * h 横向
+     * v 纵向
+     * hv 先横后纵
+     * vh 先纵后横
+     */
+    TableType: string,
+    /**
+     * 是否分页
+     */
+    TablePage: boolean,
+    /**
+     * 横向循环次数
+     */
+    TableHNumber: number,
+    /**
+     * 横向间隔
+     */
+    TableHStep: number,
+    /**
+     * 纵向循环次数
+     */
+    TableVNumber: number,
+    /**
+     * 纵向间隔
+     */
+    TableVStep: number,
+    /**
+     * 是否为公式结果
+     */
+    IsFormulaResult: boolean,
+    /**
+     * 当前流程步骤
+     */
+    IsCurrentVWFStep: boolean,
+    /**
+     * 虚拟流程步骤Id
+     */
+    VWFStepId: number
+}
+
+export interface IHtmlTDValue {
+    value: string,
+    style?: any
+}
+
+export interface IHtmlTDs {
+    [key: string]: IHtmlTD
+}
+
+export interface IHtmlCells {
+    maxRow: number,
+    maxCol: number,
+    defaultColWidth: number,
+    defaultRowHeight: number,
+    tds: IHtmlTDs,
+    borders: IHtmlTdBorders,
+    tdArray: IHtmlTD[][]
+}
+
+export interface IHtmlTdBorders {
+    [key: string]: IHtmlBorder
+}
+
+export interface IHtmlBorder {
+    style: any,
+    left: number,
+    right: number,
+    top: number,
+    bottom: number
+}
+
+export interface IHtmlImage {
+    src: string,
+    style: any,
+    name: string,
+}
+
+export interface IHtmlTextBox {
+    text: string,
+    style: any
+}
+/**
+ * 打印设置
+ */
+export interface IHtmlPrintSet {
+    marginTop: string,
+    marginRight: string,
+    marginBottom: string,
+    marginLeft: string,
+    headerRows: number,
+    showRowsfirst: number,
+    footerRows: number,
+    contentRows: number,
+    printscale: number,//打印缩放比率
+    oriantation: string,//打印纸张方向
+}
+
+
+export interface ICell {
+    trIndex: number,
+    tdIndex: number,
+    rowspan: number,
+    colspan: number,
+    ele: HTMLTableCellElement,
+    $td: any
+}
+
+export interface IHlboxSelectedStyle {
+    top: string,
+    left: string,
+    width: string,
+    height: string
+}
+
+export interface ISelectedArea {
+    isDown: boolean,
+    startCell?: ICell,
+    currentCell?: ICell,
+    parentLeft: number,
+    parentTop: number,
+    isShowHlboxSelectedStyle: boolean,
+    hlboxSelectedStyle: IHlboxSelectedStyle
+}
+
+export interface ILuckyFile {
+    info: ILuckyFileInfo,//File information, name,password,date,createor etc. 
+    sheets: IluckySheet[],//Sheets, include all sheet data
+}
+
+export interface ILuckyFileInfo {
+    name: string,// File name
+    creator: string,//Create user
+    lastmodifiedby: string,//Edit user
+    createdTime: string,
+    modifiedTime: string,
+    company: string,
+    appversion: string,//Excel version, Is it necessary?
+}
+
+
+
+export interface IluckySheet {
+    name: string,// Sheet name, it will show on sheet bar, must be unique
+    color: string,// Sheet color, it will show on sheet bar
+    config?: IluckySheetConfig, // Row height, column width, hidden, and so on
+
+    index: string, //A sheet uniquely identifies, 
+    status: string, //If 1 , it means current shown sheet, else means hidden
+    order: number, //Order of sheet
+    row: number,// Sheet the number of rows, contain blank cell
+    column: number, // Sheet the number of columns, contain blank cell
+    // visibledatarow:number[],
+    // visibledatacolumn:number[],
+    luckysheet_select_save?: IluckySheetSelection[],//selection defines
+    scrollLeft: number,//horizen scroll offset
+    scrollTop: number,//verticel scroll offset
+
+    celldata?: IluckySheetCelldata[],// cells
+    chart?: IluckySheetChart[],
+
+    data?: Array<IluckySheetCelldataValue[]>, // data
+
+    isPivotTable: boolean,
+    pivotTable?: IluckySheetPivotTable,
+
+    luckysheet_conditionformat_save?: IluckysheetConditionFormat[],
+    freezen?: IluckysheetFrozen,
+
+    calcChain?: IluckysheetCalcChain[],
+
+    zoomRatio: number, //sheet zoom ratio 10%-400%
+
+    showGridLines: string, // show grid lines
+
+    defaultColWidth: number, //cloumn width pixel
+    defaultRowHeight: number, //row height pixel
+
+    images: IluckyImages,//image list
+    textBoxs?: IluckyTextBoxs, // textBox list
+    lines?: IluckyLines// diagonal line 对角线
+    dataVerification: IluckysheetDataVerification;
+    hyperlink: IluckysheetHyperlink, // hyperlinks
+    hide: number; // sheet hide 
+    visibledatarow: any; //by 20230211
+    visibledatacolumn: any;//by 20230211
+}
+
+//luckysheet general selection
+export interface IluckySheetSelection {
+    row: number[], //selection start row and end row
+    column: number[], //selection start column and end column
+    sheetIndex: number
+}
+
+export interface IluckySheetChart {
+
+}
+
+//pivot table interface
+export interface IluckySheetPivotTable {
+    pivot_select_save: IluckySheetSelection,//Pivot table data source range
+    pivotDataSheetIndex: string | undefined, //data source sheet index, index is unique id
+    column: IluckySheetPivotTableField[],// column area, include filed 
+    row: IluckySheetPivotTableField[], // row area, include filed 
+    filter: IluckySheetPivotTableField[], // filter area, include filed 
+    filterparm: IluckySheetPivotTablefilterParam,// save param after apply filter
+    values: IluckySheetPivotTableField[],
+    showType: string,
+    pivotDatas: any[][],
+    drawPivotTable: boolean,
+    pivotTableBoundary: number[],
+}
+
+export interface IluckySheetPivotTableField {
+    index: number,
+    name: string,
+    fullname: string,
+    sumtype: string,
+    nameindex: number
+}
+
+export interface IluckySheetPivotTablefilterParam {
+    [index: string]: IluckySheetPivotTablefilterParamItem
+}
+
+export interface IluckySheetPivotTablefilterParamItem {
+    caljs: IluckySheetPivotTablefilterParamItemCaljs,
+    rowhidden: IluckySheetPivotTablefilterParamItemRowhidden,
+    selected: IluckySheetPivotTablefilterParamItemSelected,
+}
+
+export interface IluckySheetPivotTablefilterParamItemCaljs {
+    text: string,
+    type: string,
+    value: string,
+    value1: string,
+}
+
+export interface IluckySheetPivotTablefilterParamItemRowhidden {
+    [index: number]: number
+}
+
+export interface IluckySheetPivotTablefilterParamItemSelected {
+    [index: number]: number
+}
+
+
+export interface IluckysheetFrozen {
+    horizen: number | undefined, //freeze horizen row number
+    vertical: number | undefined, //freeze horizen column number
+}
+
+export interface IluckysheetConditionFormat {
+    type: string, //Option:defualt,databar,colorGradation,icons,
+    cellrange: IluckySheetSelection[],//Valid range
+    format: string[] | IluckysheetCFDefaultFormat | IluckysheetCFIconsFormat,//style
+    conditionName: string | undefined,//Detailed settings,comparison parameters
+    conditionRange: IluckySheetSelection[],//Detailed settings,comparison range
+    conditionValue: any[],//Detailed settings,comparison value
+}
+
+export interface IluckysheetCFDefaultFormat {
+    textColor: string | undefined | null,
+    cellColor: string | undefined | null
+}
+
+export interface IluckysheetCFIconsFormat {
+    len: string | number,
+    leftMin: string | number,
+    top: string | number,
+}
+
+export interface IluckysheetCalcChain {
+    r: number,
+    c: number,
+    index: string | undefined,
+    // func?:any[],//[true, 152, "=SUBTOTAL(9,OFFSET(F15,ROW(F15:F18)-ROW(F15),1,3))"] 已经计算、终值、公式
+}
+
+export interface IluckySheetCelldata {
+    r: number,//cell row number
+    c: number,//cell column number
+    v: IluckySheetCelldataValue | string | null, //cell value
+    flag: any; // 单元格用户属性
+}
+
+export interface IluckySheetCelldataValue {
+    /**
+     * celltype,Cell value format: text, time, etc.
+     */
+    ct?: ILuckySheetCellFormat, //celltype,Cell value format: text, time, etc.
+    /**
+     * background,#fff000
+     */
+    bg?: string,//background,#fff000	
+    /**
+     * fontfamily,
+     */
+    ff?: string,//fontfamily,
+    /**
+     * fontcolor
+     */
+    fc?: string,//fontcolor
+    /**
+     * Bold
+     */
+    bl?: number,//Bold
+    /**
+     * italic
+     */
+    it?: number,//italic
+    /**
+     * font size	
+     */
+    fs?: number,//font size	
+    /**
+     * Cancelline, 0 Regular, 1 Cancelline
+     */
+    cl?: number,//Cancelline, 0 Regular, 1 Cancelline
+    /**
+     * underline, 0 Regular, 1 underlines, fonts
+     */
+    un?: number,//underline, 0 Regular, 1 underlines, fonts
+    /**
+     * Vertical alignment, 0 middle, 1 up, 2 down
+     */
+    vt?: number,//Vertical alignment, 0 middle, 1 up, 2 down
+    /**
+     * Horizontal alignment,0 center, 1 left, 2 right
+     */
+    ht?: number,//Horizontal alignment,0 center, 1 left, 2 right
+    /**
+     * Merge Cells
+     */
+    mc?: IluckySheetCelldataValueMerge, //Merge Cells
+    /**
+     * Text rotation,0: 0、1: 45 、2: -45、3 Vertical text、4: 90 、5: -90
+     */
+    tr?: number, //Text rotation,0: 0、1: 45 、2: -45、3 Vertical text、4: 90 、5: -90
+    /**
+     * Text wrap,0 truncation, 1 overflow, 2 word wrap
+     */
+    tb?: number, //Text wrap,0 truncation, 1 overflow, 2 word wrap
+    /**
+     * Original value	
+     */
+    v?: string, //Original value	
+    /**
+     * Display value	
+     */
+    m?: string, //Display value	
+    /**
+     * text rotation angle 0-180 alignment
+     */
+    rt?: number, //text rotation angle 0-180 alignment
+    /**
+     * formula
+     */
+    f?: string, //formula
+    /**
+     * quotePrefix, show number as string
+     */
+    qp?: number, //quotePrefix, show number as string
+    flag?: any,  //配置属性  
+}
+
+
+export interface ILuckySheetCellFormat {
+    fa: string //Format definition string
+    t: string // Cell Type
+    s?: any[]
+}
+
+export interface IluckySheetCelldataValueMerge {
+    rs?: number, //row of merge cell  length, only main merge cell, every merge cell has only one main mergeCell
+    cs?: number, //column of merge cell  length, only main merge cell, every merge cell has only one main mergeCell
+    r: number, // main merge cell row Number, other cell link to main cell
+    c: number, // main merge cell column Number, other cell link to main cell
+}
+
+//Lucky sheet config attribute
+export interface IluckySheetConfig {
+    merge?: IluckySheetConfigMerges, //merge handdler
+    // _borderInfo?: IMapluckySheetborderInfoCellForImp, //range border
+    borderInfo: IluckySheetborderInfoCellForImp[],//range border
+    rowlen?: IluckySheetRowAndColumnLen, // every row's height
+    columnlen?: IluckySheetRowAndColumnLen,// every column's width
+    rowhidden?: IluckySheetRowAndColumnHidden,//setting be hidden rows
+    colhidden?: IluckySheetRowAndColumnHidden,//setting be hidden columns 
+    customHeight: IluckySheetRowAndColumnHidden,//user operate row height
+    customWidth: IluckySheetRowAndColumnHidden//user operate column width 
+    authority: any;//数据表保护设置
+    alias?: IluckySheetConfigCellAlias,
+    printPage?: IprintPage,//固定头尾分页说明 
+}
+//sheet print config
+export interface IprintPage {
+    headerRows: number,//页头行【index from 1 正数】
+    showRowsfirst: number,//只在第一页显示
+    footerRows: number,//页尾行 [index from 1 倒数]
+    contentRows: number,//内容行【行数】
+    marginTop: string,//打印上边距
+    marginRight: string,//打印右边距
+    marginBottom: string,//打印下边距
+    marginLeft: string,//打印左边距
+    printscale: number,//打印缩放比率 
+    oriantation: string,//打印纸张方向
+    pageSize: string,//打印纸号 A4 A3
+}
+//Merge cells interface
+export interface IluckySheetConfigMerges {
+    [firstRange: string]: IluckySheetConfigMerge // "r_s":{ r,c,rs,cs } format, define a main merge cell 
+}
+//Merge cell interface
+export interface IluckySheetConfigMerge {
+    r: number,
+    c: number,
+    rs: number,
+    cs: number
+}
+// cell set alias
+export interface IluckySheetConfigCellAlias {
+    [index: string]: string
+}
+
+//Border cell interface
+export interface IluckySheetborderInfoCell {
+    rangeType: string,
+    value: IluckySheetborderInfoCellValue,
+}
+export interface IluckySheetborderInfoCellValue {
+    row_index: number,
+    col_index: number,
+    l?: IluckySheetborderInfoCellValueStyle,
+    r?: IluckySheetborderInfoCellValueStyle,
+    t?: IluckySheetborderInfoCellValueStyle,
+    b?: IluckySheetborderInfoCellValueStyle
+}
+export interface IluckySheetborderInfoCellValueStyle {
+    "style": number,
+    "color": string
+}
+//border range interface
+export interface IluckySheetborderInfoRange {
+    rangeType: string,
+    borderType: string,
+    style: string,
+    color: string,
+    range: IluckySheetSelection[],
+}
+
+//Border cell interface for import
+export interface IluckySheetborderInfoCellForImp {
+    rangeType: string,
+    cells?: string[],
+    value: IluckySheetborderInfoCellValue,
+    range?: any[]
+}
+
+
+//Border cell interface for import
+export interface IMapluckySheetborderInfoCellForImp {
+    [index: number]: IluckySheetborderInfoCellForImp
+}
+
+//row length and column length interface
+export interface IluckySheetRowAndColumnLen {
+    [index: string]: number
+}
+
+//row and column hidden interface
+export interface IluckySheetRowAndColumnHidden {
+    [index: string]: number
+}
+
+export interface IFormulaSI {
+    [index: string]: IFormulaCell
+}
+
+export interface IFormulaCell {
+    [index: string]: IFormulaCellValue
+}
+
+export interface IFormulaCellValue {
+    t: string
+    ref: string
+    si: string
+    fv: string
+    cellValue: IluckySheetCelldata
+}
+
+export interface ILuckyInlineString {
+    ff: string | undefined //font family
+    fc: string | undefined//font color
+    fs: number | undefined//font size
+    cl: number | undefined//strike
+    un: number | undefined//underline
+    bl: number | undefined//blod
+    it: number | undefined//italic
+    va: number | undefined//1sub and 2super and 0none
+    v: string | undefined
+}
+//Line
+export interface IluckyLine {
+    color?: string,//颜色
+    thick?: number,//线的宽度
+    fromCol?: number
+    fromRow?: number
+    toCol?: number
+    toRow?: number
+    left?: number
+    top?: number
+    width?: number
+    height?: number
+}
+
+// TextBox
+export interface IluckyTextBox {
+    v: IluckySheetCelldataValue
+    border: IluckyImageBorder
+    default: IluckyImageDefault
+    setchange?: number
+    fromCol?: number
+    fromColOff?: number
+    fromRow?: number
+    fromRowOff?: number
+    toCol?: number
+    toColOff?: number
+    toRow?: number
+    toRowOff?: number
+    alias: string
+    text: string
+}
+
+//Image
+export interface IluckyImage {
+    border: IluckyImageBorder
+    crop: IluckyImageCrop
+    default: IluckyImageDefault
+
+    fixedLeft: number
+    fixedTop: number
+    isFixedPos: boolean
+    originHeight: number
+    originWidth: number
+    src: string
+    type: string
+    fullcell?: number
+    setchange?: number
+    fromCol?: number
+    fromColOff?: number
+    fromRow?: number
+    fromRowOff?: number
+    toCol?: number
+    toColOff?: number
+    toRow?: number
+    toRowOff?: number
+    alias: string
+}
+
+export interface IluckyImageBorder {
+    color: string
+    radius: number
+    style: string
+    width: number
+}
+
+export interface IluckyImageCrop {
+    height: number
+    offsetLeft: number
+    offsetTop: number
+    width: number
+}
+
+export interface IluckyImageDefault {
+    height: number
+    left: number
+    top: number
+    width: number
+    leftoffset: number,//add by newview 20230211 相对偏移量
+    topoffset: number,//add by newview 20230211 相对偏移量
+}
+export interface IluckyLines {
+    [index: string]: IluckyLine
+}
+export interface IluckyImages {
+    [index: string]: IluckyImage
+}
+
+export interface IluckyTextBoxs {
+    [index: string]: IluckyTextBox
+}
+
+export interface IcellOtherInfo {
+    [index: string]: IformulaList
+}
+
+export interface IformulaList {
+    [index: string]: IformulaListItem
+}
+
+export interface IformulaListItem {
+    r: number,
+    c: number
+}
+
+
+// DataVerification
+export interface IluckysheetDataVerification {
+    [key: string]: IluckysheetDataVerificationValue;
+}
+
+export interface IluckysheetDataVerificationValue {
+    type: IluckysheetDataVerificationType;
+    type2: string | null;
+    value1: string | number | null;
+    value2: string | number | null;
+    checked: boolean;
+    remote: boolean;
+    prohibitInput: boolean;
+    hintShow: boolean;
+    hintText: string;
+}
+
+export type IluckysheetDataVerificationType =
+    | "dropdown"
+    | "checkbox"
+    | "number"
+    | "number_integer"
+    | "number_decimal"
+    | "text_content"
+    | "text_length"
+    | "date"
+    | "validity";
+
+export interface IluckysheetHyperlink {
+    [key: string]: IluckysheetHyperlinkValue;
+}
+
+export interface IluckysheetHyperlinkValue {
+    linkAddress: string;
+    linkTooltip: string;
+    linkType: IluckysheetHyperlinkType;
+    display: string;
+}
+
+export type IluckysheetHyperlinkType = "internal" | "external";
+
+
+/**
+ * 解析参数
+ */
+export interface ParserOption {
+    /**
+     * 偏移宽度
+     */
+    driftWidth?: number,
+    /**
+     * 
+     * 偏移高度
+     */
+    driftHeight?: number,
+    /**
+     * 解析回调
+     * @param IHtmlTD 
+     * @param IHtmlPage 
+     * @returns 
+     */
+    parseCallback: (IHtmlTD: IHtmlTD, IHtmlPage: IHtmlPage) => IEdit
+}
+
+export declare class HtmlJson {
+    /**
+     * 初始化
+     */
+    constructor(sheets: IluckySheet[]);
+    /**
+     * 解析
+     * @param parseCallback 
+     */
+    Parse(option: ParserOption): IHtmlResult;
+}