Commit d5e590f5 authored by Sanjay Yadav's avatar Sanjay Yadav

DOC: Updated documentation.

parent 071e14d8
Pipeline #32576 passed with stage
in 1 minute and 8 seconds
......@@ -439,100 +439,100 @@ This supports the following chart types:
Here are examples that assume the following configuration:
```yaml
source: input.pptx # This must already have the relevant chart
target: output.pptx
data: # This dictionary is available to all charts as "data"
sales: {url: sales.csv} # The examples assume a dataset called "sales"
```
```yaml
source: input.pptx # This must already have the relevant chart
target: output.pptx
data: # This dictionary is available to all charts as "data"
sales: {url: sales.csv} # The examples assume a dataset called "sales"
```
Here are examples for various charts:
```yaml
edit-charts: # Rule name
Bar Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Column Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Line Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Area Chart Name: # Name of the chart shape. Case sensitive
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']] # Use sales data
x: Category # The x-axis is the Category column. Other columns are Y-axis values
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
opacity: 0.50 # Constant opacity for all lines
Scatter Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Bubble Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
size: Growth # Optional: Column name from data for the size of the bubbles, if not defined default size will be 1
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Radar Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Donut Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Pie Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
```
```yaml
edit-charts: # Rule name
Bar Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Column Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Line Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Area Chart Name: # Name of the chart shape. Case sensitive
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']] # Use sales data
x: Category # The x-axis is the Category column. Other columns are Y-axis values
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
opacity: 0.50 # Constant opacity for all lines
Scatter Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Bubble Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
size: Growth # Optional: Column name from data for the size of the bubbles, if not defined default size will be 1
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Radar Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Donut Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
Pie Chart Name:
chart:
data: data['sales'][['Category', 'Sales', 'Profit', 'Growth']]
x: Category
color: # Define colors
Sales: #D73027 # Specify color of sales line in 6-digit hex
Profit: #1A9850 # Specify color of profit line
Growth: #cccccc # Specify color of profit line
```
The following keys can also be specified as an [expression](#expressions) and python functions:
`data:`, `x:`, `color:`, `opacity:`, `size:`.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment