Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: doc/extension charts #347

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Conversation

drake-stamos
Copy link
Contributor

No description provided.

Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes. Nice job!

docs/userman/gui/extension/chart.md Show resolved Hide resolved
docs/userman/gui/extension/chart.md Show resolved Hide resolved
docs/userman/gui/extension/chart.md Show resolved Hide resolved
docs/userman/gui/extension/chart.md Show resolved Hide resolved
docs/userman/gui/extension/chart.md Show resolved Hide resolved
## Configuring the webpack configuration {data-source="gui:doc/extension/example_library/front-end/webpack.config.js#L39"}

To bundle the React component, you must configure the webpack configuration file.
Since Plotly.js is a JavaScript library, you need to include JavaScript in the webpack’s resolve.extensions setting.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Since Plotly.js is a JavaScript library, you need to include JavaScript in the webpack’s resolve.extensions setting.
Since Plotly.js is a JavaScript library, you need to include JavaScript in the webpack’s *resolve.extensions* setting.

};
```

After configuring the webpack file, you can build the library as mentioned in the [Building the front-end module](dynamic_element/index.md) section.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure about the crossref?


After configuring the webpack file, you can build the library as mentioned in the [Building the front-end module](dynamic_element/index.md) section.

## Using the element {data-source="gui:doc/extension/example_library/dashboard.py"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Using the element {data-source="gui:doc/extension/example_library/dashboard.py"}
## Using the element {data-source="gui/extension/example_library/dashboard.py"}

To use the *dashboard* element in a Python script, you can follow the example below:

```python title="dashboard.py"
trace1 = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename 'trace' to 'set', to align with the name.
The point is: at the dataset level, we're not talking about traces. This happens only when displayed.

@@ -102,6 +102,7 @@ nav:
- "Scalar properties": userman/gui/extension/dynamic_element/scalar_props.md
- "List of Values Elements": userman/gui/extension/list_of_values.md
- "Tabular Elements": userman/gui/extension/tabular_data.md
- "Chart Elements": userman/gui/extension/chart.md
- "Accessing assets": userman/gui/extension/accessing_assets.md
- "Packaging extensions": userman/gui/extension/extension_packaging.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we move this section (packaging) as soon as possible?

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

Successfully merging this pull request may close these issues.

3 participants