Skip to content
This repository has been archived by the owner on Aug 4, 2020. It is now read-only.

Change order / layout of victory components on front page #9

Closed
eastridge opened this issue Apr 11, 2016 · 4 comments
Closed

Change order / layout of victory components on front page #9

eastridge opened this issue Apr 11, 2016 · 4 comments

Comments

@eastridge
Copy link

Suggested layout:

Column 1:

  • VictoryCore
  • VictoryAnimation

Column 2:

  • VictoryChart
  • (indented list of chart subcomponents)

Column 3:

  • VictoryPie
  • (list of components coming soon, greyed out with "coming soon" text)
@paulathevalley
Copy link
Contributor

paulathevalley commented Apr 28, 2016

I am working on terminology for each column and could use a sanity check.

If there is not already a system in place, perhaps Chart and Pie are both Figures, and each component that a Figure wraps is called a Layer.

Column 1: Core
Column 2: Chart Figure
Column 3: Other Figure

For clarity, here is each list:

Core:

  • VictoryAnimation
  • VictoryLabel

Chart Figure:

  • VictoryChart and its layers:
    • VictoryArea
    • VictoryAxis
    • VictoryBar
    • VictoryLine
    • VictoryScatter

Other Figures:

  • VictoryPie
  • Other Figure Layers (?):
    • VictoryTooltip [coming soon]
    • VictoryConstraints [coming soon]
    • VictoryStack [coming soon]
    • VictoryGroup [coming soon]

Reading:
A layered grammar of graphics and its implementation in ggplot2

@paulathevalley
Copy link
Contributor

paulathevalley commented Apr 28, 2016

If that's too esoteric, then we could go explicit, which maps to where everything lives on github:

Core:

  • VictoryAnimation
  • VictoryLabel

Chart:

  • VictoryChart:
    • VictoryArea
    • VictoryAxis
    • VictoryBar
    • VictoryLine
    • VictoryScatter
    • VictoryConstraints [coming soon]
    • VictoryGroup
    • VictoryStack
    • VictoryTooltip [coming soon]

Pie:

  • VictoryPie

@boygirl
Copy link
Contributor

boygirl commented Apr 29, 2016

VictoryStack and VictoryGroup are already built, and documented within the VictoryArea and VictoryBar docs (where they are useful / supported), but maybe they need their own docs sections?

@paulathevalley
Copy link
Contributor

paulathevalley commented Apr 29, 2016

Ah! I see. I would only break them out into their own docs sections if either:

a.) there are plans to integrate them with more chart layers/sub-components (making it tedious/repetitious to add the same docs to each chart layer/sub-component)

b.) users are confused, or users want more specific, in-depth information on VictoryStack or VictoryGroup

Otherwise I would leave them where they are. :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants