marketpane.creocortex.com

{
  "type": "object",
  "properties": {
    "panel_id": {
      "type": "string",
      "description": "Stable panel id."
    },
    "title": {
      "type": "string"
    },
    "hidden": {
      "type": "boolean"
    },
    "collapsed": {
      "type": "boolean"
    },
    "config": {
      "type": "object",
      "description": "Renderer-specific view configuration, merged onto the panel's current recognized fields and validated against the panel's active renderer. See x-renderer-config-schemas for each renderer."
    },
    "expected_revision": {
      "type": "number",
      "description": "Revision this call assumes the workspace is currently at. Omitting it skips the concurrency check; a mismatch fails with error \"revision_conflict\"."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Replaying the same key returns the original result instead of applying the change twice; reusing a key for a materially different request fails with error \"idempotency_conflict\"."
    }
  },
  "required": [
    "panel_id"
  ],
  "x-renderer-config-schemas": {
    "table": {
      "type": "object",
      "description": "How a results table panel presents a screener run: displayed columns, computed columns, sort, grouping, conditional formatting, page size, and the chart panel it is bound to. Only the properties named are changed; every other property is left as it was.",
      "properties": {
        "columns": {
          "type": "array",
          "description": "Displayed columns, in display order."
        },
        "computed_columns": {
          "type": "array",
          "description": "Formula-derived columns available to display."
        },
        "sort": {
          "type": "object",
          "description": "The active sort key and direction, or null for none."
        },
        "grouping": {
          "type": "object",
          "description": "The active grouping key, or null for none."
        },
        "formatting_rules": {
          "type": "array",
          "description": "Conditional formatting rules."
        },
        "page_size": {
          "type": "number",
          "description": "Rows per page. Defaults when omitted."
        },
        "chart_panel_id": {
          "type": "string",
          "description": "The chart panel this table drives, or null."
        }
      }
    },
    "chart_grid": {
      "type": "object",
      "description": "How a chart panel draws its series. Only the properties named are changed; every other property of the chart is left exactly as it was. What the chart shows -- instrument, timeframe, range, comparisons -- is a source concern, set through bind_panel_source.",
      "properties": {
        "candle_type": {
          "type": "string",
          "enum": [
            "candlestick",
            "ohlc_bar",
            "line",
            "area",
            "heikin_ashi",
            "hollow_candle"
          ],
          "description": "How each bar is drawn."
        },
        "scale": {
          "type": "string",
          "enum": [
            "linear",
            "logarithmic"
          ],
          "description": "Price axis scale."
        },
        "session": {
          "type": "string",
          "enum": [
            "regular",
            "extended",
            "continuous"
          ],
          "description": "Which trading session the bars cover. Changing it changes which bars exist, so it invalidates cached bars and study output."
        },
        "price_adjustment": {
          "type": "string",
          "enum": [
            "adjusted",
            "split_adjusted",
            "unadjusted"
          ],
          "description": "The basis every price on this chart is stated on: \"adjusted\" (splits and dividends), \"split_adjusted\" (splits only) or \"unadjusted\" (as traded). It is not a display setting -- it restates every downstream price: bars, study values, annotation anchors and every read of this chart. Changing it invalidates cached bars and study output."
        },
        "studies": {
          "type": "array",
          "description": "Study instances on the chart, in display order. Pane placement is derived from the catalog and is not a caller choice.",
          "items": {
            "type": "object",
            "required": [
              "id",
              "catalog_item_id",
              "params",
              "pane",
              "order",
              "enabled"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable instance ID, `study_`-prefixed."
              },
              "catalog_item_id": {
                "type": "string"
              },
              "params": {
                "type": "object",
                "description": "Fully resolved, catalog defaults included."
              },
              "pane": {
                "enum": [
                  "price_overlay",
                  "sub_pane"
                ]
              },
              "order": {
                "type": "integer",
                "minimum": 0
              },
              "enabled": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "heatmap": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string"
        },
        "colorScale": {
          "type": "string"
        },
        "groupBy": {
          "type": "string"
        }
      }
    },
    "scatter_plot": {
      "type": "object",
      "properties": {
        "xAxis": {
          "type": "string"
        },
        "yAxis": {
          "type": "string"
        },
        "colorBy": {
          "type": "string"
        }
      }
    }
  }
}