@graphenedata/cli 0.0.3 → 0.0.5

package/dist/docs/data_apps/components/charts/sparkline.md

@@ -1,68 +0,0 @@
----
-title: Sparkline
-description: Display a compact visual representation of a single metric over time.
----
-
-Use sparklines to display a compact visual representation of a single metric over time or a continuous range.
-
-
-**Example:**
-
-```markdown
-<Sparkline 
-    data="sales_by_date" 
-    dateCol=date 
-    valueCol=sales 
-/>
-```
-
-## Examples
-
-### Connected Sparkline
-
-```html
-<Sparkline data="sales_by_date" dateCol=date valueCol=sales type=bar  valueFmt=eur dateFmt=mmm connectGroup=mysparkline/>
-<Sparkline data="sales_by_date" dateCol=date valueCol=sales type=area color=maroon valueFmt=eur dateFmt=mmm connectGroup=mysparkline/>
-<Sparkline data="sales_by_date" dateCol=date valueCol=sales type=line color=purple valueFmt=eur dateFmt=mmm connectGroup=mysparkline/>
-```
-
-## Options
-
-### Data
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| data | Query name, wrapped in curly braces | true | query name | - |
-| dateCol | Categorical column to use for the x-axis | true | column name | - |
-| valueCol | Numeric column to use for the y-axis | true | column name | - |
-| type | Chart type for sparkline | false | ['line', 'area', 'bar'] | "line" |
-| emptySet | Sets behaviour for empty datasets. Can throw an error, a warning, or allow empty. When set to 'error', empty datasets will block builds in `build:strict`. Note this only applies to initial page load - empty datasets caused by input component changes (dropdowns, etc.) are allowed. | false | ['error', 'warn', 'pass'] | "error" |
-| emptyMessage | Text to display when an empty dataset is received - only applies when `emptySet` is 'warn' or 'pass', or when the empty dataset is a result of an input component change (dropdowns, etc.). | false | string | "No records" |
-
-### Formatting & Styling
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| color | Color to use for the visualization. For area sparklines, choose the color for the line and the area color will be automatically appplied in a lighter shade. | false | CSS name \| hexademical \| RGB \| HSL | - |
-| valueFmt | Format to use for value column ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format name \| custom format name | - |
-| dateFmt | Format to use for date column ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format name \| custom format name | - |
-
-### Axes
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| yScale | Whether to truncate the y-axis to enhance visibility | false | ['true', 'false'] | "false" |
-
-### Sizing
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| height | Height of sparkline in pixels | false | number | 15 |
-| width | Width of sparkline in pixels | false | number | 50 |
-
-### Interactivity
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| interactive | Turn on or off tooltip behaviour on hover. If off, chart will be a staticly rendered SVG (better for page performance). If on, you will be able to see dates/values when hovering over the sparkline | false | ['true', 'false'] | "true" |
-| connectGroup | Group name to connect this sparkline to other charts for synchronized tooltip hovering. Charts with the same `connectGroup` name will become connected | false | string | - |

package/dist/docs/data_apps/components/data/big-value.md

@@ -1,153 +0,0 @@
----
-title: Big Value
-description: Display a large value standalone, and optionally include a comparison and a sparkline.
----
-
-Use big values to display a large value standalone, and optionally include a comparison and a sparkline.
-
-## Example
-
-```markdown
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-  sparkline=month
-  comparison=order_growth
-  comparisonFmt=pct1
-  comparisonTitle="vs. Last Month"
-/>
-```
-
-## Examples
-
-### Default
-
-```markdown
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-/>
-```
-
-### Comparisons
-
-```markdown
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-  comparison=order_growth
-  comparisonFmt=pct1
-  comparisonTitle="MoM"
-/>
-```
-
-### Multiple cards
-
-Multiple cards will align themselves into a row.
-
-```markdown
-<BigValue 
-  data="orders_with_comparisons" 
-  value=sales
-  fmt=usd0
-  comparison=sales_growth
-  comparisonFmt=pct1
-  comparisonTitle="MoM"
-/>
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-  title="Orders"
-  comparison=order_growth
-  comparisonFmt=pct1
-  comparisonTitle="MoM"
-/>
-<BigValue 
-  data="orders_with_comparisons" 
-  value=aov
-  title="Average Order Value"
-  fmt=usd2
-  comparison=aov_growth
-  comparisonFmt=pct1
-  comparisonTitle="MoM"
-/>
-```
-
-### Linking to other pages
-
-The link property makes the Value component clickable, allowing navigation to other pages.
-
-```html
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-  sparkline=month
-  comparison=order_growth
-  comparisonFmt=pct1
-  comparisonTitle="vs. Last Month"
-  link='/components/data/big-value'
-/>
-```
-
-### Non-Delta Comparisons
-
-```html
-<BigValue 
-  data="orders_with_comparisons" 
-  value=num_orders
-  comparison=prev_month_orders
-  comparisonTitle="Last Month"
-  comparisonDelta=false
-/>
-```
-
-### Sparkline
-
-```html
-<BigValue 
-  data="orders_with_comparisons" 
-  value=sales
-  sparkline=month
-/>
-```
-
-## Options
-
-### Data
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| data | Query name, wrapped in curly braces | true | query name | - |
-| value | Column to pull the main value from. | true | column name | - |
-| title | Title of the card. | false | string | Title of the value column. |
-| minWidth | Overrides min-width of component | false | % or px value | "18%" |
-| maxWidth | Adds a max-width to the component | false | % or px value | - |
-| fmt | Sets format for the value ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format \| custom format | - |
-| emptySet | Sets behaviour for empty datasets. Can throw an error, a warning, or allow empty. When set to 'error', empty datasets will block builds in `build:strict`. Note this only applies to initial page load - empty datasets caused by input component changes (dropdowns, etc.) are allowed. | false | ['error', 'warn', 'pass'] | "error" |
-| emptyMessage | Text to display when an empty dataset is received - only applies when `emptySet` is 'warn' or 'pass', or when the empty dataset is a result of an input component change (dropdowns, etc.). | false | string | "No records" |
-| link | Used to navigate to other pages. Can be a full external link like `https://google.com` or an internal link like `/sales/performance` | false | - | - |
-
-### Comparison Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| comparison | Column to pull the comparison value from. | false | column name | - |
-| comparisonTitle | Text to the right of the comparison. | false | string | Title of the comparison column. |
-| comparisonDelta | Whether to display delta symbol and color | false | ['true', 'false'] | true |
-| downIsGood | If present, negative comparison values appear in green, and positive values appear in red. | false | ['true', 'false'] | false |
-| neutralMin | Sets the bottom of the range for 'neutral' values - neutral values appear in grey rather than red or green | false | number | 0 |
-| neutralMax | Sets the top of the range for 'neutral' values - neutral values appear in grey rather than red or green | false | number | 0 |
-| comparisonFmt | Sets format for the comparison ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format \| custom format | - |
-
-### Sparkline
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| sparkline | Column to pull the date from to create the sparkline. | false | column name | - |
-| sparklineType | Chart type for sparkline | false | ['line', 'area', 'bar'] | "line" |
-| sparklineValueFmt | Formatting for tooltip values | false | format code | same as fmt if supplied |
-| sparklineDateFmt | Formatting for tooltip dates | false | format code | "YYYY-MM-DD" |
-| sparklineColor | Color of visualization | false | CSS name \| hexademical \| RGB \| HSL | - |
-| sparklineYScale | Whether to truncate the y-axis of the chart to enhance visibility | false | ['true', 'false'] | false |
-| connectGroup | Group name to connect this sparkline to other charts for synchronized tooltip hovering. Charts with the same `connectGroup` name will become connected | false | string | - |
-| description | Adds an info icon with description tooltip on hover | false | string | - |

package/dist/docs/data_apps/components/data/delta.md

@@ -1,89 +0,0 @@
----
-title: Delta
-description: Display an inline indicator that shows how a value has changed.
----
-
-Use a Delta component to display an inline indicator that shows how a value has changed.
-
-
-```markdown
-This value is <Delta data="growth" column=positive fmt="+0.0%;-0.0%;0.0%" /> since last month.
-```
-
-## Examples
-
-### Value Types
-
-#### Positive
-
-```markdown
-<Delta data="growth" column=positive fmt=pct1 />
-```
-
-#### Negative 
-
-```markdown
-<Delta data="growth" column=negative fmt=pct1 />
-```
-
-#### Neutral*
-*Values are not defined as neutral until you define a range using the `neutralMin` and `neutralMax` props
-
-```markdown
-<Delta data="growth" column=neutral fmt=pct1 neutralMin=-0.02 neutralMax=0.02 />
-```
-
-### Chips
-
-#### Positive
-
-```markdown
-<Delta data="growth" column=growth fmt=pct1 chip=true />
-```
-
-#### Negative 
-
-```markdown
-<Delta data="growth" column=negative fmt=pct1 chip=true/>
-```
-
-#### Neutral*
-*Values are not defined as neutral until you define a range using the `neutralMin` and `neutralMax` props
-
-```markdown
-<Delta data="growth" column=neutral fmt=pct1 chip=true neutralMin=-0.02 neutralMax=0.02 />
-```
-
-### Symbol Position
-
-#### Symbol on Left
-
-```html
-<Delta data="growth" column=positive fmt=pct1 symbolPosition=left/>
-```
-
-#### Symbol on Left in Chip
-
-```html
-<Delta data="growth" column=positive fmt=pct1 chip=true symbolPosition=left/>
-```
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| data | Query name, wrapped in curly braces | true | query name | - |
-| column | Column to pull values from | false | column name | First column |
-| row | Row number to display. 0 is the first row. | false | number | "0" |
-| value | Pass a specific value to the component (e.g., value=100). Overridden by the data/column props. | false | number | - |
-| fmt | Format to use for the value ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format \| custom format | - |
-| downIsGood | If true, negative comparison values appear in green, and positive values appear in red. | false | ['true', 'false'] | "false" |
-| showSymbol | Whether to show the up/down delta arrow symbol | false | ['true', 'false'] | "true" |
-| showValue | Whether to show the value. Set this to false to show only the delta arrow indicator. | false | ['true', 'false'] | "true" |
-| text | Text to display after the delta symbol and value | false | string | - |
-| neutralMin | Start of the range for 'neutral' values, which appear in grey font with a dash instead of an up/down arrow. By default, neutral is not applied to any values. | false | number | "0" |
-| neutralMax | End of the range for 'neutral' values, which appear in grey font with a dash instead of an up/down arrow. By default, neutral is not applied to any values. | false | number | "0" |
-| chip | Whether to display the delta as a 'chip', with a background color and border. | false | ['true', 'false'] | "false" |
-| symbolPosition | Whether to display the delta symbol to the left or right of the value | false | ['left', 'right'] | "right" |
-| emptySet | Sets behaviour for empty datasets. Can throw an error, a warning, or allow empty. When set to 'error', empty datasets will block builds in `build:strict`. Note this only applies to initial page load - empty datasets caused by input component changes (dropdowns, etc.) are allowed. | false | ['error', 'warn', 'pass'] | "error" |
-| emptyMessage | Text to display when an empty dataset is received - only applies when `emptySet` is 'warn' or 'pass', or when the empty dataset is a result of an input component change (dropdowns, etc.). | false | string | "No records" |