Kinetic Event Emporium

Experts' Corner
6

Here’s an md doc generated from events.json schema using json-schema-for-humans. Not bad for a first pass.

events.md

snip:

5.1. The Events Items Schema

Title: The Events Items Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ id No string No - The Id Schema
- description No string No - The Description Schema
- trigger No Combination No - The Trigger Schema
+ actions No array No - -

5.1.1. Property id

Title: The Id Schema
Type string
Required Yes

5.1.2. Property description

Title: The Description Schema
Type string
Required No

5.1.3. Property trigger

Title: The Trigger Schema
Type combining
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - The type Schema
- target No string No - The target Schema
+ hook No enum (of string) No - The hook Schema
- columns No array of string No - The columns Schema
All of(Requirement)
item 0
item 1
5.1.3.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.3.1.1. If (type = “DataView”)
Type object
Required No
Additional properties Any type allowed
5.1.3.1.1.1. The following properties are required
  • target
5.1.3.2. Property item 1
Type object
Required No
Additional properties Any type allowed
5.1.3.2.1. If (type = “EpBinding”)
Type object
Required No
Additional properties Any type allowed
5.1.3.2.1.1. The following properties are required
  • target
5.1.3.3. Property type

Title: The type Schema
Type enum (of string)
Required Yes

Must be one of:

  • “Control”
  • “Window”
  • “EpBinding”
  • “DataView”
  • “DataTable”
  • “Grid”
  • “Page”
  • “Tree”
  • “Event”
5.1.3.4. Property target

Title: The target Schema
Type string
Required No
5.1.3.5. Property hook

Title: The hook Schema
Type enum (of string)
Required Yes

Must be one of:

  • “onClick”
  • “onLoad”
  • “columnChanging”
  • “columnChanged”
  • “rowChanged”
  • “rowChanging”
  • “viewChanged”
  • “viewChanging”
  • “onEpPanelCardCollapsed”
  • “onEpPanelCardExpanded”
  • “onSearch”
  • “epOnClickAdd”
  • “onDataDropDownClick”
  • “onInit”
  • “onBlur”
  • “onClosing”
  • “onClosed”
  • “onTreeNodeExpand”
  • “onTreeNodeSelectionChange”
  • “onTreeDropItem”
  • “onTreeDragEnter”
  • “onTreeBeforeExpandAll”
  • “onBroadcastData”
  • “onItemClick”
  • “onLinkClick”
  • “before”
  • “after”
5.1.3.6. Property columns

Title: The columns Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Columns Items Schema -
5.1.3.6.1. The Columns Items Schema

Title: The Columns Items Schema
Type string
Required No

5.1.4. Property actions
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Defined in #/definitions/eventAction
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - The type Schema
- param No object or array of object No - The Param Schema
- value No string, boolean, number or null No - The Value Schema
- option No object No - The Option Schema
- epBinding No string No - The EpBinding Schema
- dataview No string No - The Dataview Schema
- dataTable No string No - The Datatable Schema
- onSuccess No array No In #/definitions/successResult The actionResult Schema
- onError No array No In #/definitions/errorResult The actionResult Schema
- onEmpty No array No In #/definitions/emptyResult The actionResult Schema
- condition No string No - The Condition Schema
- variable No string No - The variable Schema
- onOk No array No In #/definitions/okResult The actionResult Schema
- onCancel No array No In #/definitions/cancelResult The actionResult Schema
- onYes No array No In #/definitions/yesResult The actionResult Schema
- onNo No array No In #/definitions/noResult The actionResult Schema
- onRetry No array No In #/definitions/retryResult The actionResult Schema
- onNone No array No In #/definitions/noneResult The actionResult Schema
- onAbort No array No In #/definitions/abortResult The actionResult Schema
- onIgnore No array No In #/definitions/ignoreResult The actionResult Schema
- expression No string No - The Expression Schema
3 Likes