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

    Type Alias ITheme

    专题图模块

    分段、单值、统一标签、分段标签、单值标签专题图的管理

    type ITheme = {
        addRangeItem: (
            layerId: string,
            params: IThemeRangeItem,
            index?: number,
        ) => Promise<boolean>;
        addUniqueItem: (
            layerId: string,
            params: IThemeUniqueItem,
            index?: number,
        ) => boolean;
        createLabelRangeTheme: (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                labelExpression: string;
                rangeCount: number;
                rangeExpression: string;
                rangeMode: RangeMode;
            },
        ) => Promise<IThemeLabelRange | undefined>;
        createLabelTheme: (
            params: {
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                expression: string;
            },
        ) => IThemeLabel
        | undefined;
        createLabelUniqueTheme: (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                labelExpression: string;
                uniqueExpression: string;
            },
        ) => Promise<IThemeLabelUnique | undefined>;
        createRangeTheme: (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<IGeoStyle>;
                expression: string;
                geometryType: IGeometryType;
                rangeCount: number;
                rangeMode: RangeMode;
            },
        ) => Promise<IThemeRange | undefined>;
        createUniqueTheme: (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<IGeoStyle>;
                expression: string;
            },
        ) => Promise<IThemeUnique | undefined>;
    }
    Index

    Properties

    addRangeItem: (
        layerId: string,
        params: IThemeRangeItem,
        index?: number,
    ) => Promise<boolean>

    为分段专题图新增分段项。

    Type declaration

      • (layerId: string, params: IThemeRangeItem, index?: number): Promise<boolean>
      • Parameters

        • layerId: string

          分段专题图图层 id。

        • params: IThemeRangeItem

          专题图分段信息。

        • Optionalindex: number

          插入分段位置;不传时追加到末尾。

        Returns Promise<boolean>

        新增成功返回 true;图层不存在或不是分段专题图时返回 false。

    addUniqueItem: (
        layerId: string,
        params: IThemeUniqueItem,
        index?: number,
    ) => boolean

    为单值专题图新增单值项。

    Type declaration

      • (layerId: string, params: IThemeUniqueItem, index?: number): boolean
      • Parameters

        • layerId: string

          单值专题图图层 id。

        • params: IThemeUniqueItem

          专题图单值信息。

        • Optionalindex: number

          插入单值位置;不传时追加到末尾。

        Returns boolean

        新增执行成功返回 true;图层不存在或类型校验未通过时返回 false。

    createLabelRangeTheme: (
        params: {
            colorScheme?: IColorScheme | ColorSchemeType;
            datasourceID: string;
            defaultStyle?: Partial<ITextStyle>;
            labelExpression: string;
            rangeCount: number;
            rangeExpression: string;
            rangeMode: RangeMode;
        },
    ) => Promise<IThemeLabelRange | undefined>

    创建分段标签专题图。

    方法只返回专题图对象配置,不会自动添加到图层;可将返回值用于创建专题图层。

    Type declaration

      • (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                labelExpression: string;
                rangeCount: number;
                rangeExpression: string;
                rangeMode: RangeMode;
            },
        ): Promise<IThemeLabelRange | undefined>
      • Parameters

        • params: {
              colorScheme?: IColorScheme | ColorSchemeType;
              datasourceID: string;
              defaultStyle?: Partial<ITextStyle>;
              labelExpression: string;
              rangeCount: number;
              rangeExpression: string;
              rangeMode: RangeMode;
          }

          分段标签专题图创建参数。

          • OptionalcolorScheme?: IColorScheme | ColorSchemeType

            颜色方案

          • datasourceID: string

            数据源ID

          • OptionaldefaultStyle?: Partial<ITextStyle>

            默认风格

          • labelExpression: string

            标签表达式

          • rangeCount: number

            分段数

          • rangeExpression: string

            分段表达式

          • rangeMode: RangeMode

            分段模式

        Returns Promise<IThemeLabelRange | undefined>

        分段标签专题图对象;数据源不存在或创建失败时返回 undefined。

    createLabelTheme: (
        params: {
            datasourceID: string;
            defaultStyle?: Partial<ITextStyle>;
            expression: string;
        },
    ) => IThemeLabel
    | undefined

    创建统一标签专题图。

    Type declaration

      • (
            params: {
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                expression: string;
            },
        ): IThemeLabel
        | undefined
      • Parameters

        • params: { datasourceID: string; defaultStyle?: Partial<ITextStyle>; expression: string }

          统一标签专题图创建参数。

          • datasourceID: string

            数据源ID

          • OptionaldefaultStyle?: Partial<ITextStyle>

            默认风格

          • expression: string

            专题表达式

        Returns IThemeLabel | undefined

        统一标签专题图对象;创建失败时返回 undefined。

    createLabelUniqueTheme: (
        params: {
            colorScheme?: IColorScheme | ColorSchemeType;
            datasourceID: string;
            defaultStyle?: Partial<ITextStyle>;
            labelExpression: string;
            uniqueExpression: string;
        },
    ) => Promise<IThemeLabelUnique | undefined>

    创建单值标签专题图。

    方法只返回专题图对象配置,不会自动添加到图层;可将返回值用于创建专题图层。

    Type declaration

      • (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<ITextStyle>;
                labelExpression: string;
                uniqueExpression: string;
            },
        ): Promise<IThemeLabelUnique | undefined>
      • Parameters

        • params: {
              colorScheme?: IColorScheme | ColorSchemeType;
              datasourceID: string;
              defaultStyle?: Partial<ITextStyle>;
              labelExpression: string;
              uniqueExpression: string;
          }

          单值标签专题图创建参数。

          • OptionalcolorScheme?: IColorScheme | ColorSchemeType

            颜色方案

          • datasourceID: string

            数据源ID

          • OptionaldefaultStyle?: Partial<ITextStyle>

            默认风格

          • labelExpression: string

            标签表达式

          • uniqueExpression: string

            统一表达式

        Returns Promise<IThemeLabelUnique | undefined>

        单值标签专题图对象;数据源不存在或创建失败时返回 undefined。

    createRangeTheme: (
        params: {
            colorScheme?: IColorScheme | ColorSchemeType;
            datasourceID: string;
            defaultStyle?: Partial<IGeoStyle>;
            expression: string;
            geometryType: IGeometryType;
            rangeCount: number;
            rangeMode: RangeMode;
        },
    ) => Promise<IThemeRange | undefined>

    创建分段专题图。

    方法只返回专题图对象配置,不会自动添加到图层;可将返回值用于创建专题图层。

    Type declaration

      • (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<IGeoStyle>;
                expression: string;
                geometryType: IGeometryType;
                rangeCount: number;
                rangeMode: RangeMode;
            },
        ): Promise<IThemeRange | undefined>
      • Parameters

        Returns Promise<IThemeRange | undefined>

        分段专题图对象;数据源不存在或创建失败时返回 undefined。

    createUniqueTheme: (
        params: {
            colorScheme?: IColorScheme | ColorSchemeType;
            datasourceID: string;
            defaultStyle?: Partial<IGeoStyle>;
            expression: string;
        },
    ) => Promise<IThemeUnique | undefined>

    创建单值专题图。

    方法只返回专题图对象配置,不会自动添加到图层;可将返回值用于创建专题图层。

    Type declaration

      • (
            params: {
                colorScheme?: IColorScheme | ColorSchemeType;
                datasourceID: string;
                defaultStyle?: Partial<IGeoStyle>;
                expression: string;
            },
        ): Promise<IThemeUnique | undefined>
      • Parameters

        • params: {
              colorScheme?: IColorScheme | ColorSchemeType;
              datasourceID: string;
              defaultStyle?: Partial<IGeoStyle>;
              expression: string;
          }

          单值专题图创建参数。

          • OptionalcolorScheme?: IColorScheme | ColorSchemeType

            颜色方案

          • datasourceID: string

            数据源ID

          • OptionaldefaultStyle?: Partial<IGeoStyle>

            默认风格

          • expression: string

            专题表达式

        Returns Promise<IThemeUnique | undefined>

        单值专题图对象;数据源不存在或创建失败时返回 undefined。