GAPI. data

用户数据API

方法列表

(static) add(dataUid, feature, onSuccess可选, onError可选)

向某个数据集中添加一个对象
Parameters:
Name Type Attributes Description
dataUid String 数据集的uid
feature Object 添加的数据对象
Properties
Name Type Attributes Description
geom Array | Object <optional>
 对象的几何信息，如 [116.39, 39.9]
attrs Object <optional>
 对象的属性信息，如 {name: '北京'}
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.add(
    '36e9debaf3354dd29802405010c0d45c',
    {
        geom: [0, 0],
        attrs: {
            '安装地点': '测试'
        }
    },
    function(data){console.log(data)},
    function(error){console.error(error)}
);

(static) delete(dataUid, id, onSuccess可选, onError可选)

删除某个数据集中的一个对象
Parameters:
Name Type Attributes Description
dataUid String 数据集的uid
id String 数据对象的id
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.delete(
    '36e9debaf3354dd29802405010c0d45c',
    79,
    function(data){console.log(data)},
    function(error){console.error(error)}
);

(static) get(dataUid, id, options, onSuccess可选, onError可选)

根据数据中某一记录的id来获取对象
Parameters:
Name Type Attributes Description
dataUid String 数据集的uid
id String 数据对象的id
options Object 选项
Properties
Name Type Attributes Default Description
returnGeometry Boolean <optional>
 true 是否返回几何形状
outFields String <optional>
 指定返回部分字段，如指定为 "['NAME', 'ADDR']" 表示只返回NAME和ADDR字段，注意这是一个以JSON形式表示的字符串
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.get(
    '36e9debaf3354dd29802405010c0d45c',
    '1',
    {
        returnGeometry: true,
        outFields: "['NAME', 'TYPE']"
    },
    function(data){console.log(data)},
    function(error){console.error(error)}
);

(static) list(options, onSuccess可选, onError可选)

获取数据列表
Parameters:
Name Type Attributes Description
options Object 选项
Properties
Name Type Attributes Default Description
search String <optional>
 过滤部分结果
page String <optional>
 0 指定页数
limit String <optional>
 10 指定每页最多返回的结果
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.list(
    {
        search: '空气',
        page: 2,
        limit: 10
    },
    function(data){console.log(data)},
    function(error){console.error(error)}
);

(static) query(dataUid, options, onSuccess可选, onError可选)

根据条件查询数据中的若干对象
Parameters:
Name Type Attributes Description
dataUid String 数据集的uid
options Object 选项
Properties
Name Type Attributes Default Description
where String <optional>
 指定一个where条件，如 "TYPE='餐饮'"
searchWords String <optional>
 如数据中有全文索引的字段，可以进行全文检索，注意这是一个以JSON形式表示的字符串
geometry String <optional>
 指定几何对象进行过滤，如指定为 "[116, 39, 117, 41]" 表示通过一个矩形对象进行过滤
sortField String <optional>
 指定一个字段，返回结果按这个字段排序
sortType String <optional>
 默认指定为DESC进行倒序排序，或指定为ASC表示顺序排序
offset Number <optional>
 0 指定返回结果从开头跳过的数量
limit Number <optional>
 10 限制最多返回结果的数量
returnGeometry Boolean <optional>
 true 是否返回几何形状
outFields String <optional>
 指定返回部分字段，如指定为 "['NAME', 'ADDR']" 表示只返回NAME和ADDR字段，注意这是一个以JSON形式表示的字符串
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.query(
    '36e9debaf3354dd29802405010c0d45c',
    {
        where: "NAME='麦当劳'",
        searchWords: "['北京', '停车']",
        geometry: "[116, 39, 117, 41]",
        sortField: "NAME",
        sortType: "ASC",
        offset: 20,
        limit: 10,
        returnGeometry: true,
        outFields: "['NAME', 'TYPE']"
    },
    function(data){console.log(data)},
    function(error){console.error(error)}
);

(static) update(dataUid, id, feature, onSuccess可选, onError可选)

更新某个数据集中的一个对象
Parameters:
Name Type Attributes Description
dataUid String 数据集的uid
id String 数据对象的id
feature Object 更新的数据对象值
Properties
Name Type Attributes Description
geom Array | Object <optional>
 对象的几何信息，如 [116.39, 39.9]
attrs Object <optional>
 对象的属性信息，如 {name: '北京'}
onSuccess function <optional>
 请求成功的回调函数
onError function <optional>
 请求失败的回调函数
Returns:
GAPI
Example
GAPI.data.update(
    '36e9debaf3354dd29802405010c0d45c',
    79,
    {
        geom: [0, 0],
        attrs: {
            '安装地点': '测试测试'
        }
    },
    function(data){console.log(data)},
    function(error){console.error(error)}
);