API Documentation

These docs are directly generated from our source code docstrings.

• subgrounds package
  • Subpackages
    • subgrounds.pagination package
      • Submodules
      • Module contents
    • subgrounds.subgraph package
      • Submodules
      • Module contents
  • Submodules
    • subgrounds.client module
      • get_schema()
      • query()
    • subgrounds.dash_wrappers module
      • Refreshable
      • Graph
      • DataTable
      • AutoUpdate
    • subgrounds.dataframe_utils module
      • gen_columns()
      • fmt_cols()
      • DataFrameColumns
      • columns_of_selections()
      • df_of_json()
    • subgrounds.plotly_wrappers module
      • Figure
      • TraceWrapper
      • Scatter
      • Pie
      • Bar
      • Heatmap
      • Contour
      • Table
      • Box
      • Violin
      • Histogram
      • Histogram2d
      • Histogram2dContour
      • Ohlc
      • Candlestick
      • Waterfall
      • Funnel
      • Indicator
      • Scatter3d
      • Surface
      • Scattergeo
      • Choropleth
      • Scattermapbox
      • Choroplethmapbox
      • Densitymapbox
      • Scatterpolar
      • Barpolar
      • Sunburst
      • Treemap
      • Icicle
      • Sankey
      • Parcoords
      • Parcats
      • Carpet
      • Scattercarpet
      • Contourcarpet
    • subgrounds.query module
      • InputValue
      • VariableDefinition
      • Argument
      • Selection
      • Query
      • Fragment
      • Document
      • DataRequest
      • selections_of_object()
      • input_value_of_argument()
      • arguments_of_field_args()
    • subgrounds.schema module
      • BaseModel
      • TypeRef
      • TypeMeta
      • SchemaMeta
    • subgrounds.subgrounds module
      • store_schema()
      • load_schema()
      • subgraph_slug()
      • Subgrounds
    • subgrounds.transform module
      • select_data()
      • RequestTransform
      • DocumentTransform
      • TypeTransform
      • LocalSyntheticField
      • SplitTransform
    • subgrounds.utils module
      • flatten()
      • identity()
      • fst()
      • snd()
      • intersection()
      • rel_complement()
      • sym_diff()
      • union()
      • filter_none()
      • loop_generator()
      • repeat()
      • extract_data()
      • flatten_dict()
      • contains_list()
      • default_header()
      • user_agent()
  • Module contents
    • FieldPath
    • Subgraph
    • Subgrounds
      • Subgrounds.headers
      • Subgrounds.global_transforms
      • Subgrounds.subgraphs
      • Subgrounds.from_pg_key()
      • Subgrounds.load()
      • Subgrounds.load_subgraph()
      • Subgrounds.load_api()
      • Subgrounds.mk_request()
      • Subgrounds.execute()
      • Subgrounds.execute_iter()
      • Subgrounds.query_json()
      • Subgrounds.query_json_iter()
      • Subgrounds.query_df()
      • Subgrounds.query_df_iter()
      • Subgrounds.query()
      • Subgrounds.query_iter()
    • SyntheticField
      • SyntheticField.STRING
      • SyntheticField.INT
      • SyntheticField.FLOAT
      • SyntheticField.BOOL
      • SyntheticField.default_of_type()
      • SyntheticField.constant()
      • SyntheticField.datetime_of_timestamp()
      • SyntheticField.map()