Era.Common.DataDefinition.Reports.Format

Description

Definition of formatting for reports displayed as table or as chart.

Properties

Name JsonSchemaType Description
color enum of Era.Common.DataDefinition.Reports.Format_Color Color format.
data_bar boolean If true, color background data bar is used in the table. Currently not supported, do not use.
icons enum of Era.Common.DataDefinition.Reports.Format_Icons Used icons.
maximum integer Maximum value, used to determine the higher border of the color scale or icon scale.
minimum integer Minimum value, used to determine the lower border of the color scale or icon scale.
style enum of Era.Common.DataDefinition.Reports.Format_Style Deprecated, do not use.
value enum of Era.Common.DataDefinition.Reports.Format_Value Determines interpretation of the data as relative/absolute value.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Reports.Report_Rendering_Chart_Series
Era.Common.DataDefinition.Reports.Report_Rendering_Chart_Statistics
Era.Common.DataDefinition.Reports.Report_Rendering_Table_Column
Era.Common.DataDefinition.Symbol.SymbolDefinition

JsonSchema

{
    "title": "Era.Common.DataDefinition.Reports.Format",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Reports.Format"
    ],
    "properties": {
        "Era.Common.DataDefinition.Reports.Format": {
            "$ref": "#/definitions/Format"
        }
    },
    "definitions": {
        "Format": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "color": {
                    "enum": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7
                    ]
                },
                "data_bar": {
                    "type": "boolean"
                },
                "icons": {
                    "enum": [
                        0,
                        1,
                        2,
                        3,
                        4
                    ]
                },
                "maximum": {
                    "type": "integer"
                },
                "minimum": {
                    "type": "integer"
                },
                "style": {
                    "enum": [
                        0,
                        1,
                        2,
                        3
                    ]
                },
                "value": {
                    "enum": [
                        0,
                        1,
                        2
                    ]
                }
            }
        }
    }
}