DLI EPCDC32 Object Model Reference
|
object | renderer/ |
Object representing renderer capabilities and functions |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample uom
library read command:
print(uom.dump(uom.renderer))
⇒
Sample CLI write command:
uom set renderer "{\"known_scales\":{\"linear\":\"linear\",\"log\":\"logarithmic\"},\"known_marker_types\":{\"circle\":\"Filled circle\",\"square\":\"Filled square\",\"otriangle\":\"Empty triangle\",\"osquare\":\"Empty square\",\"triangle\":\"Filled triangle\",\"rhombus\":\"Filled rhombus\",\"orhombus\":\"Empty rhombus\",\"plus\":\"Plus\",\"dot\":\"Dot\",\"rotriangle\":\"Empty inverse triangle\",\"rtriangle\":\"Filled inverse triangle\",\"ocircle\":\"Empty circle\",\"cross\":\"Cross\"},\"known_plot_styles\":{\"lines\":\"Lines only\",\"steps\":\"Step lines\",\"bezier\":\"Bezier smoothed lines\",\"linespoints\":\"Lines and markers\",\"impulses\":\"Vertical lines\",\"dots\":\"Small dots\",\"csplines\":\"Spline smoothed lines\",\"points\":\"Markers only\",\"boxes\":\"Boxes\",\"acsplines\":\"Approximated spline smoothed lines\"},\"known_line_types\":{\"dashed\":\"Dashed\",\"dotted\":\"Dotted\",\"solid\":\"Solid\"},\"known_image_formats\":{\"svg\":\"SVG\",\"gif\":\"GIF\",\"jpeg\":\"JPEG\",\"png\":\"PNG\"},\"known_axes\":{\"x2y2\":\"X2, Y2\",\"x2y1\":\"X2, Y1\",\"x1y1\":\"X1, Y1\",\"x1y2\":\"X1, Y2\"}}"
call | renderer/draw_plot/ |
Generate an image with axes and data plotted on them |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample uom
library invocation:
print(uom.dump(uom.renderer.draw_plot("png",7680,1536,{time_format="%Y-%m-%d, %H:%M:%S",x1={max=null,min=null,mtics=null,softmax=null,softmin=null,tics=null},x2={max=null,min=null,mtics=null,softmax=null,softmin=null,tics=1},y1={max=null,min=null,mtics=null,softmax=null,softmin=null,tics=2},y2={max=null,min=null,mtics=1,softmax=null,softmin=null,tics=null}},{{"Plot",{{"Line #1",{{3,8},{5,14},{7,7},{9,1},{14,1},{21,3},{24,2},{25,false},{28,19},{29,false},{31,5},{33,4},{38,4},{39,false},{42,5},{46,1}}},{"Line #2",{{2,6},{3,7}}},{"Line #3",{{2,3},{9,2},{13,1},{15,4}}},{"Line #4",{{7,3},{10,8},{14,false},{15,false},{17,false}}},{"Line #5",{{1,3},{4,1},{7,false},{9,1},{13,5},{15,4},{16,1},{19,1}}}},{axes="x2y1",color="8985B2",marker="plus",size=4,style="steps",type="dotted",width=512},{{quantity="ratio",unit="%"},{quantity="illuminance",unit="fc"}}},{"Plot",{{"Line #1",{{1,1},{2,3}}},{"Line #2",{{2,4},{5,1},{6,false}}}},{axes="x1y2",color="0B3B4B",marker="cross",size=3,style="boxes",type="dotted",width=5120},{{quantity="temperature",unit="K"},{quantity="illuminance",unit="lx"}}}})))
⇒
"<binary data of type image/jpeg>"
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/renderer/draw_plot/',auth=auth,headers=headers,json=<...>).json())
⇒
'<binary data of type image/jpeg>'
string | renderer/draw_plot/arguments: 1/ |
Image format |
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
number | renderer/draw_plot/arguments: 2/ |
The width of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
number | renderer/draw_plot/arguments: 3/ |
The height of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
object | renderer/draw_plot/arguments: 4/ |
Properties of the plot |
This object does not correspond to an actual resource.
This object contains the following items:
time_format | Custom time format, if any |
x1 | X1 axis settings |
x2 | X2 axis settings |
y1 | Y1 axis settings |
y2 | Y2 axis settings |
See also Properties: Custom time format, if any
See also Properties: X1 axis settings
See also Properties: X2 axis settings
See also Properties: Y1 axis settings
See also Properties: Y2 axis settings
array | renderer/draw_plot/arguments: 5/ |
Plot data lines |
This array does not correspond to an actual resource.
This array contains Line elements.
See also Lines: Line
string | renderer/draw_plot/results: 1/ |
The content type of the generated image |
This string does not correspond to an actual resource.
string | renderer/draw_plot/results: 2/ |
Generated image data |
The value contains content type data.
This string does not correspond to an actual resource.
sum (optional string) | renderer/draw_plot/arguments: 4/time_format/ |
Custom format to display time in, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Default | Use default time format | |
string | Custom time format | Custom format to display time in |
object | renderer/draw_plot/arguments: 4/x1/ |
Configuration for X1 axis |
This object does not correspond to an actual resource.
This object contains the following items:
min | Minimum, if any |
max | Maximum, if any |
softmin | Soft minimum, if any |
softmax | Soft maximum, if any |
tics | Major tick interval, if any |
mtics | Minor ticks per major tick, if any |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/min/ |
Minimum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The maximum value is derived from data and the soft maximum | |
number | Minimum | Minimum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/max/ |
Maximum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The minimum value is derived from data and the soft minimum | |
number | Maximum | Maximum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft maximum defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft minimum defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/tics/ |
The interval, in value units, between major ticks of the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The tick interval is derived from data and size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x1/mtics/ |
The number of minor ticks between two major ticks, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | There are no minor ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
object | renderer/draw_plot/arguments: 4/x2/ |
Configuration for X2 axis |
This object does not correspond to an actual resource.
This object contains the following items:
min | Minimum, if any |
max | Maximum, if any |
softmin | Soft minimum, if any |
softmax | Soft maximum, if any |
tics | Major tick interval, if any |
mtics | Minor ticks per major tick, if any |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/min/ |
Minimum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The maximum value is derived from data and the soft maximum | |
number | Minimum | Minimum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/max/ |
Maximum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The minimum value is derived from data and the soft minimum | |
number | Maximum | Maximum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft maximum defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft minimum defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/tics/ |
The interval, in value units, between major ticks of the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The tick interval is derived from data and size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/x2/mtics/ |
The number of minor ticks between two major ticks, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | There are no minor ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
object | renderer/draw_plot/arguments: 4/y1/ |
Configuration for Y1 axis |
This object does not correspond to an actual resource.
This object contains the following items:
min | Minimum, if any |
max | Maximum, if any |
softmin | Soft minimum, if any |
softmax | Soft maximum, if any |
tics | Major tick interval, if any |
mtics | Minor ticks per major tick, if any |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/min/ |
Minimum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The maximum value is derived from data and the soft maximum | |
number | Minimum | Minimum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/max/ |
Maximum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The minimum value is derived from data and the soft minimum | |
number | Maximum | Maximum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft maximum defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft minimum defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/tics/ |
The interval, in value units, between major ticks of the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The tick interval is derived from data and size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y1/mtics/ |
The number of minor ticks between two major ticks, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | There are no minor ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
object | renderer/draw_plot/arguments: 4/y2/ |
Configuration for Y2 axis |
This object does not correspond to an actual resource.
This object contains the following items:
min | Minimum, if any |
max | Maximum, if any |
softmin | Soft minimum, if any |
softmax | Soft maximum, if any |
tics | Major tick interval, if any |
mtics | Minor ticks per major tick, if any |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/min/ |
Minimum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The maximum value is derived from data and the soft maximum | |
number | Minimum | Minimum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/max/ |
Maximum value to display on the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The minimum value is derived from data and the soft minimum | |
number | Maximum | Maximum value to display on the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft maximum defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | No soft minimum defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/tics/ |
The interval, in value units, between major ticks of the axis, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Automatic | The tick interval is derived from data and size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
sum (optional number) | renderer/draw_plot/arguments: 4/y2/mtics/ |
The number of minor ticks between two major ticks, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | There are no minor ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
tuple | renderer/draw_plot/arguments: 5/N/2/N/ |
Point to plot |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | X |
2 | Y, if any |
number | renderer/draw_plot/arguments: 5/N/2/N/1/ |
X coordinate to plot |
This number does not correspond to an actual resource.
sum (variant) | renderer/draw_plot/arguments: 5/N/2/N/2/ |
Y coordinate to plot, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant false | None | Data for this X position is absent | |
number | Y | Y coordinate to plot |
object | renderer/draw_plot/arguments: 5/N/4/1/ |
The quantity and unit for X axis |
This object does not correspond to an actual resource.
This object contains the following items:
quantity | X axis quantity |
unit | X axis unit |
string | renderer/draw_plot/arguments: 5/N/4/1/quantity/ |
The quantity for X axis |
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/4/1/unit/ |
The unit for X axis |
The value is subject to the following constraints: known quantities[X axis quantity].units[the value]
This string does not correspond to an actual resource.
object | renderer/draw_plot/arguments: 5/N/4/2/ |
The quantity and unit for Y axis |
This object does not correspond to an actual resource.
This object contains the following items:
quantity | Y axis quantity |
unit | Y axis unit |
string | renderer/draw_plot/arguments: 5/N/4/2/quantity/ |
The quantity for Y axis |
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/4/2/unit/ |
The unit for Y axis |
The value is subject to the following constraints: known quantities[Y axis quantity].units[the value]
This string does not correspond to an actual resource.
tuple | renderer/draw_plot/arguments: 5/N/ |
Plot data line settings |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Title |
2 | Plot data |
3 | Style |
4 | Plotted quantities and units |
string | renderer/draw_plot/arguments: 5/N/1/ |
Plot line title |
This string does not correspond to an actual resource.
array | renderer/draw_plot/arguments: 5/N/2/ |
Data to plot |
This array does not correspond to an actual resource.
This array contains Plot point elements.
See also Plot data: Plot point
object | renderer/draw_plot/arguments: 5/N/3/ |
Style of the plot line |
This object does not correspond to an actual resource.
This object contains the following items:
style | Line style |
type | Line type |
color | Line color |
width | Line width |
marker | Marker type |
size | Marker size |
axes | Base axes |
string | renderer/draw_plot/arguments: 5/N/3/style/ |
The style of the line |
The value is subject to the following constraints: plot styles[the value]
This string does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/3/type/ |
The type of the line |
The value is subject to the following constraints: line types[the value]
This string does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/3/color/ |
The color of the line |
The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$
This string does not correspond to an actual resource.
number | renderer/draw_plot/arguments: 5/N/3/width/ |
The width of the line |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/3/marker/ |
The type of the marker |
The value is subject to the following constraints: marker types[the value]
This string does not correspond to an actual resource.
number | renderer/draw_plot/arguments: 5/N/3/size/ |
The size of the markers |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
string | renderer/draw_plot/arguments: 5/N/3/axes/ |
The axes on which the line should be plotted. Units of lines plotted on the same axes must match |
The value is subject to the following constraints: axes[the value]
This string does not correspond to an actual resource.
tuple | renderer/draw_plot/arguments: 5/N/4/ |
Quantities and units to be plotted |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | X axis quantity and unit |
2 | Y axis quantity and unit |
See also Plotted quantities and units: X axis quantity and unit
See also Plotted quantities and units: Y axis quantity and unit
call | renderer/draw_pie_meter/ |
Generate a multi-sector meter image with an arrow indicating value |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample CLI invocation:
uom invoke "renderer/draw_pie_meter" "\"svg\"" "3072" "3072" "{\"decimals\":0,\"scale\":\"linear\",\"sectors\":[{\"value\":68,\"name\":\"Low\",\"color\":\"48BC3D\"},{\"value\":82,\"name\":\"Medium\",\"color\":\"1C063D\"},{\"value\":108,\"name\":\"High\",\"color\":\"855276\"}],\"min_value\":48,\"color\":\"9CF17B\"}" "91"
⇒
"<binary data of type image/png>"
Sample JS request
invocation:
request.post({url:"renderer/draw_pie_meter/",body:["svg",7680,15360,{"decimals":2,"scale":"linear","sectors":[{"value":77,"name":"Low","color":"EC7FC1"},{"value":88,"name":"High","color":"E8CF8C"}],"min_value":56,"color":"E7BD72"},58]});
⇒
"<binary data of type image/jpeg>"
string | renderer/draw_pie_meter/arguments: 1/ |
Image format |
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
number | renderer/draw_pie_meter/arguments: 2/ |
The width of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
number | renderer/draw_pie_meter/arguments: 3/ |
The height of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
object | renderer/draw_pie_meter/arguments: 4/ |
Properties of the meter |
This object does not correspond to an actual resource.
This object contains the following items:
color | Arrow color |
scale | Display scale |
decimals | Decimals |
min_value | Minimum value |
sectors | Meter sectors |
See also Properties: Arrow color
See also Properties: Display scale
See also Properties: Decimals
See also Properties: Minimum value
See also Properties: Meter sectors
number | renderer/draw_pie_meter/arguments: 5/ |
Meter value to display |
This number does not correspond to an actual resource.
See also Draw a pie meter: Value quantity and unit
string | renderer/draw_pie_meter/results: 1/ |
The content type of the generated image |
This string does not correspond to an actual resource.
string | renderer/draw_pie_meter/results: 2/ |
Generated image data |
The value contains content type data.
This string does not correspond to an actual resource.
string | renderer/draw_pie_meter/arguments: 4/color/ |
The color of the meter arrow |
The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$
This string does not correspond to an actual resource.
string | renderer/draw_pie_meter/arguments: 4/scale/ |
The scale function to use for display |
The value is subject to the following constraints: plot scales[the value]
This string does not correspond to an actual resource.
number | renderer/draw_pie_meter/arguments: 4/decimals/ |
Number of decimal places to show in displayed value |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
number | renderer/draw_pie_meter/arguments: 4/min_value/ |
The minimum value to be displayed on the meter |
This number does not correspond to an actual resource.
array | renderer/draw_pie_meter/arguments: 4/sectors/ |
Parameters of meter sectors |
This array does not correspond to an actual resource.
This array contains Sector parameters elements.
object | renderer/draw_pie_meter/arguments: 4/sectors/N/ |
Parameters of a meter sector |
This object does not correspond to an actual resource.
This object contains the following items:
name | Name |
value | Maximum value |
color | Color |
string | renderer/draw_pie_meter/arguments: 4/sectors/N/name/ |
The name of the sector |
This string does not correspond to an actual resource.
number | renderer/draw_pie_meter/arguments: 4/sectors/N/value/ |
The maximum value for the sector |
This number does not correspond to an actual resource.
string | renderer/draw_pie_meter/arguments: 4/sectors/N/color/ |
The color of the sector |
The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$
This string does not correspond to an actual resource.
object | renderer/draw_pie_meter/arguments: 6/ |
The quantity and unit for value |
This object does not correspond to an actual resource.
This object contains the following items:
quantity | Value quantity |
unit | Value unit |
string | renderer/draw_pie_meter/arguments: 6/quantity/ |
The quantity for value |
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
string | renderer/draw_pie_meter/arguments: 6/unit/ |
The unit for value |
The value is subject to the following constraints: known quantities[value quantity].units[the value]
This string does not correspond to an actual resource.
call | renderer/draw_message/ |
Generate an image with a message in its center |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample curl
invocation:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"svg\",256,1920,\"Message!\"]" "http://192.168.0.100/restapi/renderer/draw_message/"
⇒
"<binary data of type image/jpeg>"
Sample uom
library invocation:
print(uom.dump(uom.renderer.draw_message("gif",3840,1024,"Message!")))
⇒
"<binary data of type image/svg+xml>"
string | renderer/draw_message/arguments: 1/ |
Image format |
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
number | renderer/draw_message/arguments: 2/ |
The width of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
number | renderer/draw_message/arguments: 3/ |
The height of the image |
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
This number does not correspond to an actual resource.
string | renderer/draw_message/arguments: 4/ |
Message text |
This string does not correspond to an actual resource.
string | renderer/draw_message/results: 1/ |
The content type of the generated image |
This string does not correspond to an actual resource.
string | renderer/draw_message/results: 2/ |
Generated image data |
The value contains content type data.
This string does not correspond to an actual resource.
map | renderer/known_plot_styles/ |
Known plot styles |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_plot_styles/"
⇒
Sample uom
library read command:
print(uom.dump(uom.renderer.known_plot_styles))
⇒
string | renderer/known_plot_styles/S/ |
Name of plot style |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample JS request
read command (note that _name
is a variable):
request.get({url:"renderer/known_plot_styles/"+_name+"/"},function(error,response,body) {console.log(body)});
⇒
"Bezier smoothed lines"
Sample CLI read command (note that name
is a variable):
uom get "renderer/known_plot_styles/${name}"
⇒
"Approximated spline smoothed lines"
map | renderer/known_scales/ |
Known plot scales |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "renderer/known_scales"
⇒
{"linear":"linear","log":"logarithmic"}
Sample JS request
read command:
request.get({url:"renderer/known_scales/"},function(error,response,body) {console.log(body)});
⇒
{"linear":"linear","log":"logarithmic"}
string | renderer/known_scales/S/ |
Name of plot scale |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name
is a variable):
uom get "renderer/known_scales/${name}"
⇒
"linear"
Sample uom
library read command (note that _name
is a variable):
print(uom.dump(uom.renderer.known_scales[_name]))
⇒
"logarithmic"
map | renderer/known_line_types/ |
Known line types |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "renderer/known_line_types"
⇒
{"dashed":"Dashed","dotted":"Dotted","solid":"Solid"}
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_line_types/"
⇒
{"dashed":"Dashed","dotted":"Dotted","solid":"Solid"}
string | renderer/known_line_types/S/ |
Name of line type |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name
is a variable):
uom get "renderer/known_line_types/${name}"
⇒
"Dashed"
Sample JS request
read command (note that _name
is a variable):
request.get({url:"renderer/known_line_types/"+_name+"/"},function(error,response,body) {console.log(body)});
⇒
"Dotted"
map | renderer/known_marker_types/ |
Known marker types |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_marker_types/"
⇒
Sample CLI read command:
uom get "renderer/known_marker_types"
⇒
string | renderer/known_marker_types/S/ |
Name of marker type |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name
is a variable):
uom get "renderer/known_marker_types/${name}"
⇒
"Dot"
Sample curl
read command (note that :name
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_marker_types/:name/"
⇒
"Filled square"
map | renderer/known_axes/ |
Known axis combinations |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_axes/"
⇒
{"x2y2":"X2, Y2","x2y1":"X2, Y1","x1y1":"X1, Y1","x1y2":"X1, Y2"}
Sample uom
library read command:
print(uom.dump(uom.renderer.known_axes))
⇒
{x1y1="X1, Y1",x1y2="X1, Y2",x2y1="X2, Y1",x2y2="X2, Y2"}
string | renderer/known_axes/S/ |
Name of axis combination |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample JS request
read command (note that _name
is a variable):
request.get({url:"renderer/known_axes/"+_name+"/"},function(error,response,body) {console.log(body)});
⇒
"X1, Y1"
Sample curl
read command (note that :name
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/renderer/known_axes/:name/"
⇒
"X2, Y2"
map | renderer/known_image_formats/ |
Known image formats |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample JS request
read command:
request.get({url:"renderer/known_image_formats/"},function(error,response,body) {console.log(body)});
⇒
{"svg":"SVG","gif":"GIF","jpeg":"JPEG","png":"PNG"}
Sample CLI read command:
uom get "renderer/known_image_formats"
⇒
{"svg":"SVG","gif":"GIF","jpeg":"JPEG","png":"PNG"}
string | renderer/known_image_formats/S/ |
Name of image format |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name
is a variable):
uom get "renderer/known_image_formats/${name}"
⇒
"PNG"
Sample requests
read command (note that _name
is a variable):
print(requests.get('http://192.168.0.100/restapi/renderer/known_image_formats/'+_name+'/',auth=auth,headers=headers).json())
⇒
'GIF'