gabby-query-protocol-react-context

Index

Classes

Type aliases

Variables

GabbyQueryProtocolContext

Functions

Type aliases

TGabbyQueryProtocolContextType

TGabbyQueryProtocolContextType: { operatorLabels: TPredicateOperatorLabels; projectionEditor: IProjectionEditor; subjectDictionary: IPredicateSubjectDictionary; addProjectionItem: any; appendPredicate: any; getChildrenIds: any; getJunctionById: any; getOrderedProjectionList: any; getPredicateById: any; getProjectionItem: any; makeEmptyPredicate: any; removePredicate: any; removeProjectionItem: any; setConjunction: any; setDisjunction: any; updatePredicate: any; updateProjectionSubject: any }

Type declaration

operatorLabels: TPredicateOperatorLabels
projectionEditor: IProjectionEditor
subjectDictionary: IPredicateSubjectDictionary
addProjectionItem: function
- addProjectionItem(projectionItem: TProjectionProperties): string
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:39
  Parameters
  - projectionItem: TProjectionProperties
  Returns string
appendPredicate: function
- appendPredicate(parentNodeId: string, node: TPredicateProperties): string
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:19
  Parameters
  - parentNodeId: string
  - node: TPredicateProperties
  Returns string
getChildrenIds: function
- getChildrenIds(predicateId: string): string[]
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:20
  Parameters
  - predicateId: string
  Returns string[]
getJunctionById: function
- getJunctionById(predicateId: string): TPredicatePropertiesJunction
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:21
  Parameters
  - predicateId: string
  Returns TPredicatePropertiesJunction
getOrderedProjectionList: function
- getOrderedProjectionList(): TProjectionDictionary
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:37
  Returns TProjectionDictionary
getPredicateById: function
- getPredicateById(predicateId: string): null | TPredicateNode
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:22
  Parameters
  - predicateId: string
  Returns null | TPredicateNode
getProjectionItem: function
- getProjectionItem(projectionKey: string): TProjectionProperties
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:38
  Parameters
  - projectionKey: string
  Returns TProjectionProperties
makeEmptyPredicate: function
- makeEmptyPredicate(): TPredicateProperties
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:24
  Returns TPredicateProperties
removePredicate: function
- removePredicate(predicateId: string): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:30
  Parameters
  - predicateId: string
  Returns void
removeProjectionItem: function
- removeProjectionItem(projectionKey: string): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:40
  Parameters
  - projectionKey: string
  Returns void
setConjunction: function
- setConjunction(predicateId: string): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:31
  Parameters
  - predicateId: string
  Returns void
setDisjunction: function
- setDisjunction(predicateId: string): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:32
  Parameters
  - predicateId: string
  Returns void
updatePredicate: function
- updatePredicate(predicateId: string, node: TPredicateNode): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:34
  Parameters
  - predicateId: string
  - node: TPredicateNode
  Returns void
updateProjectionSubject: function
- updateProjectionSubject(projectionKey: string, updateProps: TProjectionPropertiesUpdatable): void
- - Defined in src/lib/GabbyQueryProtocolContext/context/type.ts:41
  Parameters
  - projectionKey: string
  - updateProps: TProjectionPropertiesUpdatable
  Returns void

TPredicateJunctionOperator

TPredicateJunctionOperator: "$and" | "$nand" | "$nor" | "$or"

TPredicateNode

TPredicateNode: TPredicateProperties | TPredicatePropertiesJunction | TPredicatePropertiesArrayValue

TPredicateOperatorLabels

TPredicateOperatorLabels: {[ op in TPredicateOperator | TPredicateJunctionOperator]: string }

TPredicateProperties

TPredicateProperties: { operator: TPredicateOperator; subjectId: string; value: number | string }

Type declaration

operator: TPredicateOperator
subjectId: string
value: number | string

TPredicatePropertiesArrayValue

TPredicatePropertiesArrayValue: TPredicateProperties & { value: (number | string)[] }

TPredicateSubjectWithId

TPredicateSubjectWithId: TPredicateSubjectProperties & { subjectId: string }

TSerializedPredicateTree

TSerializedPredicateTree: SerializedTree<TPredicateNode>

TValueLabelList

TValueLabelList: TValueLabel[]

Variables

Const GabbyQueryProtocolContext

GabbyQueryProtocolContext: Context<null | TGabbyQueryProtocolContextType> = ...

Functions

Const default

default(__namedParameters: Props): Element

- Defined in src/lib/GabbyQueryProtocolContext/context/Provider.tsx:42
Parameters
- __namedParameters: Props
Returns Element

Const useJunctionProperties

useJunctionProperties(nodeId: string): { appendPredicate: (newPredicate: TPredicateProperties) => void; getChildrenIds: () => string[]; getPredicateProperties: () => TPredicatePropertiesJunction; makeEmptyPredicate: () => TPredicateProperties; queryPredicate: TPredicatePropertiesJunction; removeMe: () => void; setConjunction: () => void; setDisjunction: () => void }

- Defined in src/lib/GabbyQueryProtocolContext/hooks/useJunctionProperties.ts:10
Parameters
- nodeId: string
Returns { appendPredicate: (newPredicate: TPredicateProperties) => void; getChildrenIds: () => string[]; getPredicateProperties: () => TPredicatePropertiesJunction; makeEmptyPredicate: () => TPredicateProperties; queryPredicate: TPredicatePropertiesJunction; removeMe: () => void; setConjunction: () => void; setDisjunction: () => void }
- appendPredicate: (newPredicate: TPredicateProperties) => void
  - - (newPredicate: TPredicateProperties): void
    - Parameters
      - newPredicate: TPredicateProperties
      Returns void
- getChildrenIds: () => string[]
  - - (): string[]
    - Returns string[]
- getPredicateProperties: () => TPredicatePropertiesJunction
  - - (): TPredicatePropertiesJunction
    - Returns TPredicatePropertiesJunction
- makeEmptyPredicate: () => TPredicateProperties
  - - (): TPredicateProperties
    - Returns TPredicateProperties
- queryPredicate: TPredicatePropertiesJunction
- removeMe: () => void
  - - (): void
    - Returns void
- setConjunction: () => void
  - - (): void
    - Returns void
- setDisjunction: () => void
  - - (): void
    - Returns void

Const usePredicateProperties

usePredicateProperties(nodeId: string): { appendPredicate: (newPredicate: TPredicateProperties) => void; makeEmptyPredicate: () => TPredicateProperties; operatorLabels: TPredicateOperatorLabels; queryPredicate: TPredicateProperties; removeMe: () => void; updateMe: (change: TPredicateProperties) => void }

- Defined in src/lib/GabbyQueryProtocolContext/hooks/usePredicateProperties.ts:6
Parameters
- nodeId: string
Returns { appendPredicate: (newPredicate: TPredicateProperties) => void; makeEmptyPredicate: () => TPredicateProperties; operatorLabels: TPredicateOperatorLabels; queryPredicate: TPredicateProperties; removeMe: () => void; updateMe: (change: TPredicateProperties) => void }
- appendPredicate: (newPredicate: TPredicateProperties) => void
  - - (newPredicate: TPredicateProperties): void
    - Parameters
      - newPredicate: TPredicateProperties
      Returns void
- makeEmptyPredicate: () => TPredicateProperties
  - - (): TPredicateProperties
    - Returns TPredicateProperties
- operatorLabels: TPredicateOperatorLabels
- queryPredicate: TPredicateProperties
- removeMe: () => void
  - - (): void
    - Returns void
- updateMe: (change: TPredicateProperties) => void
  - - (change: TPredicateProperties): void
    - Parameters
      - change: TPredicateProperties
      Returns void

Const useProjectionSubjectProperties

useProjectionSubjectProperties(projectionKey: string): { projectedSubject: TProjectionProperties; updateProjectionSubject: (updateProps: TProjectionPropertiesUpdatable) => void }

- Defined in src/lib/GabbyQueryProtocolContext/hooks/useProjectionSubjectProperties.ts:7
Parameters
- projectionKey: string
Returns { projectedSubject: TProjectionProperties; updateProjectionSubject: (updateProps: TProjectionPropertiesUpdatable) => void }
- projectedSubject: TProjectionProperties
- updateProjectionSubject: (updateProps: TProjectionPropertiesUpdatable) => void
  - - (updateProps: TProjectionPropertiesUpdatable): void
    - Parameters
      - updateProps: TProjectionPropertiesUpdatable
      Returns void

Const useProjectionSubjects

useProjectionSubjects(): { addProjectionItem: (projectionItem: TProjectionProperties) => string; projectableSubjects: IProjectableSubjectDictionary; projectionList: () => TProjectionDictionary; removeProjectionItem: (projectionKey: string) => void }

- Defined in src/lib/GabbyQueryProtocolContext/hooks/useProjectionSubjects.ts:5
Returns { addProjectionItem: (projectionItem: TProjectionProperties) => string; projectableSubjects: IProjectableSubjectDictionary; projectionList: () => TProjectionDictionary; removeProjectionItem: (projectionKey: string) => void }
- addProjectionItem: (projectionItem: TProjectionProperties) => string
  - - (projectionItem: TProjectionProperties): string
    - Parameters
      - projectionItem: TProjectionProperties
      Returns string
- projectableSubjects: IProjectableSubjectDictionary
- projectionList: () => TProjectionDictionary
  - - (): TProjectionDictionary
    - Returns TProjectionDictionary
- removeProjectionItem: (projectionKey: string) => void
  - - (projectionKey: string): void
    - Parameters
      - projectionKey: string
      Returns void

Index

Classes

Type aliases

Variables

Functions

Type aliases

TGabbyQueryProtocolContextType

Type declaration

operatorLabels: TPredicateOperatorLabels

projectionEditor: IProjectionEditor

subjectDictionary: IPredicateSubjectDictionary

addProjectionItem: function

Parameters

projectionItem: TProjectionProperties

Returns string

appendPredicate: function

Parameters

parentNodeId: string

node: TPredicateProperties

Returns string

getChildrenIds: function

Parameters

predicateId: string

Returns string[]

getJunctionById: function

Parameters

predicateId: string

Returns TPredicatePropertiesJunction

getOrderedProjectionList: function

Returns TProjectionDictionary

getPredicateById: function

Parameters

predicateId: string

Returns null | TPredicateNode

getProjectionItem: function

Parameters

projectionKey: string

Returns TProjectionProperties

makeEmptyPredicate: function

Returns TPredicateProperties

removePredicate: function

Parameters

predicateId: string

Returns void

removeProjectionItem: function

Parameters

projectionKey: string

Returns void

setConjunction: function

Parameters

predicateId: string

Returns void

setDisjunction: function

Parameters

predicateId: string

Returns void

updatePredicate: function

Parameters

predicateId: string

node: TPredicateNode

Returns void

updateProjectionSubject: function

Parameters

projectionKey: string

updateProps: TProjectionPropertiesUpdatable

Returns void

TPredicateJunctionOperator

TPredicateNode

TPredicateOperatorLabels

TPredicateProperties

Type declaration

operator: TPredicateOperator

subjectId: string

value: number | string

TPredicatePropertiesArrayValue

TPredicateSubjectWithId

TSerializedPredicateTree

TValueLabelList

Variables

Const GabbyQueryProtocolContext