Document type hierarchy?

[tbenst]

As part of trying to understand #420, I went to console:

Click for full output

help?> table

search: table mutable struct ismutable coeftable CoefTable iswritable isimmutable Patchable bytesavailable

  No documentation found.

  Summary
  ≡≡≡≡≡≡≡≡≡

  mutable struct Compose.Table <: Compose.ContainerPromise

  Fields
  ≡≡≡≡≡≡≡≡

  children      :: Matrix{Vector{Context}}
  x_focus       :: UnitRange{Int64}
  y_focus       :: UnitRange{Int64}
  x_prop        :: Union{Nothing, Vector{Float64}}
  y_prop        :: Union{Nothing, Vector{Float64}}
  aspect_ratio  :: Union{Nothing, Float64}
  fixed_configs :: Vector{T} where T
  units         :: Union{Nothing, UnitBox}
  order         :: Int64
  withjs        :: Bool
  withoutjs     :: Bool

  Supertype Hierarchy
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  Compose.Table <: Compose.ContainerPromise <: Compose.Container <: Compose.ComposeNode <: Any

I'm not sure how to learn more about Table, ContainerPromise, Container, and ComposeNode.

Something like the diagrams type reference documentation that explains how the pieces fit together would be phenomenal! Right now it's a bit hard to figure how things fit together, even though I can appreciate that the overall architecture looks really tidy :)

[Mattriks]

I started expanding the Compose docs in #303, and it's an ongoing process 😀.
To learn more, you can find examples of the outer constructors of those types in Gadfly.jl e.g. in Gadfly

• table is used by Geom.subplot_grid
• ctxpromise() is widely used in the text-related Guides to setup the possibility of horizontal or vertical text (if orientation=:auto), and in render_discrete_key() to setup a discrete key with an unknown number of columns.
• Later, Guide.layout_guides also uses table, which uses an optimization algorithm to decide among all the possibilities which one maximizes the plot space, under the constraint that the text (or key) needs to fit into the absolute plot area.

Point 3 is known as the "table layout problem".