@jigx/mdk
Version:
Jigx Mobile Development Kit - SDK for building Jigx applications
1,834 lines • 1.63 MB
JSON
{
"definitions": {
"ActionDefinition": {
"type": "object",
"properties": {
"action": {
"$ref": "#/definitions/ActionInBackgroundConfiguration",
"title": "Action",
"description": "Action to be performed"
},
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ActionParameterDefinition"
},
"propertyNames": {
"title": "Parameter Name",
"description": "Name of the parameter.",
"pattern": "^[$a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter or $\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
},
"title": "Parameters",
"description": "Parameters that you are using in your action."
},
"actionId": {
"$ref": "#/definitions/ActionIdDefinition"
}
},
"required": [
"action"
]
},
"ActionId": {
"type": "string",
"title": "Action Name"
},
"ActionIdDefinition": {
"type": "string",
"title": "Action Identifier",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
},
"ActionInBackgroundConfiguration": {
"anyOf": [
{
"$ref": "#/definitions/JAActionListInBackgroundConfig"
},
{
"$ref": "#/definitions/JAClearQueueInBackgroundConfig"
},
{
"$ref": "#/definitions/JAConfirmInBackgroundConfig"
},
{
"$ref": "#/definitions/JADeleteQueueCommandInBackgroundConfig"
},
{
"$ref": "#/definitions/JADeleteSyncScopeInBackgroundConfig"
},
{
"$ref": "#/definitions/JADeleteSyncStatusInBackgroundConfig"
},
{
"$ref": "#/definitions/JAInfoModalInBackgroundConfig"
},
{
"$ref": "#/definitions/JAExecuteActionInBackgroundConfig"
},
{
"$ref": "#/definitions/JAExecuteEntitiesInBackgroundConfig"
},
{
"$ref": "#/definitions/JAExecuteEntityInBackgroundConfig"
},
{
"$ref": "#/definitions/JAExecuteSqlInBackgroundConfig"
},
{
"$ref": "#/definitions/JAGenerateFileInBackgroundConfig"
},
{
"$ref": "#/definitions/JAGeneratePDFInBackgroundConfig"
},
{
"$ref": "#/definitions/JAGoBackInBackgroundConfig"
},
{
"$ref": "#/definitions/JAGoToInBackgroundConfig"
},
{
"$ref": "#/definitions/JAOpenMediaPickerInBackgroundConfig"
},
{
"$ref": "#/definitions/JAOpenUrlInBackgroundConfig"
},
{
"$ref": "#/definitions/JAOpenMapInBackgroundConfig"
},
{
"$ref": "#/definitions/JAPrintInBackgroundConfig"
},
{
"$ref": "#/definitions/JAResetStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JAResetCustomComponentStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JAResetJigStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JAResetSolutionStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JARetryQueueCommandInBackgroundConfig"
},
{
"$ref": "#/definitions/JASetActiveTabActionInBackgroundConfig"
},
{
"$ref": "#/definitions/JASetStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JAShareInBackgroundConfig"
},
{
"$ref": "#/definitions/JASetCustomComponentStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JASetJigStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JASetSolutionStateInBackgroundConfig"
},
{
"$ref": "#/definitions/JAStartSyncScopeInBackgroundConfig"
},
{
"$ref": "#/definitions/JASyncEntitiesInBackgroundConfig"
},
{
"$ref": "#/definitions/JAStopLocationSharingInBackgroundConfig"
},
{
"$ref": "#/definitions/JAStartLocationSharingInBackgroundConfig"
},
{
"$ref": "#/definitions/JAUpdateProfileInBackgroundConfig"
},
{
"$ref": "#/definitions/JAOpenAppSettingsInBackgroundConfig"
}
]
},
"ActionParameterDefinition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Parameter Type",
"description": "Type of the parameter is equivalent to type used in the datasource.\nFor example, in a SQL datasource these might be `DATE`, `INT`, `NVARCHAR` and so on.",
"pattern": "^=$|^[^=]",
"patternErrorMessage": "Expression is not allowed for this property"
},
"value": {
"$ref": "#/definitions/ParameterValue",
"title": "Parameter Value"
},
"default": {
"$ref": "#/definitions/ParameterValue",
"title": "Default Value",
"description": "The default value of the parameter if not explicitly set."
},
"required": {
"type": "boolean",
"title": "Is Required?",
"description": "Whether the parameter is required or optional."
}
},
"required": [
"type"
]
},
"AmountControl": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Value of amount control"
},
"initialValue": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Initial value of amount control"
},
"onChange": {
"$ref": "#/definitions/keg-action-in-background",
"description": "Action Keg component that will be triggered when value is changed"
},
"onDelete": {
"anyOf": [
{
"$ref": "#/definitions/JAExecuteEntityConfig"
},
{
"$ref": "#/definitions/JAExecuteEntitiesConfig"
}
],
"description": "If this property is set, trash symbol is displayed when the value is 1 or (min + 1)."
},
"minimum": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Limits the minimum number. Default is 0."
},
"maximum": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Limits the maximum number."
},
"step": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Step for increment/decrement. Default is 1."
},
"element": {
"type": "string",
"const": "amount-control",
"description": "Type of component"
}
},
"required": [
"element"
],
"title": "Amount"
},
"AmountControlBase": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Value of amount control"
},
"initialValue": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Initial value of amount control"
},
"onChange": {
"$ref": "#/definitions/keg-action-in-background",
"description": "Action Keg component that will be triggered when value is changed"
},
"onDelete": {
"anyOf": [
{
"$ref": "#/definitions/JAExecuteEntityConfig"
},
{
"$ref": "#/definitions/JAExecuteEntitiesConfig"
}
],
"description": "If this property is set, trash symbol is displayed when the value is 1 or (min + 1)."
},
"minimum": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Limits the minimum number. Default is 0."
},
"maximum": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Limits the maximum number."
},
"step": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Step for increment/decrement. Default is 1."
}
},
"title": "Amount"
},
"AnyValue": {
"anyOf": [
{
"$ref": "#/definitions/Primitive"
},
{
"$ref": "#/definitions/Expression"
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AnyValueNested"
}
},
{
"type": "array",
"items": {
"$ref": "#/definitions/AnyValueNested"
}
}
],
"title": "Value"
},
"AnyValueNested": {
"anyOf": [
{
"$ref": "#/definitions/Primitive"
},
{
"$ref": "#/definitions/Expression"
},
{
"type": "object",
"additionalProperties": {}
},
{
"type": "array",
"items": {}
}
],
"title": "Value"
},
"ArrayFilter": {
"type": "array",
"items": {
"$ref": "#/definitions/ListFilterItem"
},
"deprecationMessage": "Array is deprecated, use filter with data property instead.",
"deprecated": "Array is deprecated, use filter with data property instead."
},
"Authorized": {
"type": "object",
"properties": {
"owners": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/Email"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"title": "Owners",
"description": "Provide the email address of users who can interact with the data record. By default, the person creating the record."
},
"members": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/Email"
},
{
"$ref": "#/definitions/SolutionGroupId"
},
{
"$ref": "#/definitions/Expression"
}
]
}
},
{
"type": "null"
}
],
"title": "Members",
"description": "Provide the email address of users who can interact with the data record, and add the group name for groups."
}
},
"title": "Authorized",
"description": "Assign users and groups who can interact with the data record."
},
"AvatarAlign": {
"type": "string",
"enum": [
"left",
"right",
"center"
]
},
"AvatarElement": {
"type": "object",
"properties": {
"element": {
"type": "string",
"const": "avatar",
"description": "Type of element"
},
"text": {
"$ref": "#/definitions/TextValue",
"description": "Text displayed when uri is empty."
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Source of image displayed as avatar"
},
"onPress": {
"$ref": "#/definitions/keg-action-in-background",
"description": "Action Keg component that will be triggered by pressing on this button."
}
},
"required": [
"element",
"text"
],
"title": "Avatar",
"description": "Avatar"
},
"AvatarItemConfig": {
"type": "object",
"properties": {
"text": {
"$ref": "#/definitions/TextValue",
"description": "Text as placeholder in case of missing image"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Source of image displayed as avatar"
}
},
"required": [
"text"
],
"title": "Avatar"
},
"Axis": {
"type": "object",
"properties": {
"labels": {
"type": "object",
"properties": {
"format": {
"$ref": "#/definitions/TextFormatExpressions"
}
},
"description": "Labels of axis."
},
"isFirstLabelHidden": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "If true it doesn't display the first label (see isFirstTickHidden to hide also the line)"
},
"isFirstTickHidden": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Line and label will be hidden if true"
},
"isHidden": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Whole axis will be hidden if true"
},
"isLastLabelHidden": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "If true it doesn't display the last label (see isLastTickHidden to hide also line)"
},
"isLastTickHidden": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Line and label will be hidden if true"
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Maximum value displayed on axis"
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "Minimum value displayed on axis"
},
"minPadding": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "When no categories set, it will make 1% space on the left and right of the chart so the id doesn't start on the left or ends on the right edge exactly. Example: '0.02 (x-axis) and 0.05 (y-axis)'"
},
"tickAmount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
},
{
"$ref": "#/definitions/Expression"
}
],
"description": "You can specify how many ticks you want to display on axis. However, the final amount doesn't have to be exactly the same number as you pass into it.\n\nIt tries to find the best amount of ticks (near to what you passed) that the number will look great for.\n\nFor example, if the domain is 0-100 and you want 4 ticks (0, 33.33, 66.66, 100) it will round up to 6 to give you \"pretty\" numbers (0, 20, 40, 60, 80, 100). However, if you set ticks to 3 it will honor that and you'll have 0, 50, and 100."
}
}
},
"BasicColor": {
"type": "string",
"enum": [
"color1",
"color2",
"color3",
"color4",
"color5",
"color6",
"color7",
"color8",
"color9",
"color10",
"color11",
"color12",
"color13",
"color14"
]
},
"BorderStyleDefinition": {
"anyOf": [
{
"type": "string",
"const": "solid"
},
{
"type": "string",
"const": "transparent"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"BottomSheetConfiguration": {
"type": "object",
"properties": {
"width": {
"anyOf": [
{
"type": "string",
"const": "small"
},
{
"type": "string",
"const": "medium"
},
{
"type": "string",
"const": "large"
},
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"position": {
"anyOf": [
{
"type": "string",
"const": "left"
},
{
"type": "string",
"const": "middle"
},
{
"type": "string",
"const": "right"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"snapPoints": {
"type": "array",
"items": {
"type": [
"number",
"string"
]
}
},
"snapIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"isPanDownToCloseEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"isDetached": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"backdrop": {
"type": "object",
"properties": {
"isVisible": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"opacity": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"appearsOnIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"disappearsOnIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
}
}
},
"initialValue": {
"$ref": "#/definitions/JigId"
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/BottomSheetJigChild"
}
}
}
},
"BottomSheetJigChild": {
"type": "object",
"properties": {
"width": {
"anyOf": [
{
"type": "string",
"const": "small"
},
{
"type": "string",
"const": "medium"
},
{
"type": "string",
"const": "large"
},
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"position": {
"anyOf": [
{
"type": "string",
"const": "left"
},
{
"type": "string",
"const": "middle"
},
{
"type": "string",
"const": "right"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"snapPoints": {
"type": "array",
"items": {
"type": [
"number",
"string"
]
}
},
"snapIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"isPanDownToCloseEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"isDetached": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"backdrop": {
"type": "object",
"properties": {
"isVisible": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"opacity": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"appearsOnIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"disappearsOnIndex": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/Expression"
}
]
}
}
},
"jigId": {
"$ref": "#/definitions/JigId"
},
"inputs": {
"$ref": "#/definitions/JigInputs"
},
"instanceId": {
"$ref": "#/definitions/InstanceId"
}
},
"required": [
"jigId"
]
},
"ButtonOptionsStyle": {
"type": "object",
"properties": {
"isDanger": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Is Danger?",
"description": "Change style of the button to error"
},
"isDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Is Disabled?",
"description": "Disables the button when `true`"
},
"isPrimary": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Is Primary?",
"description": "Change style of the button to primary. Default is true."
},
"isSecondary": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Is Secondary?",
"description": "Change style of the button to secondary"
}
}
},
"CallbackActions": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/keg-action-in-background"
},
"propertyNames": {
"title": "Action Identifier",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
}
},
"CarouselItemOptions": {
"anyOf": [
{
"$ref": "#/definitions/jc-custom-component"
},
{
"$ref": "#/definitions/JCImageOnCarouselConfig"
},
{
"$ref": "#/definitions/JCCardOnDefaultConfig"
}
]
},
"Category": {
"type": "string",
"enum": [
"unknown",
"analytics",
"business",
"communications",
"consulting",
"field-services",
"finances",
"health",
"human-resources",
"logistics",
"management",
"miscellaneous",
"operations",
"personal",
"sales"
],
"title": "Category"
},
"Chart": {
"type": "object",
"properties": {
"isAnimated": {
"type": "boolean",
"description": "If true, chart animates series"
},
"width": {
"type": "number",
"description": "Width of chart"
},
"height": {
"type": "number",
"description": "Height of chart"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
}
},
"title": "Expression",
"description": "Expects a `string` of length 2 or more.\nValue MUST start with `=` followed by 1 or more characters, with at least 1 being non-whitespace.\nSee [Expression](https://docs.jigx.com/expressions)",
"pattern": "^(((\\|)|(>[-+]?))[\\s]*)?=[\\s]*[\\S][\\S\\s]*$",
"patternErrorMessage": "Value MUST start with `=` followed by 1 or more characters, with at least 1 being non-whitespace."
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
},
{
"$ref": "#/definitions/TextLocale"
}
],
"title": "Text Value"
},
"format": {
"$ref": "#/definitions/TextFormatExpressions",
"title": "Format"
}
},
"required": [
"text"
],
"title": "Text With Format"
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Locale Identifier"
},
"defaultMessage": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Default Message"
},
"values": {
"$ref": "#/definitions/TextLocaleValues",
"title": "Locale Values"
}
},
"required": [
"id"
],
"title": "Text Locale",
"description": "Text that can be translated"
}
],
"description": "Title of chart"
},
"subtitle": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
}
},
"title": "Expression",
"description": "Expects a `string` of length 2 or more.\nValue MUST start with `=` followed by 1 or more characters, with at least 1 being non-whitespace.\nSee [Expression](https://docs.jigx.com/expressions)",
"pattern": "^(((\\|)|(>[-+]?))[\\s]*)?=[\\s]*[\\S][\\S\\s]*$",
"patternErrorMessage": "Value MUST start with `=` followed by 1 or more characters, with at least 1 being non-whitespace."
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
},
{
"$ref": "#/definitions/TextLocale"
}
],
"title": "Text Value"
},
"format": {
"$ref": "#/definitions/TextFormatExpressions",
"title": "Format"
}
},
"required": [
"text"
],
"title": "Text With Format"
},
{
"type": "object",
"properties": {
"horizontalAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"verticalAlign": {
"type": "string",
"enum": [
"top",
"center",
"bottom"
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Locale Identifier"
},
"defaultMessage": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Default Message"
},
"values": {
"$ref": "#/definitions/TextLocaleValues",
"title": "Locale Values"
}
},
"required": [
"id"
],
"title": "Text Locale",
"description": "Text that can be translated"
}
],
"description": "Subtitle of chart"
}
},
"description": "General options of chart (width, height, etc)"
},
"ChartColor": {
"type": "string",
"enum": [
"color1",
"color2",
"color3",
"color4",
"color5",
"color6",
"color7",
"color8",
"color9",
"transparent",
"negative",
"positive"
]
},
"ChartOptions": {
"type": "object",
"properties": {
"series": {
"type": "array",
"items": {
"$ref": "#/definitions/Series"
},
"description": "Data for pies of a chart."
},
"chart": {
"$ref": "#/definitions/Chart",
"description": "General options of chart (width, height, etc)"
},
"yAxis": {
"$ref": "#/definitions/YAxis",
"description": "Options for yAxis"
},
"xAxis": {
"$ref": "#/definitions/XAxis",
"description": "Options for xAxis"
},
"legend": {
"$ref": "#/definitions/Legend",
"description": "Legend of chart"
},
"plotOptions": {
"$ref": "#/definitions/PlotOptions",
"description": "Options of plot"
}
},
"required": [
"series"
]
},
"ColorCondition": {
"type": "object",
"properties": {
"when": {
"anyOf": [
{
"$ref": "#/definitions/Expression"
},
{
"type": "boolean"
}
]
},
"color": {
"$ref": "#/definitions/ColorValue"
}
},
"required": [
"when",
"color"
],
"title": "Color Condition"
},
"ColorDefinition": {
"type": "object",
"properties": {
"background": {
"$ref": "#/definitions/ColorHex"
},
"onBackground": {
"$ref": "#/definitions/ColorHex"
}
},
"required": [
"background",
"onBackground"
]
},
"ColorHex": {
"type": "string",
"title": "Color Hex Code",
"pattern": "^#[0-9a-fA-F]{6}$",
"patternErrorMessage": "Must be a valid hex color code (eg. #995544)"
},
"ColorValue": {
"anyOf": [
{
"type": "string",
"const": "primary"
},
{
"$ref": "#/definitions/BasicColor"
},
{
"$ref": "#/definitions/StatusColor"
},
{
"$ref": "#/definitions/Expression"
}
]
},
"ColorValueOrConditions": {
"anyOf": [
{
"$ref": "#/definitions/ColorValue"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/ColorCondition"
}
}
],
"description": "Color definition can be either a list of conditions or a single color value (primary, color1-N, positive, negative, warning)."
},
"ColumnConfig": {
"$ref": "#/definitions/ColumnConfigReference",
"title": "Column configuration"
},
"ColumnConfigReference": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Key",
"description": "Specifies a unique identifier for the column, used to reference the column\u2019s data.",
"pattern": "^=$|^[^=]",
"patternErrorMessage": "Expression is not allowed for this property"
},
"columnDefinitionId": {
"$ref": "#/definitions/ColumnDefinitionId",
"title": "Column Definition Id",
"description": "The identifier of the column definition to be used."
}
},
"required": [
"id"
],
"title": "Column Configuration Reference",
"description": "References a reusable configuration for a column, providing consistency across multiple columns."
},
"ColumnDefinition": {
"type": "object",
"properties": {
"width": {
"anyOf": [
{
"$ref": "#/definitions/ColumnWidth"
},
{
"type": "number"
}
],
"title": "Width",
"description": "Customizes the width of columns to improve visibility and fit specific content, offering flexibility in the table layout."
},
"header": {
"$ref": "#/definitions/jc-table-header-cell",
"title": "Header",
"description": "Defines the key for the column header."
},
"cell": {
"$ref": "#/definitions/jc-table-cell",
"title": "Cell",
"description": "Sets the key for the individual cells in the column."
},
"footer": {
"$ref": "#/definitions/JCTableFooterCellConfig",
"title": "Footer",
"description": "Defines the key for the column footer."
}
},
"title": "Column Definition"
},
"ColumnDefinitionId": {
"type": "string",
"description": "Reference to columnDefinition"
},
"ColumnWidth": {
"type": "string",
"enum": [
"small",
"regular",
"large"
]
},
"ComponentColor": {
"anyOf": [
{
"$ref": "#/definitions/BasicColor"
},
{
"$ref": "#/definitions/StatusColor"
},
{
"type": "string",
"const": "primary"
}
]
},
"ComponentDefaultChild": {
"anyOf": [
{
"$ref": "#/definitions/jc-avatar"
},
{
"$ref": "#/definitions/jc-bar-chart"
},
{
"$ref": "#/definitions/jc-button"
},
{
"$ref": "#/definitions/JCCardOnCustomComponentConfig"
},
{
"$ref": "#/definitions/jc-carousel"
},
{
"$ref": "#/definitions/jc-countdown"
},
{
"$ref": "#/definitions/jc-count-up"
},
{
"$ref": "#/definitions/jc-entity"
},
{
"$ref": "#/definitions/jc-expander"
},
{
"$ref": "#/definitions/jc-form"
},
{
"$ref": "#/definitions/jc-icon"
},
{
"$ref": "#/definitions/JCImageOnCustomComponentConfig"
},
{
"$ref": "#/definitions/jc-interactive-image"
},
{
"$ref": "#/definitions/jc-line-chart"
},
{
"$ref": "#/definitions/JCListItemStandAloneConfig"
},
{
"$ref": "#/definitions/JCListOnCustomComponentConfig"
},
{
"$ref": "#/definitions/jc-location"
},
{
"$ref": "#/definitions/jc-pie-chart"
},
{
"$ref": "#/definitions/jc-progress-bar"
},
{
"$ref": "#/definitions/jc-stage"
},
{
"$ref": "#/definitions/jc-stepper"
},
{
"$ref": "#/definitions/jc-text"
},
{
"$ref": "#/definitions/jc-trend"
},
{
"$ref": "#/definitions/JCVideoPlayerOnJigConfig"
},
{
"$ref": "#/definitions/jc-view"
},
{
"$ref": "#/definitions/JCWebViewOnDefaultConfig"
},
{
"$ref": "#/definitions/jc-custom-component"
},
{
"$ref": "#/definitions/jc-widgets"
}
]
},
"ComponentDefinition": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ComponentType"
},
"componentId": {
"$ref": "#/definitions/ComponentId"
},
"children": {
"type": "array",
"items": {},
"title": "Child Components"
}
},
"required": [
"type",
"children"
]
},
"ComponentId": {
"type": "string",
"title": "Component Name"
},
"ComponentIdDefinition": {
"type": "string",
"title": "Component Identifier",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
},
"ComponentInputs": {
"$ref": "#/definitions/InputExpressions"
},
"ComponentType": {
"type": "string",
"const": "component.default",
"title": "Component Type",
"description": "Unique types of Components."
},
"ConfirmModal": {
"type": "object",
"properties": {
"title": {
"$ref": "#/definitions/TextValue",
"title": "Title",
"description": "First text line on confirm modal"
},
"description": {
"$ref": "#/definitions/TextValue",
"title": "Description",
"description": "Description displayed under title"
},
"confirm": {
"$ref": "#/definitions/TextValue",
"title": "Confirm Text",
"description": "Text displayed on confirm button"
},
"cancel": {
"$ref": "#/definitions/TextValue",
"title": "Cancel Text",
"description": "Text displayed on cancel button"
}
},
"required": [
"title"
]
},
"ConversionDefinition": {
"type": "object",
"properties": {
"property": {
"type": "string",
"title": "Property",
"description": "The name of the property to process the conversion on.",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Value MUST start with alpha, end with alpha/numeric, permits `_` or `-` in middle."
},
"from": {
"$ref": "#/definitions/ConvertFrom",
"title": "From",
"description": "Is one of the values `buffer`, `base64`, `data-uri`, or `local-uri` specifying the type of data to convert from."
},
"to": {
"$ref": "#/definitions/ConvertTo",
"title": "To",
"description": "Is one of the values `buffer`, `base64`, `data-uri`, or `local-uri` specifying the type of data to convert to."
},
"localFilename": {
"type": "string",
"title": "Local Filename",
"description": "(Optional) The name of the local file when converting to local-uri.",
"pattern": "^=$|^[^=]",
"patternErrorMessage": "Expression is not allowed for this property"
},
"convertHeicToJpg": {
"type": "boolean",
"title": "Convert HEIC to JPG",
"description": "(Optional) If true, will convert HEIC images to JPG."
}
},
"required": [
"property",
"from",
"to"
],
"title": "ConversionDefinition"
},
"ConvertFrom": {
"type": "string",
"enum": [
"buffer",
"local-uri",
"base64",
"data-uri"
]
},
"ConvertTo": {
"type": "string",
"enum": [
"buffer",
"local-uri",
"base64",
"data-uri"
]
},
"DataLabel": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
},
"required": [
"isEnabled"
]
},
"DataTablesDefinition": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/FreeFormTableDefinition"
},
{
"type": "null"
}
]
},
"propertyNames": {
"title": "Data Table Name",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
},
"title": "Data Tables"
},
"DatabaseId": {
"type": "string",
"const": "default",
"title": "Database Name",
"description": "Name of the database.\nFor now, must be named `default`."
},
"DatasourceDefinition": {
"anyOf": [
{
"$ref": "#/definitions/SqliteDatasourceDefinition"
},
{
"$ref": "#/definitions/StaticDatasourceDefinition"
},
{
"$ref": "#/definitions/SystemDatasourceDefinition"
}
]
},
"DatasourceId": {
"type": "string",
"title": "Datasource Name",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$",
"patternErrorMessage": "Invalid format\n- The first character has to start with a letter\n- The name can contain alphanumeric or symbols '-' and '\\_'\n- The name cannot contain spaces\n- The name cannot end with special characters\n- The length must be between 2-50 characters"
},
"DatePickerMode": {
"type": "string",
"enum": [
"date",
"time",
"datetime"
]
},
"Dependencies": {
"type": "object",
"properties": {
"mobileApp": {
"type": "string",
"title": "Mobile App Version",
"description": "Defines mobile app build version which is compatible with yaml configuration.",
"pattern": "^=$|^[^=]",
"patternErrorMessage": "Expression is not allowed for this property"
}
},
"required": [
"mobileApp"
]
},
"DynamicEntityName": {
"type": "string",
"title": "Dynamic Entity Name"
},
"DynamicFileEntityName": {
"type": "string",
"title": "Dynamic File entity"
},
"DynamicFileProviderSyncEntity": {
"type": "object",
"properties": {
"entity": {
"anyOf": [
{
"$ref": "#/definitions/DynamicFileEntityName"
},
{
"$ref": "#/definitions/Expression"
}
],
"title": "Dynamic File ent