Aura tab |
---|
summary | Application Constants |
---|
params | JTdCJTIydGl0bGUlMjIlM0ElMjJBcHBsaWNhdGlvbiUyMENvbnN0YW50cyUyMiU3RA== |
---|
|
The default.constants.js file is located in the apq-c3-custom/js folder within the web app directory of the root install directory of your Apliqo Application server.This file stores default constants for the Apliqo UX application. The 2023.05 version includes the following new application constants: Aura tab |
---|
summary | Advanced Options |
---|
params | JTdCJTIydGl0bGUlMjIlM0ElMjJBZHZhbmNlZCUyME9wdGlvbnMlMjIlN0Q= |
---|
|
Card Config
"showSummary": Show selected cell summary in the widget header Code Block |
---|
{
"cardConfig": {
"showSummary": true
}
} |

"sandboxEnabled": Enable sandbox functionality Code Block |
---|
{
"toolbar": {
"sandboxEnabled": true
}
} |
 Chart Options
"type":select chart type: area,areaspline,bar,bubble,column,columnpyramid,funnel,gauge,heatmap,line,pie,polygon,pyramid,scatter,series,solidgauge,spline,treemap,waterfall "alignTicks": align ticks on multi axis chart "showAxes":configure whether to show the axes initially "inverted": invert chart axis "backgroundColor": background color or gradient for the outer chart area "plotBackgroundColor": chart plot background color "margin": chart plot margin. e.g 0,0,0,0 | i.e. top,left,bottom,right "className": chart Custom CSS Class Name, allowing unique CSS styling for each chart "zoomType": Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy Code Block |
---|
{
"chartOptions": {
"chart": {
"type": "areaspline",
"alignTicks": true,
"showAxes": true,
"inverted": true,
"backgroundColor": "#006345FF",
"plotBackgroundColor": "#0021f2FF",
"margin": [
5,
5,
5,
5
],
"className": "",
"zoomType": "xy"
}
}
} |

"enabled": enable or disable the legend "align": horizontal alignment of the legend box within the chart area "verticalAlign": vertical alignment of the legend box "layout": layout of the legend items "reversed": select whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object "rtl": decide whether to show the symbol on the right side of the text rather than the left side "floating": when the legend is floating, the plot area ignores it and is allowed to be placed below it "backgroundColor": background color of the legend "borderColor": color of the drawn border around the legend "borderWidth": width of the drawn border around the legend "borderRadius": border corner radius of the legend "symbolWidth": pixel width of the legend item symbol. When the squareSymbol option is set, this defaults to the symbolHeight, otherwise 16 "symbolHeight": pixel height of the symbol for series types that use a rectangle in the legend. Defaults to the font size of legend items "symbolPadding": pixel padding between the legend item symbol and the legend item text "itemWidth": width for each legend item. By default the items are laid out successively "itemMarginTop": pixel top margin for each legend item "itemMarginBottom": pixel bottom margin for each legend item "padding": inner padding of the legend box "className": CSS class name to apply to the legend group "valueDecimals": For a color axis with data classes, how many decimals to render in the legend. The default preserves the decimals of the range numbers "width": width of the legend box. If a number is set, it translates to pixels "x": x offset of the legend relative to its horizontal alignment "y": vertical offset of the legend relative to it's vertical alignment "itemStyle": "fontSize": CSS styles for each legend item in font size "fontWeight": CSS styles for each legend item in font weight "color": CSS styles for each legend item text color "textOverflow": CSS styles for each legend item text overflow "itemHoverStyle": "color": CSS styles for each legend item in hover mode Code Block |
---|
"legend": {
"enabled": true,
"align": "center",
"verticalAlign": "top",
"layout": "vertical",
"reversed": true,
"rtl": true,
"floating": true,
"backgroundColor": "#b5ffd9FF",
"borderColor": "#004ca1FF",
"borderWidth": 3,
"borderRadius": 10,
"symbolWidth": 5,
"symbolHeight": 5,
"symbolPadding": 5,
"itemWidth": 150,
"itemMarginTop": 5,
"itemMarginBottom": 5,
"padding": 3,
"className": "",
"valueDecimals": 2,
"width": 150,
"x": 5,
"y": 5,
"itemStyle": {
"fontSize": "10",
"fontWeight": "normal",
"color": "#590022FF",
"textOverflow": ""
},
"itemHoverStyle": {
"color": "#007e96FF"
}
} |

"enabled": enable or disable the tooltip "shared": when the tooltip is shared, the entire plot area will capture mouse movement or touch event "split": split the tooltip into one label per series, with the header close to the axis. This is recommended over shared tooltips for charts with multiple line series, generally making them easier to read "followPointer": choose whether the tooltip should follow the mouse as it moves across columns "animation": enable or disable animation of the tooltip "backgroundColor": background color or gradient for the tooltip "borderColor": color of the tooltip border "borderRadius": radius of the rounded border corners "borderWidth": pixel width of the tooltip border "className": CSS class name to apply to the tooltip's container div, allowing unique CSS styling for each chart "valueDecimals": how many decimals to show in each series' y value. This is overridable in each series' tooltip options object "valuePrefix": string to prepend to each series' y value. Overridable in each series' tooltip options object "valueSuffix": string to append to each series' y value. Overridable in each series' tooltip options object "xDateFormat": format for the date in the tooltip header if the X axis is a datetime axis. e.g '%Y-%m-%d "style": "fontSize": CSS styles for each tooltip item in font size "color": CSS styles for each tooltip item text color "cursor": CSS styles for each tooltip item cursor "whiteSpace": CSS styles for each tooltip item text white-space Code Block |
---|
"tooltip": {
"enabled": true,
"shared": true,
"split": true,
"followPointer": false,
"animation": false,
"backgroundColor": "#00c574FF",
"borderColor": "#00693dFF",
"borderRadius": 4,
"borderWidth": 2,
"className": "",
"valuePrefix": "",
"valueSuffix": "",
"xDateFormat": "",
"style": {
"fontSize": "15",
"color": "#003a6eFF",
"cursor": "pointer",
"whiteSpace": "normal"
}
}
|

"animation": enable or disable the initial animation when a series is displayed "className": additional class name to apply to the series' graphical elements "clip": disable this option to allow series rendering in the whole plotting area "color": main color of the series "fillColor": fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity "fillOpacity": fill opacity for the area. When you set an explicit fillColor, the fillOpacity is not applied "stacking": choose whether to stack the values of each series on top of each other "cursor": you can set the cursor to 'pointer' if you have click events attached to the series "dashStyle": name of the dash style to use for the graph, or for some series types the outline of each shape "linecap": line cap used for line ends and line joins on the graph "lineWidth": pixel width of the graph line "negativeColor": color for the parts of the graph or points that are below the threshold "pointInterval": no x values are given for the points in a series, pointInterval defines the interval of the x values "pointIntervalUnit": on datetime series, this allows for setting the pointInterval to irregular time units, day, month and year "pointPlacement": in a column chart, when pointPlacement is 'on', the point will not create any padding of the X axis "pointStart": if no x values are given for the points in a series, pointStart defines on what value to start Code Block |
---|
"plotOptions": {
"series": {
"animation": true,
"className": "",
"clip": true,
"color": "#2b0059FF",
"fillColor": "#3e0082FF",
"fillOpacity": 10,
"stacking": "normal",
"cursor": "default",
"dashStyle": "Solid",
"linecap": "round",
"lineWidth": 2,
"negativeColor": "#e30042FF",
"pointInterval": 5,
"pointIntervalUnit": "",
"pointPlacement": "on",
"pointStart": 3
}
} |

"type": select type: line, spline, area, areaspline, bar, column "color": define series color "dashStyle": dash style. e.g | dot | dash | solid "lineWidth": pixel width of the graph line "cursor": define cursor style "xAxis": when using dual or multiple x axes, this number defines which xAxis the particular series is connected to "yAxis": when using dual or multiple y axes, this number defines which yAxis the particular series is connected to "showInLegend": choose whether to display this particular series or series type in the legend "showPercentage": specify whether you wish to see % formatting "dataLabels": "enabled": display data value as labels in the chart "format": format data label value {point.y:,.0f} "marker": "enabled": display marker "symbol": select marker symbol: square, circle, triangle "fillColor": fill color of the point marker "radius": radius of the point marker Code Block |
---|
"series": [
{
"type": "areaspline",
"color": "#8a00b5FF",
"dashStyle": "ShortDot",
"lineWidth": 3,
"cursor": "pointer",
"xAxis": 1,
"yAxis": 1,
"showInLegend": false,
"showPercentage": true,
"dataLabels": {
"enabled": true,
"format": "{point.y:.2f} "
},
"marker": {
"enabled": true,
"symbol": "square",
"fillColor": "#680087FF",
"radius": 2
}
}, |

"title" "enabled": enable /disable axis title, showing next to the axis line "text": yAxis Name "style": "color": set title color "align": alignment of the title relative to the axis values. Possible values are low, middle or high.
"labels" "enabled": enable or disable the axis labels "color": set label color "align": what part of the string the given position is anchored to "distance": label's pixel distance from the perimeter of the plot area "format": labels format e.g. {point.y:,.0f} "padding": pixel padding for axis labels, to ensure white space between them "rotation": rotation of the labels in degrees. When undefined, the autoRotation option takes precedence "step": show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label "x": x position offset of all labels relative to the tick positions on the axis. Defaults to -15 for left axis, 15 for right axis "y": y position offset of all labels relative to the tick positions on the axis "crosshair" "className": class name for the crosshair, especially as a hook for styling "color": color of the crosshair. Defaults to #cccccc for numeric and datetime axes "dashStyle": dash style for the crosshair "snap": choose whether the crosshair should snap to the point or follow the pointer independent of points "width": pixel width of the crosshair. Defaults to 1 for numeric or datetime axes, and for one category width for category axe
"type": type of axis. Can be one of linear, logarithmic, datetime, category or treegrid. "alignTicks": when using multiple axis, the ticks of two or more opposite axes will automatically be aligned "allowDecimals": choose whether to allow decimals in this axis' ticks "visible": choose whether axis, including axis title, line, ticks and labels, should be visible "reversed": reverse the axis so that the highest number is closest to the origin "zoomEnabled": choose whether to zoom axis. If chart.zoomType is set, the option allows to disable zooming on an individual axis "gridLineColor": color of the grid lines extending the ticks across the plot area "gridLineDashStyle": dash or dot style of the grid lines "gridLineWidth": width of the grid lines extending the ticks across the plot area "alternateGridColor": when using an alternate grid color, a band is painted across the plot area between every other grid line "tickInterval": interval of the tick marks in axis units "tickAmount": amount of ticks to draw on the axis. This option overrides the tickPixelInterval option "tickmarkPlacement": for categorized axes only. If on the tick mark is placed in the center of the category, if between the tick mark is placed between categories "floor": lowest allowed value for automatically computed axis extremes "min": minimum value of the axis. If null the min value is automatically calculated "max": maximum value of the axis. If null the max value is automatically calculated "softMin": soft minimum for the axis. If the series data minimum is greater than this, the axis will stay at this minimum, but if the series data minimum is lower, the axis will flex to show all "softMax": soft maximum for the axis. If the series data maximum is less than this, the axis will stay at this maximum, but if the series data maximum is higher, the axis will flex to show all "angle": in a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right "className": class name that opens for styling the axis by CSS
Code Block |
---|
"yAxis": [
{
"title": {
"enabled": true,
"text": "test",
"style": {
"color": "#0d0078FF"
},
"align": "middle"
},
"labels": {
"enabled": true,
"style": {
"color": "#124f00FF"
},
"align": "left",
"distance": "10",
"format": "",
"padding": 6,
"rotation": 5,
"step": 5,
"x": 3,
"y": 3
},
"crosshair": {
"className": "",
"color": "#2e0059FF",
"dashStyle": "Dash",
"snap": false,
"width": 4
},
"type": "datetime",
"alignTicks": true,
"allowDecimals": false,
"visible": false,
"reversed": true,
"zoomEnabled": false,
"gridLineColor": "#16004fFF",
"gridLineDashStyle": "ShortDot",
"gridLineWidth": 2,
"alternateGridColor": "#5aa100FF",
"tickInterval": 2,
"tickAmount": 10,
"tickmarkPlacement": "on",
"floor": "",
"min": 0,
"max": 100000,
"softMin": 0,
"softMax": 100000,
"angle": "0"
}
] |
 Aura tab |
---|
summary | Rest API Paths |
---|
params | JTdCJTIydGl0bGUlMjIlM0ElMjJSZXN0JTIwQVBJJTIwUGF0aHMlMjIlN0Q= |
---|
|
The settings.json file is located in the WEB-INF/config folder within the web app directory of the root install directory of your Apliqo Application server. This file stores control parameters used by the Apliqo UX application. The 2023.05 version includes an update to the allowedRestPaths array: Code Block |
---|
allowedRestPaths": [
{
"path": "/ExecuteProcessWithReturn",
"method": "POST"
},
{
"path": "/Users.*",
"method": "Get"
},
{
"path": "/Groups.*",
"method": "Get"
},
{
"path": "/Users.*",
"method": "PATCH"
},
{
"path": "/Cubes(.*)",
"method": "GET"
},
{
"path": "/Cubes(.*)",
"method": "POST"
},
{
"path": "/Cubes(.*)",
"method": "PATCH"
},
{
"path": "/Cubes(.*)",
"method": "DELETE"
} ,
{
"path": "/Dimensions(.*)",
"method": "GET"
},
{
"path": "/Dimensions(.*)",
"method": "PUT"
},
{
"path": "/Dimensions(.*)",
"method": "POST"
},
{
"path": "/Dimensions.*",
"method": "PATCH"
},
{
"path": "/Dimensions(.*)",
"method": "DELETE"
},
{
"path": "/Cellsets(.*)",
"method": "POST"
},
{
"path": "/Cellsets(.*)",
"method": "DELETE"
},
{
"path": "/\\$metadata.*",
"method": "GET"
},
{
"path": "/Threads.*",
"method": "GET"
},
{
"path": "/Threads.*",
"method": "PATCH"
},
{
"path": "/Threads(.*)",
"method": "POST"
},
{
"path": "/ExecuteMDX(.*)",
"method": "POST"
},
{
"path": "/ExecuteMDXSetExpression(.*)",
"method": "POST"
},
{
"path": "/ExecuteMDXSetExpression(.*)",
"method": "GET"
},
{
"path": "/Annotations.*",
"method": "GET"
},
{
"path": "/Annotations(.*)",
"method": "DELETE"
},
{
"path": "/ErrorLogFiles(.*)",
"method": "GET"
}
], |
|