Spaces:
Paused
Paused
powerbi / docs /developer_docs_versioned_docs /version-6.1.0 /api /schemas /annotationlayer.Schema.json
| { | |
| "schema": { | |
| "properties": { | |
| "annotationType": { | |
| "description": "Type of annotation layer", | |
| "enum": ["FORMULA", "INTERVAL", "EVENT", "TIME_SERIES"], | |
| "type": "string" | |
| }, | |
| "color": { | |
| "description": "Layer color", | |
| "nullable": true, | |
| "type": "string" | |
| }, | |
| "descriptionColumns": { | |
| "description": "Columns to use as the description. If none are provided, all will be shown.", | |
| "items": { "type": "string" }, | |
| "type": "array" | |
| }, | |
| "hideLine": { | |
| "description": "Should line be hidden. Only applies to line annotations", | |
| "nullable": true, | |
| "type": "boolean" | |
| }, | |
| "intervalEndColumn": { | |
| "description": "Column containing end of interval. Only applies to interval layers", | |
| "nullable": true, | |
| "type": "string" | |
| }, | |
| "name": { "description": "Name of layer", "type": "string" }, | |
| "opacity": { | |
| "description": "Opacity of layer", | |
| "enum": ["", "opacityLow", "opacityMedium", "opacityHigh", null], | |
| "nullable": true, | |
| "type": "string" | |
| }, | |
| "overrides": { | |
| "additionalProperties": { "nullable": true }, | |
| "description": "which properties should be overridable", | |
| "nullable": true, | |
| "type": "object" | |
| }, | |
| "show": { "description": "Should the layer be shown", "type": "boolean" }, | |
| "showLabel": { | |
| "description": "Should the label always be shown", | |
| "nullable": true, | |
| "type": "boolean" | |
| }, | |
| "showMarkers": { | |
| "description": "Should markers be shown. Only applies to line annotations.", | |
| "type": "boolean" | |
| }, | |
| "sourceType": { | |
| "description": "Type of source for annotation data", | |
| "enum": ["", "line", "NATIVE", "table"], | |
| "type": "string" | |
| }, | |
| "style": { | |
| "description": "Line style. Only applies to time-series annotations", | |
| "enum": ["dashed", "dotted", "solid", "longDashed"], | |
| "type": "string" | |
| }, | |
| "timeColumn": { | |
| "description": "Column with event date or interval start date", | |
| "nullable": true, | |
| "type": "string" | |
| }, | |
| "titleColumn": { | |
| "description": "Column with title", | |
| "nullable": true, | |
| "type": "string" | |
| }, | |
| "value": { | |
| "description": "For formula annotations, this contains the formula. For other types, this is the primary key of the source object." | |
| }, | |
| "width": { | |
| "description": "Width of annotation line", | |
| "minimum": 0, | |
| "type": "number" | |
| } | |
| }, | |
| "required": ["name", "show", "showMarkers", "value"], | |
| "type": "object", | |
| "title": "AnnotationLayer" | |
| }, | |
| "schemaType": "response" | |
| } | |