Interface: SchemaNative<F, O>

@react-querybuilder/native.SchemaNative

Type parameters

Name	Type
F	extends FullField
O	extends string

Hierarchy

• Schema<F, O>

• WithOptionalStyleSheets

  ↳ SchemaNative

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

Inherited from

Schema.accessibleDescriptionGenerator

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1099

---

addRuleToNewGroups

addRuleToNewGroups: boolean

Inherited from

Schema.addRuleToNewGroups

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1107

---

autoSelectField

autoSelectField: boolean

Inherited from

Schema.autoSelectField

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1105

---

autoSelectOperator

autoSelectOperator: boolean

Inherited from

Schema.autoSelectOperator

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1106

---

classNames

classNames: Classnames

Inherited from

Schema.classNames

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1070

---

combinators

combinators: FullCombinator<string>[] | OptionGroup<FullCombinator<string>>[]

Inherited from

Schema.combinators

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1071

---

controls

controls: Controls<F, O>

Inherited from

Schema.controls

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1072

---

disabledPaths

disabledPaths: Path[]

Inherited from

Schema.disabledPaths

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1113

---

enableDragAndDrop

enableDragAndDrop: boolean

Inherited from

Schema.enableDragAndDrop

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1108

---

fieldMap

fieldMap: Partial<Record<GetOptionIdentifierType<F>, F>>

Inherited from

Schema.fieldMap

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1069

---

fields

fields: FullOptionList<F>

Inherited from

Schema.fields

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1068

---

independentCombinators

independentCombinators: boolean

Inherited from

Schema.independentCombinators

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1110

---

listsAsArrays

listsAsArrays: boolean

Inherited from

Schema.listsAsArrays

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1111

---

parseNumbers

parseNumbers: ParseNumbersMethod

Inherited from

Schema.parseNumbers

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1112

---

qbId

qbId: string

Inherited from

Schema.qbId

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1067

---

showCloneButtons

showCloneButtons: boolean

Inherited from

Schema.showCloneButtons

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1103

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

Inherited from

Schema.showCombinatorsBetweenRules

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1100

---

showLockButtons

showLockButtons: boolean

Inherited from

Schema.showLockButtons

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1104

---

showNotToggle

showNotToggle: boolean

Inherited from

Schema.showNotToggle

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1101

---

showShiftActions

showShiftActions: boolean

Inherited from

Schema.showShiftActions

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1102

---

styles

Optional styles: WrapEachPropertyInStyleProp<QueryBuilderNativeStyles>

Inherited from

WithOptionalStyleSheets.styles

Defined in

native/src/types.ts:27

---

validationMap

validationMap: ValidationMap

Inherited from

Schema.validationMap

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1109

Methods

createRule

createRule(): RuleType<string, string, any, string>

Returns

RuleType<string, string, any, string>

Inherited from

Schema.createRule

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1073

---

createRuleGroup

createRuleGroup(ic?): RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Parameters

Name	Type
ic?	boolean

Returns

RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Inherited from

Schema.createRuleGroup

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1074

---

dispatchQuery

dispatchQuery(query): void

Parameters

Name	Type
query	RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

void

Inherited from

Schema.dispatchQuery

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1075

---

getInputType

getInputType(field, operator, meta): null | InputType

Parameters

Name	Type
field	string
operator	string
meta	Object
meta.fieldData	F

Returns

null | InputType

Inherited from

Schema.getInputType

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1089

---

getOperators

getOperators(field, meta): FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

Parameters

Name	Type
field	string
meta	Object
meta.fieldData	F

Returns

FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

Inherited from

Schema.getOperators

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1077

---

getQuery

getQuery(): undefined | RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

undefined | RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Inherited from

Schema.getQuery

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1076

---

getRuleClassname

getRuleClassname(rule, misc): Classname

Parameters

Name	Type
rule	RuleType<string, string, any, string>
misc	Object
misc.fieldData	F

Returns

Classname

Inherited from

Schema.getRuleClassname

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1095

---

getRuleGroupClassname

getRuleGroupClassname(ruleGroup): Classname

Parameters

Name	Type
ruleGroup	RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

Classname

Inherited from

Schema.getRuleGroupClassname

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1098

---

getValueEditorSeparator

getValueEditorSeparator(field, operator, meta): ReactNode

Parameters

Name	Type
field	string
operator	string
meta	Object
meta.fieldData	F

Returns

ReactNode

Inherited from

Schema.getValueEditorSeparator

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1083

---

getValueEditorType

getValueEditorType(field, operator, meta): ValueEditorType

Parameters

Name	Type
field	string
operator	string
meta	Object
meta.fieldData	F

Returns

ValueEditorType

Inherited from

Schema.getValueEditorType

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1080

---

getValueSources

getValueSources(field, operator, meta): ValueSources

Parameters

Name	Type
field	string
operator	string
meta	Object
meta.fieldData	F

Returns

ValueSources

Inherited from

Schema.getValueSources

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1086

---

getValues

getValues(field, operator, meta): WithUnknownIndex<Option<string> & FullOption<string>>[] | OptionGroup<WithUnknownIndex<Option<string> & FullOption<string>>>[]

Parameters

Name	Type
field	string
operator	string
meta	Object
meta.fieldData	F

Returns

WithUnknownIndex<Option<string> & FullOption<string>>[] | OptionGroup<WithUnknownIndex<Option<string> & FullOption<string>>>[]

Inherited from

Schema.getValues

Defined in

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1092