Optional auto自动控制区域属性
Optional close关闭脱敏
Optional codetypesOptional des脱敏字段信息
Optional distinctdistinct
Optional ds数据源配置信息
Optional extendOptional fields搜索结果元数据
Optional fillCNMetaOptional fillOptional get获取代码值
Optional gisOptional groups搜索分组的逻辑设置
Optional isgisJava 类名
Optional name搜索名称
Optional name2Optional order排序表达式
Optional pageOptional page页面模型名称
Optional page页码
Optional page每页大小
Optional parameters搜索参数列表
Optional prefix前缀参数
Optional returnOptional to到计数
Optional to该方法是 addParameter(name, value, flag, type) 方法的简写，两者的作用相同。该方法向搜索参数列表中添加一个参数。其中，参数列表由 QueryParameters 对象组成，该对象包含名称、值、标志和类型等属性。
以下代码创建了一个 SearchParameters 实例，并分别调用了 add() 方法两次，向实例属性 parameters 中添加两个参数。然后，我们分别使用 getParameter() 方法获取名称为 'name' 和 'age' 的参数对象。我们可以看到，在每次调用中，该方法都会创建一个新的 QueryParameters 实例，并将其添加到实例属性 parameters 中。最后，该方法还会返回新增的实例，以便在需要时进行进一步操作。
const searchParams = new SearchParameters()
searchParams.add('name', 'John Doe')
searchParams.add('age', 30, 0, SQLDataType.int)
const p1 = searchParams.getParameter('name')
console.log(p1) // QueryParameters { name: 'name', value: 'John Doe', flag: null, type: null }
const p2 = searchParams.getParameter('age')
console.log(p2) // QueryParameters { name: 'age', value: 30, flag: 0, type: 'int' }
参数名称。
参数值。
Optional flag: number参数标志。可选。第一位：1:and 2: or 第二位开始: 1:= 2:like:%% 3:like % 4:> 5:< 6:>= 7:<= 8:<> 9:like %@v 10:not like %@v 11:not like %@v% 12: not like 13:is null 14:is not null, 默认为:12
Optional type: any参数类型。
新增的 QueryParameters 实例。
方法的作用是向搜索结果集中添加一个字段名。如果实例属性 fields 为 null，则创建一个空数组；如果传入的字段名不为 null 且尚未存在于数组中，则将其添加到数组末尾
以下代码创建了一个 SearchParameters 实例，并分别调用了 addField() 方法两次，向实例属性 fields 中添加两个字段名。然后，我们分别使用 'null' 和已存在的字段名调用该方法，以测试其处理逻辑。我们可以看到，在第一个调用中，该方法不会改变实例属性 fields 的值；在第二个调用中，该方法仍然只向数组末尾添加了一个字段名；在第三个调用中，该方法相应地忽略了重复的字段名。
const searchParams = new SearchParameters()
searchParams.addField('name')
searchParams.addField('age')
console.log(searchParams.fields) // [ 'name', 'age' ]
searchParams.addField(null)
console.log(searchParams.fields) // [ 'name', 'age' ]
searchParams.addField('name')
console.log(searchParams.fields) // [ 'name', 'age' ]
字段名称。
方法的作用是向搜索参数列表中添加一个参数。其中，参数列表由 QueryParameters 对象组成，该对象包含名称、值、标志和类型等属性。
以下代码创建了一个 SearchParameters 实例，并分别调用了 addParameter() 方法两次。第一次传入了名称为 'name'，值为 'John Doe' 的参数，第二次传入了名称为 'age'，值为 30，标志为 0，类型为 SQLDataType.int 的参数。我们可以看到，在每次调用中，该方法都会创建一个新的 QueryParameters 实例，并将其添加到实例属性 parameters 中。最后，该方法还会返回新增的实例，以便在需要时进行进一步操作。
const searchParams = new SearchParameters()
const q1 = searchParams.addParameter('name', 'John Doe')
console.log(q1) // QueryParameters { name: 'name', value: 'John Doe', flag: null, type: null }
const q2 = searchParams.addParameter('age', 30, 0, SQLDataType.int)
console.log(q2) // QueryParameters { name: 'age', value: 30, flag: 0, type: 'int' }
参数名称。
参数值。
Optional flag: number参数标志，可选。第一位：1:and 2: or 第二位开始: 1:= 2:like:%% 3:like % 4:> 5:< 6:>= 7:<= 8:<> 9:like %@v 10:not like %@v 11:not like %@v% 12: not like 13:is null 14:is not null, 默认为:12
Optional type: any参数类型。
新增的 QueryParameters 实例。
方法的作用是创建当前实例的副本。该方法会返回一个新的 SearchParameters 实例，并将当前实例的属性值复制到该实例中。
以下代码创建了一个 SearchParameters 实例 searchParams1，并调用了 setName() 方法设置搜索条件名称为 'my-search'。然后，我们调用 clone() 方法创建了一个该实例的副本 searchParams2，并输出了副本实例的属性值。我们可以看到，副本实例的属性值与原始实例相同。
const searchParams1 = new SearchParameters()
searchParams1.setName('my-search')
const searchParams2 = searchParams1.clone()
console.log(searchParams2.name) // 'my-search'
新的 SearchParameters 实例。
根据参数名称获取搜索参数列表中的参数对象。
以下代码创建了一个 SearchParameters 实例，并分别调用了 addParameter() 方法两次，向实例属性 parameters 中添加两个参数。然后，我们分别使用 get() 方法获取名称为 'name' 和 'gender' 的参数对象。我们可以看到，在第一次调用中，该方法返回了名称为 'name' 的参数对象，而在第二次调用中，该方法返回了 undefined。
const searchParams = new SearchParameters()
searchParams.addParameter('name', 'John Doe')
searchParams.addParameter('age', 30)
const p1 = searchParams.get('name')
console.log(p1) // QueryParameters { name: 'name', value: 'John Doe', flag: null, type: null }
const p2 = searchParams.get('gender')
console.log(p2) // undefined
参数名称。
匹配的 QueryParameters 实例，如果未找到则返回 undefined。
方法的作用是获取是否关闭返回字段。该方法会返回实例属性 closeDes 的值。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setCloseDes() 和 getCloseDes() 方法。我们可以看到，在调用 getCloseDes() 方法时，如果实例属性 closeDes 尚未设置，则返回 null；否则，返回相应的布尔值。
const searchParams = new SearchParameters()
console.log(searchParams.getCloseDes()) // null
searchParams.setCloseDes(true)
console.log(searchParams.getCloseDes()) // true
是否关闭返回字段。
方法的作用是获取要返回的字段列表。该方法会返回实例属性 desFields 的值。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setDesFields() 和 getDesFields() 方法。我们可以看到，在调用 getDesFields() 方法时，如果实例属性 desFields 尚未设置，则返回 null；否则，返回相应的字段列表。
const searchParams = new SearchParameters()
console.log(searchParams.getDesFields()) // null
searchParams.setDesFields(['name', 'age'])
字段列表。
方法的作用是获取数据源配置对象。该方法会返回实例属性 dsConfig 的值。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setDsConfig() 和 getDsConfig() 方法。我们可以看到，在调用 getDsConfig() 方法时，如果实例属性 dsConfig 尚未设置，则返回 null；否则，返回相应的数据源配置对象。
const searchParams = new SearchParameters()
console.log(searchParams.getDsConfig()) // null
searchParams.setDsConfig({ type: 'mysql', host: 'localhost', user: 'root', password: '123456' })
console.log(searchParams.getDsConfig()) // { type: 'mysql', host: 'localhost', user: 'root', password: '123456' }
数据源配置对象。
方法的作用是获取搜索结果集的排序方式。该方法会返回实例属性 order 的值。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setOrder() 和 getOrder() 方法。我们可以看到，在调用 getOrder() 方法时，如果实例属性 order 尚未设置，则返回 null；否则，返回相应的排序方式。
const searchParams = new SearchParameters()
console.log(searchParams.getOrder()) // null
searchParams.setOrder('name DESC')
console.log(searchParams.getOrder()) // 'name DESC'
排序方式。
方法的作用是获取搜索结果集分页模块。该方法会返回实例属性 pageModule 的值。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setPageModule() 和 getPageModule() 方法。我们可以看到，在调用 getPageModule() 方法时，如果实例属性 pageModule 尚未设置，则返回 null；否则，返回相应的分页模块。
const searchParams = new SearchParameters()
console.log(searchParams.getPageModule()) // null
searchParams.setPageModule('pagination')
console.log(searchParams.getPageModule()) // 'pagination'
分页模块。
方法的作用是根据参数名称获取搜索参数列表中的参数对象 QueryParameters。如果参数列表为 null 或未找到指定名称的参数，则返回 undefined。
以下代码创建了一个 SearchParameters 实例，并分别调用了 addParameter() 方法两次，向实例属性 parameters 中添加两个参数。然后，我们分别使用 getParameter() 方法获取名称为 'name' 和 'gender' 的参数对象。我们可以看到，在第一次调用中，该方法返回了名称为 'name' 的参数对象，而在第二次调用中，该方法返回了 undefined。
const searchParams = new SearchParameters()
searchParams.addParameter('name', 'John Doe')
searchParams.addParameter('age', 30)
const p1 = searchParams.getParameter('name')
console.log(p1) // QueryParameters { name: 'name', value: 'John Doe', flag: null, type: null }
const p2 = searchParams.getParameter('gender')
console.log(p2) // undefined
参数名称。
匹配的 QueryParameters 实例，如果未找到则返回 undefined。
方法的作用是删除搜索参数列表中指定名称的参数。其中，参数列表由 QueryParameters 对象组成，该对象包含名称、值、标志和类型等属性。
以下代码创建了一个 SearchParameters 实例，并分别调用了 addParameter() 方法两次，向实例属性 parameters 中添加两个参数。然后，我们使用 removeParameter() 方法删除名称为 'age' 的参数。我们可以看到，在调用该方法后，实例属性 parameters 中只剩下一个名称为 'name' 的参数。
const searchParams = new SearchParameters()
searchParams.addParameter('name', 'John Doe')
searchParams.addParameter('age', 30)
console.log(searchParams.parameters)
// [
// { name: 'name', value: 'John Doe', flag: null, type: null },
// { name: 'age', value: 30, flag: null, type: null }
// ]
searchParams.removeParameter('age')
console.log(searchParams.parameters)
// [ { name: 'name', value: 'John Doe', flag: null, type: null } ]
参数名称。
方法的作用是设置是否关闭返回字段。该方法会将传入的参数值赋给实例属性 closeDes。
以下代码创建了一个 SearchParameters 实例，并调用了 setCloseDes() 方法一次，设置是否关闭返回字段为 true。我们可以看到，在调用该方法后，实例属性 closeDes 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setCloseDes(true)
console.log(searchParams.closeDes) // true
是否关闭返回字段。
方法的作用是设置要返回的字段列表。该方法会将传入的参数值赋给实例属性 desFields。
以下代码创建了一个 SearchParameters 实例，并调用了 setDesFields() 方法一次，设置要返回的字段列表为 [ 'name', 'age' ]。我们可以看到，在调用该方法后，实例属性 desFields 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setDesFields(['name', 'age'])
console.log(searchParams.desFields) // [ 'name', 'age' ]
字段列表。
方法的作用是设置数据源配置对象。该方法会将传入的参数值赋给实例属性 dsConfig。
以下代码创建了一个 SearchParameters 实例，并调用了 setDsConfig() 方法一次，设置数据源配置对象为 { type: 'mysql', host: 'localhost', user: 'root', password: '123456' }。我们可以看到，在调用该方法后，实例属性 dsConfig 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setDsConfig({ type: 'mysql', host: 'localhost', user: 'root', password: '123456' })
console.log(searchParams.dsConfig) // { type: 'mysql', host: 'localhost', user: 'root', password: '123456' }
数据源配置对象。
方法的作用是设置指定名称的分组的逻辑操作符。如果该分组不存在，则创建一个新的分组，并将其添加到实例属性 groups 中。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setGroupLogic() 方法两次，设置了名称为 'group1' 和 'group2' 的分组的逻辑操作符。我们可以看到，在每次调用中，该方法都会根据传入的逻辑操作符设置逻辑值，并将其添加到实例属性 groups 中。注意，不同的逻辑操作符可以通过字符串或数字类型进行传递。
const searchParams = new SearchParameters()
searchParams.setGroupLogic('group1', 'or')
searchParams.setGroupLogic('group2', 1)
console.log(searchParams.groups)
分组名称。
逻辑操作符。可选值为 'and' 或 1，表示逻辑与；'or' 或 2，表示逻辑或。
方法的作用是设置搜索条件名称。该方法会将传入的参数值赋给实例属性 name。
以下代码创建了一个 SearchParameters 实例，并调用了 setName() 方法一次，设置搜索条件名称为 'my-search'。我们可以看到，在调用该方法后，实例属性 name 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setName('my-search')
console.log(searchParams.name) // 'my-search'
搜索条件名称。
方法的作用是设置搜索结果集的排序方式。该方法会将传入的参数值赋给实例属性 order。
以下代码创建了一个 SearchParameters 实例，并调用了 setOrder() 方法一次，设置搜索结果集的排序方式为 'name DESC'。我们可以看到，在调用该方法后，实例属性 order 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setOrder('name DESC')
console.log(searchParams.order) // 'name DESC'
排序方式。
方法的作用是设置搜索结果集分页模块。该方法会将传入的参数值赋给实例属性 pageModule。
以下代码创建了一个 SearchParameters 实例，并调用了 setPageModule() 方法一次，设置搜索结果集的分页模块为 'pagination'。我们可以看到，在调用该方法后，实例属性 pageModule 的值被相应地更新。
const searchParams = new SearchParameters()
searchParams.setPageModule('pagination')
console.log(searchParams.pageModule) // 'pagination'
分页模块。
设置前缀参数。
以下代码创建了一个 SearchParameters 实例，并分别调用了 setPrefixParameter() 方法两次。第一次传入了字符串 'abc'，第二次传入了 null。由于第二次传入的是 null，所以该方法没有改变实例属性 prefixParameter 的值。
const searchParams = new SearchParameters()
searchParams.setPrefixParameter('abc')
console.log(searchParams.prefixParameter) // 'abc'
searchParams.setPrefixParameter(null)
console.log(searchParams.prefixParameter) // undefined
前缀参数值。
Generated using TypeDoc
SearchParameters类，它用于构建搜索查询。搜索参数包括前缀参数、搜索参数列表、搜索分组的逻辑设置、搜索结果元数据、排序表达式、页面模型名称、数据源配置信息、脱敏字段信息等等。
Example