@graphenedata/cli 0.0.4 → 0.0.5

package/dist/docs/data_apps/components/inputs/button-group.md

@@ -1,154 +0,0 @@
----
-title: Button Group
-description: Display a group of single-select buttons for quick filtering using a small set of options.
----
-
-Creates a group of single-select buttons for quick filtering
-
-To see how to filter a query using a Button Group, see [Filters](/core-concepts/filters).
-
-## Examples
-
-### Button Group using Options from a Query
-
-```markdown
-<ButtonGroup 
-    data="categories" 
-    name=category_picker 
-    value=category
-/>
-
-Selected: {inputs.category_picker}
-```
-
-### With a Title
-
-```markdown
-<ButtonGroup 
-    data="categories" 
-    name=category_selector 
-    value=category
-    title="Select a Category"
-/>
-
-Selected: {inputs.category_selector}
-```
-
-### With a Default Value
-
-````markdown
-<ButtonGroup
-    data="categories"
-    name=selected_button1
-    value=category
-    defaultValue="Cursed Sporting Goods"
-/>
-
-Selected: {inputs.selected_button1}
-````
-
-### With Hardcoded Options
-
-````markdown
-<ButtonGroup name=hardcoded_options>
-    <ButtonGroupItem valueLabel="Option One" value="1" />
-    <ButtonGroupItem valueLabel="Option Two" value="2" />
-    <ButtonGroupItem valueLabel="Option Three" value="3" />
-</ButtonGroup>
-
-Selected: {inputs.hardcoded_options}
-````
-
-### With Hardcoded Options and Default Value
-
-````markdown
-<ButtonGroup name=hardcoded_options_default>
-    <ButtonGroupItem valueLabel="Option One" value="1" />
-    <ButtonGroupItem valueLabel="Option Two" value="2" default />
-    <ButtonGroupItem valueLabel="Option Three" value="3" />
-</ButtonGroup>
-
-Selected: {inputs.hardcoded_options_default}
-````
-
-### Alternative Labels
-
-````markdown
-<ButtonGroup
-    data="categories" 
-    name=alternative_labels_selector
-    value=category
-    label=short_category
-/>
-
-Selected: {inputs.alternative_labels_selector}
-````
-
-### Filtering a Query
-
-
-````markdown
-<ButtonGroup
-    data="categories" 
-    name=category_button_group
-    value=category
-/>
-
-<DataTable data="filtered_query" emptySet=pass emptyMessage="No category selected"/>
-````
-
-### Style Buttons as Tabs
-
-```markdown
-<ButtonGroup 
-    data="categories" 
-    name=buttons_as_tabs 
-    value=category
-    display=tabs
-/>
-
-Selected: {inputs.buttons_as_tabs}
-```
-
-### Style Buttons as Tabs: With Hardcoded Options
-
-````markdown
-<ButtonGroup name=button_tabs_hardcoded_options display=tabs>
-    <ButtonGroupItem valueLabel="Option One" value="1" />
-    <ButtonGroupItem valueLabel="Option Two" value="2" />
-    <ButtonGroupItem valueLabel="Option Three" value="3" />
-</ButtonGroup>
-
-Selected: {inputs.button_tabs_hardcoded_options}
-````
-
-# ButtonGroup
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| name | Name of the button group, used to reference the selected value elsewhere as `{inputs.name}` | true | - | - |
-| preset | Preset values to use | false | dates | - |
-| data | Query name, wrapped in curly braces | false | query name | - |
-| value | Column name from the query containing values to pick from | false | column name | - |
-| label | Column name from the query containing labels to display instead of the values (e.g., you may want to have the drop-down use `customer_id` as the value, but show `customer_name` to your users) | false | column name | Uses the column in value |
-| title | Title to display above the button group | false | string | - |
-| defaultValue | Sets initial active button and current value | false | value from button group, e.g. 'Cursed Sporting Goods' | - |
-| order | Column to sort options by | false | column name | Uses the same order as the query in `data` |
-| where | SQL where fragment to filter options by (e.g., where sales > 40000) | false | SQL where clause | - |
-| display | Displays tabs with button functionality | false | ['tabs', 'buttons'] | "buttons" |
-| description | Adds an info icon with description tooltip on hover. Appears next to title. | false | string | - |
-
-# ButtonGroupItem
-
-The ButtonGroupItem component can be used to manually add options to a button group. This is useful if you want to add a default option, or if you want to add options that are not in a query.
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| value | Value to use when the option is selected | true | - | - |
-| valueLabel | Label to display for the option in the dropdown | false | string | Uses value |
-| default | Sets the option as the default | false | ["true", "false"] | "false" |
-| hideDuringPrint | Hide the component when the report is printed | false | ["true", "false"] | true |

package/dist/docs/data_apps/components/inputs/checkbox.md

@@ -1,52 +0,0 @@
----
-title: Checkbox
-description: Display a toggleable box for a boolean value.
----
-
-Creates a checkbox with toggleable input. The Title and Name attributes can be defined, enabling the passing of true and false values. 
-
-## Example
-
-````markdown
-<Checkbox
-    title="Hide Months 0" 
-    name=hide_months_0 
-/>
-````
-
-### Checkbox using Default Value
-
-Defining the checked property will set the initial checkbox value with true and false.
-
-```markdown
-<Checkbox
-    title="Title of checkbox" 
-    name=name_of_checkbox
-    checked=true
-/>
-
-Selected Value: {inputs.name_of_checkbox}
-```
-
-### Filtering a Query with Checkbox
-
-
-````markdown
-<Checkbox
-    title="Exclude low values" 
-    name=exclude_low_value
-/>
-
-<BigValue fmt=num0 value=records_count data="orders"/>
-````
-
-# Checkbox
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| name | Name of the checkbox, used to reference the selected value elsewhere as `{inputs.name.value}` | true | - | - |
-| title | Label for the checkbox. If undefined, will default to small checkbox | false | 'string' | - |
-| checked | Initial value for checkbox. True value for checked, false for unchecked | false | boolean | false |
-| description | Adds an info icon with description tooltip on hover | false | string | - |

package/dist/docs/data_apps/components/inputs/date-input.md

@@ -1,131 +0,0 @@
----
-title: Date Input
-description: Display a date picker for selecting a singledate or a range of dates.
----
-
-A date input component allows the user to select a date or a range of dates. The selected dates can be used as inputs to queries or components.
-
-To see how to filter a query using an input component, see [Filters](/core-concepts/filters).
-
-
-````markdown
-<DateInput
-    name=date_filtering_a_query
-    data="orders_by_day"
-    dates=day
-/>
-
-<BarChart
-    data="filtered_query"
-    x=day
-    y=sales
-/>
-````
-
-## Examples
-
-### Using Date Input from a Query
-
-The Date selected can be accessed through the `inputs.[name].value` 
-
-````markdown
-<DateInput
-    name=date_range_from_query
-    data="orders_by_day"
-    dates=day
-/>
-
-Date Selected: {inputs.date_input_from_query.value}
-````
-
-### With a Title
-
-```markdown
-<DateInput
-    name=date_range_with_title
-    data="orders_by_day"
-    dates=day
-    title="Select a Date Input"/>
-```
-
-## Date Range
-
-Creates a date picker for selecting a date range to filter queries, with selectable preset date options.
-
-### Filtering a Query with Range Calendar
-
-The Date selected can be accessed through the `inputs.[name].start` & `inputs.[name].end`
-
-
-````markdown
-<DateInput
-    name=range_filtering_a_query
-    data="orders_by_day"
-    dates=day
-    title='Date Range'
-    range
-/>
-
-<LineChart
-    data="filtered_query_ranged"
-    x=day
-    y=sales
-/>
-````
-
-### Default Value for Preset Ranges
-
-````svelte
-<DateInput
-    name=name_of_date_range
-    defaultValue="'Last 7 Days'"
-    range
-/>
-````
-
-### Customizing Single Preset Ranges
-
-```svelte
-<DateInput 
-    name="date_range_2" 
-    presetRanges="'Last 7 Days'" 
-    range
-/>
-```
-
-### Customizing Multiple Preset Ranges
-
-````svelte
-<DateInput
-    name="date_range_3"
-    range
-    presetRanges={['Last 7 Days', 'Last 3 Months', 'Year to Date', 'All Time']}
-/>
-````
-
-### Manually Specifying a Range
-
-```markdown
-<DateInput
-    name=manual_date_range
-    start=2019-01-01
-    end=2019-12-31
-    range
-/>
-```
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| name | Name of the DateInput, used to reference the selected values elsewhere as `{inputs.name.start`} or `{inputs.name.end`}` | true | string | - |
-| data | Query name, wrapped in curly braces | false | query name | - |
-| range | toggles between a ranged and single input calendar | false | ["true", "false"] | false |
-| dates | Column name from the query containing Date Input to span | false | column name | - |
-| start | A manually specified start date to use for the range | false | string formatted YYYY-MM-DD | - |
-| end | A manually specified end date to use for the range | false | string formatted YYYY-MM-DD | - |
-| title | Title to display in the Date Input component | false | string | - |
-| presetRanges | Customize "Select a Range" drop down, by including present range options. **Range options**: `'Last 7 Days'` `'Last 30 Days'` `'Last 90 Days'` `'Last 3 Months'` `'Last 6 Months'` `'Last 12 Months'` `'Last Month'` `'Last Year'` `'Month to Date'` `'Year to Date'` `'All Time'` | false | string \| array of values e.g. `{['Last 7 Days', 'Last 30 Days']}` | undefined |
-| defaultValue | Accepts preset in string format to apply default value in Date Input picker. **Range options**: `'Last 7 Days'` `'Last 30 Days'` `'Last 90 Days'` `'Last 3 Months'` `'Last 6 Months'` `'Last 12 Months'` `'Last Month'` `'Last Year'` `'Month to Date'` `'Year to Date'` `'All Time'` | false | string e.g. {'Last 7 Days'} or {'Last 6 Months'} | undefined |
-| hideDuringPrint | Hide the component when the report is printed | false | ["true", "false"] | "true" |
-| description | Adds an info icon with description tooltip on hover | false | string | - |

package/dist/docs/data_apps/components/inputs/date-range.md

@@ -1,124 +0,0 @@
----
-title: Date Range
-description: Display a date picker for selecting a range of dates.
----
-
-Creates a date picker that can be used to filter a query.
-Includes a set of preset ranges for quick selection of common date ranges. These are relative to the supplied end date.
-
-To see how to filter a query using an input component, see [Filters](/core-concepts/filters).
-
-````markdown
-<DateRange
-    name=date_range_name
-    data="orders_by_day"
-    dates=day
-/>
-
-From {inputs.date_range_name.start} to {inputs.date_range_name.end}
-````
-
-## Examples
-
-### Using Date Range from a Query
-
-````markdown
-<DateRange
-    name=date_range_from_query
-    data="orders_by_day"
-    dates=day
-/>
-
-From {inputs.date_range_from_query.start} to {inputs.date_range_from_query.end}
-````
-
-### Manually Specifying a Range
-
-```markdown
-<DateRange
-    name=manual_date_range
-    start=2019-01-01
-    end=2019-12-31
-/>
-```
-
-### With a Title
-
-```markdown
-<DateRange
-    name=date_range_with_title
-    data="orders_by_day"
-    dates=day
-    title="Select a Date Range"
-/>
-```
-
-### Visible During Print / Export
-
-````markdown
-<DateRange
-    name=date_range_visible_during_print
-    data="orders_by_day"
-    dates=day
-    hideDuringPrint="false"
-/>
-````
-
-### Filtering a Query
-
-
-````markdown
-<DateRange
-    name=range_filtering_a_query
-    data="orders_by_day"
-    dates=day
-/>
-
-<LineChart
-    data="filtered_query"
-    x=day
-    y=sales
-/>
-````
-
-### Customizing Single Preset Ranges
-
-```svelte
-<DateRange
-    name="date_range_preset"
-    presetRanges="'Last 7 Days'"
-/>
-```
-
-### Customizing Multiple Preset Ranges
-
-````svelte
-<DateRange
-    name="date_range_preset_2"
-    presetRanges={['Last 7 Days', 'Last 3 Months', 'Year to Date', 'All Time']}
-/>
-````
-
-### Default Value for Preset Ranges
-
-````svelte
-<DateRange
-    name="date_range_preset_3"
-    defaultValue="'Last 7 Days'"
-/>
-````
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| name | Name of the DateRange, used to reference the selected values elsewhere as `{inputs.name.start`} or `{inputs.name.end`}` | true | string | - |
-| data | Query name, wrapped in curly braces | false | query name | - |
-| dates | Column name from the query containing date range to span | false | column name | - |
-| start | A manually specified start date to use for the range | false | string formatted YYYY-MM-DD | - |
-| end | A manually specified end date to use for the range | false | string formatted YYYY-MM-DD | - |
-| title | Title to display in the Date Range component | false | string | - |
-| presetRanges | Customize "Select a Range" drop down, by including present range options. **Range options**: `'Last 7 Days'` `'Last 30 Days'` `'Last 90 Days'` `'Last 365 Days'` `'Last 3 Months'` `'Last 6 Months'` `'Last 12 Months'` `'Last Month'` `'Last Year'` `'Month to Date'` `'Month to Today'` `'Year to Date'` `'Year to Today'` `'All Time'` | false | string \| array of values e.g. `{['Last 7 Days', 'Last 30 Days']}` | undefined |
-| defaultValue | Accepts preset in string format to apply default value in Date Range picker. **Range options**: `'Last 7 Days'` `'Last 30 Days'` `'Last 90 Days'` `'Last 365 Days'` `'Last 3 Months'` `'Last 6 Months'` `'Last 12 Months'` `'Last Month'` `'Last Year'` `'Month to Date'` `'Month to Today'` `'Year to Date'` `'Year to Today'` `'All Time'` | false | string e.g. {'Last 7 Days'} or {'Last 6 Months'} | undefined |
-| hideDuringPrint | Hide the component when the report is printed | false | ["true", "false"] | "true" |
-| description | Adds an info icon with description tooltip on hover | false | string | - |

package/dist/docs/data_apps/components/inputs/dimension-grid.md

@@ -1,67 +0,0 @@
----
-title: Dimension Grid
-description: Display an interactive grid of one dimensional columns to filter by many dimensions simultaneously.
----
-
-Dimension grid produces an interactive grid of one dimension tables, one for each string column in the source table. The dimension grid can can also be used as an input. 
-
-
-
-````markdown
-<DimensionGrid data="orders" metric='sum(sales)' name=selected_dimensions /> 
-
-<LineChart data="monthly_sales" handleMissing=zero/>
-````
-
-## Examples
-
-### Basic Usage 
-
-```html
-<DimensionGrid data="my_query" />
-```
-
-### As an Input 
-
-Dimension grid produces a condition for all of the selected dimensions which is suitable for referencing directly in a `where` or `filter` clause. For example `airline = 'Air Canada' and plane = '747`. Where no dimensions have been selected, DimensionGrid returns `true`. 
-
-````html
-<DimensionGrid 
-    data="my_query" 
-    name="selected_dimensions"
-/>
-
-
-````
-
-### Multi Select 
-
-Using the multiple prop, Dimension grid can filter by multiple rows in the same column. Default value is false
-
-
-````html
-<DimensionGrid 
-    data="orders" 
-    metric='sum(sales)' 
-    name=multi_dimensions 
-    multiple
-/>
-
-<LineChart data="monthly_sales_multi" y=sales_usd0/> 
-
-
-````
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| data | Query name, wrapped in curly braces | true | string | - |
-| metric | SQL aggregate which could be applied to `data` e.g. 'sum(sales)' | false | string | "count(*)" |
-| name | Name of the dimension grid, used to reference the selected value elsewhere as `{inputs.name}` | false | string | - |
-| title | Title for the dimension grid | false | string | - |
-| subtitle | Subtitle - appears under the title | false | string | - |
-| metricLabel | Label for the metric | false | string | - |
-| fmt | Sets format for the value [(see available formats)](/core-concepts/formatting) | false | Excel-style format \| built-in format \| custom format | - |
-| limit | Maximum number of rows to include in each table | false | number | "10" |
-| multiple | Allows for multiple rows in a column to be selected and filtered | false | boolean | "false" |