react-native-mobilex 开发文档
    Preparing search index...

    Type Alias IDataConversion

    数据转换模块。

    在二维地图矢量数据源和 SHP、KML、Excel 等外部数据格式之间转换。

    type IDataConversion = {
        exportExcel: (option: ExportExcelOption) => Promise<string | undefined>;
        exportExcelFile: (option: ExportExcelFileOption) => Promise<boolean>;
        exportKML: (sourceId: string, style?: IGeoStyle) => Promise<string>;
        exportKMLFile: (
            sourceId: string,
            uri: string,
            style?: IGeoStyle,
        ) => Promise<boolean>;
        exportShp: (sourceId: string) => Promise<string | undefined>;
        exportShpFile: (sourceId: string, uri: string) => Promise<boolean>;
        importKML: (sourceId: string, content: string) => Promise<void>;
        importKMLFile: (sourceId: string, uri: string) => Promise<void>;
        importSHPFile: (
            sourceId: string,
            fileUris: string | string[],
            setting?: Pick<DatasourceCreateOption, "encoding">,
        ) => void;
        readExcel: (
            content: string,
            param: { firstLineAsFieldInfo: boolean } & Pick<
                DatasourceCreateOption,
                "encoding",
            >,
        ) => ExcelData
        | undefined;
        readExcelFile: (
            uri: string,
            param: { firstLineAsFieldInfo: boolean } & Pick<
                DatasourceCreateOption,
                "encoding",
            >,
        ) => Promise<ExcelData | undefined>;
    }
    Index

    Properties

    exportExcel exportExcelFile exportKML exportKMLFile exportShp exportShpFile importKML importKMLFile importSHPFile readExcel readExcelFile

    Properties

    exportExcel: (option: ExportExcelOption) => Promise<string | undefined>

    将指定矢量数据源中的数据导出为 Excel 字符串。

    导出表格会固定写入自增 ID 字段，后续列为属性字段。 当 option.includeGeometry 为 true 时，会在 ID 字段后写入 Geometry 字段； 默认不导出 Geometry，避免大空间对象导致文件体积过大或单元格内容超过 Excel 限制。

    如果属性字段与系统字段同名，会自动追加后缀重命名，例如 ID_1、Geometry_1。

    Type declaration

      • (option: ExportExcelOption): Promise<string | undefined>

      • Parameters

        Returns Promise<string | undefined>

        Excel 内容的 base64 编码字符串；导出失败时返回 undefined。

    非矢量数据源错误。

    exportExcelFile: (option: ExportExcelFileOption) => Promise<boolean>

    将指定矢量数据源中的数据导出为 Excel 文件。

    导出表格会固定写入自增 ID 字段，后续列为属性字段。 当 option.includeGeometry 为 true 时，会在 ID 字段后写入 Geometry 字段； 默认不导出 Geometry，避免大空间对象导致文件体积过大或单元格内容超过 Excel 限制。

    如果属性字段与系统字段同名，会自动追加后缀重命名，例如 ID_1、Geometry_1。

    Type declaration

    非矢量数据源错误。

    exportKML: (sourceId: string, style?: IGeoStyle) => Promise<string>

    将指定矢量数据源中的数据导出为 KML 字符串。

    Type declaration

      • (sourceId: string, style?: IGeoStyle): Promise<string>

      • Parameters

        • sourceId: string

          要导出的矢量数据源 id。

        • Optionalstyle: IGeoStyle

          指定 KML 对象风格。

        Returns Promise<string>

        KML 字符串。

    非矢量数据源错误

    exportKMLFile: (
        sourceId: string,
        uri: string,
        style?: IGeoStyle,
    ) => Promise<boolean>

    将指定矢量数据源中的数据导出为 KML 文件。

    Type declaration

      • (sourceId: string, uri: string, style?: IGeoStyle): Promise<boolean>

      • Parameters

        • sourceId: string

          要导出的矢量数据源 id。

        • uri: string

          要保存的文件 uri。

        • Optionalstyle: IGeoStyle

          指定 KML 对象风格。

        Returns Promise<boolean>

        文件写入成功返回 true；未初始化 client 文件环境或写入失败时返回 false。

    非矢量数据源错误

    exportShp: (sourceId: string) => Promise<string | undefined>

    将指定矢量数据源中的数据导出为 Shapefile 压缩包（base64）。

    输出为包含 .shp/.shx/.dbf/.prj/.cpg 的 ZIP 压缩包的 base64 编码字符串， 不是单个 .shp 文件；需要散文件请自行解压。

    Type declaration

      • (sourceId: string): Promise<string | undefined>

      • Parameters

        • sourceId: string

          要导出的矢量数据源 id。

        Returns Promise<string | undefined>

        SHP 压缩包的 base64 编码字符串；导出失败时返回 undefined。

    非矢量数据源错误。

    exportShpFile: (sourceId: string, uri: string) => Promise<boolean>

    将指定矢量数据源中的数据导出为 Shapefile 压缩包并写入指定文件。

    写入的是包含 .shp/.shx/.dbf/.prj/.cpg 的 ZIP 压缩包（不是单个 .shp）， 建议传入 .zip 后缀的 uri。

    Type declaration

      • (sourceId: string, uri: string): Promise<boolean>

      • Parameters

        • sourceId: string

          要导出的矢量数据源 id。

        • uri: string

          要保存的文件 uri（建议 .zip）。

        Returns Promise<boolean>

        文件写入成功返回 true；未初始化 client 文件环境、导出失败或写入失败时返回 false。

    非矢量数据源错误。

    importKML: (sourceId: string, content: string) => Promise<void>

    将 KML 字符串导入到指定矢量数据源中。

    Type declaration

      • (sourceId: string, content: string): Promise<void>

      • Parameters

        • sourceId: string

          要导入的矢量数据源 id。

        • content: string

          KML 字符串。

        Returns Promise<void>

    非矢量数据源错误

    importKMLFile: (sourceId: string, uri: string) => Promise<void>

    将 KML 文件中的对象导入到指定矢量数据源中。

    Type declaration

      • (sourceId: string, uri: string): Promise<void>

      • Parameters

        • sourceId: string

          要导入的矢量数据源 id。

        • uri: string

          KML 文件 uri 或 path。

        Returns Promise<void>

    非矢量数据源错误

    importSHPFile: (
        sourceId: string,
        fileUris: string | string[],
        setting?: Pick<DatasourceCreateOption, "encoding">,
    ) => void

    将 SHP 文件中的对象导入到指定矢量数据源中。

    fileUris 可以传入单个 zip 文件 URI，也可以传入一组 SHP 相关文件 URI。

    Type declaration

      • (
            sourceId: string,
            fileUris: string | string[],
            setting?: Pick<DatasourceCreateOption, "encoding">,
        ): void

      • Parameters

        • sourceId: string

          要导入的矢量数据源 id。

        • fileUris: string | string[]

          SHP 文件路径数组或包含 SHP 数据的 zip 路径。

        • Optionalsetting: Pick<DatasourceCreateOption, "encoding">

          SHP 导入参数。

        Returns void

    readExcel: (
        content: string,
        param: { firstLineAsFieldInfo: boolean } & Pick<
            DatasourceCreateOption,
            "encoding",
        >,
    ) => ExcelData
    | undefined

    读取 Excel 内容，支持 xls、xlsx、csv。

    Type declaration

      • (
            content: string,
            param: { firstLineAsFieldInfo: boolean } & Pick<
                DatasourceCreateOption,
                "encoding",
            >,
        ): ExcelData
        | undefined

      • Parameters

        • content: string

          Excel 文件的 base64 内容字符串。

        • param: { firstLineAsFieldInfo: boolean } & Pick<DatasourceCreateOption, "encoding">

          读取参数，firstLineAsFieldInfo 表示是否将首行作为字段信息。

        Returns ExcelData | undefined

        Excel 内容数据；解析失败时返回 undefined。

    readExcelFile: (
        uri: string,
        param: { firstLineAsFieldInfo: boolean } & Pick<
            DatasourceCreateOption,
            "encoding",
        >,
    ) => Promise<ExcelData | undefined>

    读取 Excel 文件内容，支持 xls、xlsx、csv。

    Type declaration

      • (
            uri: string,
            param: { firstLineAsFieldInfo: boolean } & Pick<
                DatasourceCreateOption,
                "encoding",
            >,
        ): Promise<ExcelData | undefined>

      • Parameters

        • uri: string

          Excel 文件 uri。

        • param: { firstLineAsFieldInfo: boolean } & Pick<DatasourceCreateOption, "encoding">

          读取参数，firstLineAsFieldInfo 表示是否将首行作为字段信息。

        Returns Promise<ExcelData | undefined>

        Excel 内容数据；未初始化 client 文件环境或解析失败时返回 undefined。

    Settings

    Member Visibility

    On This Page

    Properties