diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..69d8a657 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: File a bug report to help us improve +title: BUG +labels: bug +assignees: hcpchris + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. When I attempt '...' using the following code: '...' +2. I receive '...' + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Your Environment:** + - OS: [e.g. Linux, Windows, etc.] + - Python Version: [e.g. 3.10, 3.8, 3.11] + - Highcharts JavaScript Version: [e.g. 10.2, 10.3, etc.] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml new file mode 100644 index 00000000..de8e6767 --- /dev/null +++ b/.github/workflows/pypi-publish.yml @@ -0,0 +1,37 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# GitHub recommends pinning actions to a commit SHA. +# To get a newer version, you will need to update the SHA. +# You can also reference a tag or branch, but the action may change without warning. + +name: Release Library to PyPi + +on: + release: + types: [published] + +env: + HATCH_INDEX_USER: __token__ + HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }} + HATCH_INDEX_REPO: main + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install hatch + - name: Build package + run: hatch build + - name: Publish package + run: hatch publish \ No newline at end of file diff --git a/.github/workflows/pypi-test-publish.yml b/.github/workflows/pypi-test-publish.yml new file mode 100644 index 00000000..835a2e76 --- /dev/null +++ b/.github/workflows/pypi-test-publish.yml @@ -0,0 +1,38 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# GitHub recommends pinning actions to a commit SHA. +# To get a newer version, you will need to update the SHA. +# You can also reference a tag or branch, but the action may change without warning. + +name: Upload Python Package + +on: + pull_request: + branches: + - master + +env: + HATCH_INDEX_USER: __token__ + HATCH_INDEX_AUTH: ${{ secrets.TEST_PYPI_API_TOKEN }} + HATCH_INDEX_REPO: test + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install hatch + - name: Build package + run: hatch build + - name: Publish package + run: hatch publish \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..6cad02b1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,29 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: requirements.dev.txt \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..fcfc7d39 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,33 @@ +language: python +job: + include: + #- python: "3.8" + # env: TOXENV=py38 + #- python: "3.9" + # env: TOXENV=py39 + - python: "3.10" + dist: focal + env: TOXENV=py310 + - python: "3.11" + dist: bionic + env: TOXENV=py311 + - python: "3.10" + dist: focal + env: TOXENV=coverage + - python: "3.10" + dist: focal + env: TOXENV=docs +os: + - linux +git: + quiet: true +install: + - pip install -r requirements.dev.txt +before_script: + - mkdir /home/travis/build/highcharts-for-python/highcharts-core/tests/input_files/headless_export/output/ + - curl -Os --retry 5 https://uploader.codecov.io/latest/linux/codecov + - chmod +x codecov +script: tox -- -v -nauto + +after_success: + - if [[ -e .coverage ]]; then ./codecov -t $CODECOV_TOKEN; fi \ No newline at end of file diff --git a/CHANGES.rst b/CHANGES.rst index 2d379dff..b3c2ac52 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,4 @@ -Release 0.1.0 +Release 1.0.0-rc1 ========================================= -* First public release +* First public release: **Release Candidate 1** diff --git a/LICENSE b/LICENSE index e130a597..781347c9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,227 @@ -MIT License - -Copyright (c) 2022 Insight Industry Inc. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +####################################################################### +Terms and Conditions for the Highcharts for Python Toolkit License +####################################################################### + +*********************************************** +1. Acceptance of the Terms and Conditions +*********************************************** + +These terms and conditions (the “Wrapper T&Cs”) shall apply to Licensee’s license to and use of the Wrapper (as defined below), a complementary product to the Software owned and delivered by Highsoft AS (“Highsoft”). The Wrapper is owned by HCP LLC (“HCP”) and distributed by Highsoft AS or its partners, resellers or distributors, and these Wrapper T&Cs shall apply to the Licensee’s usage of the Wrapper irrespective of which license type(s) to the Software the Licensee has subscribed to or purchased from Highsoft. + +By installing or using the Wrapper or any part thereof, Licensee agrees to be bound by these Wrapper T&Cs, unless Licensee is using the Software and the Wrapper for evaluation purposes authorized by Highsoft, i.e. during a trial period. + +Without prejudice to the limited right to download and test the Wrapper for evaluation prior to the purchase of a Wrapper License, Licensee is not authorized to install or use the Wrapper unless Licensee pays the applicable Wrapper Fee and fully agrees to all terms and conditions set forth herein and to any terms set forth in related licensing agreements or terms from Highsoft to which these Wrapper T&Cs constitute an addendum. + +*********************************************** +2. Relationship to the Main Agreement +*********************************************** + +A Wrapper License (as defined below) or renewal thereof can only be purchased by a Licensee either already holding a License to the Software, or at the same time as purchasing such a License, as an add-on product to such License, and only by a Licensee holding an active and valid enrolment in the Highcharts Advantage plan. The purchase of, and right to use the Licensed Software shall remain governed by the terms and conditions of the License issued by Highsoft to Licensee, whether this is Highsoft Standard License Agreement, Highsoft Terms and Conditions for Subscription to Annual License to Highsoft Software, or another licensing agreement as agreed between Highsoft and Licensee, as applicable (such terms and conditions between Highsoft and Licensee hereinafter collectively referred to as the “Main Agreement”). + +These Wrapper T&Cs constitute an addendum to the Main Agreement and an integral part thereof and apply to the use of the Wrapper only. + +In the case of any discrepancy between the Main Agreement and these Wrapper T&Cs related to the licensing of the Wrapper, these Wrapper T&Cs shall prevail. + +*********************************************** +3. Definitions +*********************************************** + +Unless otherwise defined below or elsewhere in these Wrapper T&Cs, all capitalized terms used but not otherwise defined herein shall have the same definitions as set out in the Main Agreement. + + * **Agreement** shall mean the Main Agreement, these Wrapper T&Cs and the License Statement; + * **Delivery Date** shall mean the date Licensee is invoiced by Highsoft for the Wrapper License, which will + correspond to the Delivery Date for the Software if purchased together, or at a separate time, if purchased as an + add-on to an existing License; + * **HCP** shall mean HCP LLC, the company behind the Wrapper, a US limited liability corporation registered in the + state of Delaware, with its registered office at 867 Boylston Street, 5th Floor #1674, Boston, MA 02116, United + States.Licensee shall mean the legal entity to which the License (to the Licensed Software) and the Wrapper License + has been granted, as expressly stated in the License Statement; + * **Licensors** shall mean Highsoft and/or HCP collectively; + * **Wrapper** shall mean the proprietary software products distributed by Highsoft and owned by HCP, including + Highcharts for Python – the main product included in all licenses – in addition to Highcharts Stock for Python, + Highcharts Maps for Python, Highcharts Gantt for Python, and other optional additional products or libraries which + may be developed by HCP and offered within the Wrapper by Highsoft. + * **Wrapper** Fee shall mean the fee payable by Licensee to Highsoft for the Wrapper License and for the right to + receive the support services provided by HCP under these Wrapper T&Cs ; + * **Wrapper License** shall mean the right to use the Wrapper in accordance with the Agreement and as set out herein, + whether granted as a perpetual license or in the form of a time-limited subscription (subject to renewal), and as + one or more of the license types as defined in the Main Agreement; + * **Wrapper Term** shall have the meaning set out in section 7. + +*********************************************** +4. Ownership and Copyright +*********************************************** + +The Wrapper is the property of HCP and is protected by copyright law as well as other statutory and non-statutory intellectual property law. All title and copyrights in and to the Wrapper are and shall remain owned fully and solely by HCP. + +Under the Agreement, the Wrapper is licensed to Licensee by Highsoft on behalf of HCP, not sold. + +The Licensors reserve all rights not expressly granted to Licensee under the Agreement. Without limiting the generality of the foregoing, Licensee acknowledges and agrees that: (a) except as specifically set forth herein, the Licensors retains all right, title and interest in and to the Wrapper and the Software, and Licensee does not acquire any right, title or interest to the Wrapper or the Software except as set forth herein; (b) any configuration or deployment of the Wrapper or the Software shall not affect or diminish the Licensor’s rights, title or interest in and to the Wrapper or the Software. The Agreement shall not limit in any way the Licensor’s right to develop, use, license, create derivative works of, or otherwise exploit the Wrapper or the Software, or to permit Third Parties to do so. + +The Licensors acknowledge and agree that (i) Licensee retains all rights, title and interest in and to any Licensee-owned software, and the Licensors do not acquire any right, title, or interest in or to such application; and (ii) any integration of the Wrapper with a Licensee-owned application shall not affect or diminish Licensee’s rights, title, and interest in and to such application. + +*********************************************** +5. Grant of License +*********************************************** + +Subject to Licensee’s full payment of the Wrapper Fee, Highsoft grants to Licensee a right to use the Wrapper during the Wrapper Term (as defined in Section 7 below), on the same terms and conditions as set forth in the Main Agreement and the License Statement as modified by these Wrapper T&Cs. The Main Agreement shall apply accordingly to the Wrapper License insofar as the terms and conditions therein are applicable, whereas all references to the “Licensed Software” in the Main Agreement shall for the purposes of these Wrapper T&Cs to the extent applicable be deemed to include the Wrapper. + +The License type(s) chosen by Licensee for the Licensed Software shall apply to the Wrapper License, and depending on the purchased License type(s), as stated in the Licensed Statement, the relevant section in the Main Agreement detailing the usage rights and limitations for the License shall apply similarly to the Wrapper License. + +The rights granted to Licensee under the Agreement, is strictly limited to the usage rights granted under the chosen License type and with the scope as stated in the License Statement. The number of authorized Developers included in the Wrapper License is the same as the number of authorized Developers included in the License, as set out in the License Statement. The Wrapper may only be used in such Web Application(s), SaaS Application(s) and/or Licensee Product(s) as expressly identified in the License Statement. + +A Wrapper License shall include the components of the Wrapper which correspond to the Licensed Software to which Licensee holds a valid License, i.e. a Wrapper License purchased for Highcharts Stock shall include the Highcharts for Python software and all component libraries needed to implement the Highcharts Stock for Python library, and a Wrapper License purchased for Highcharts Maps shall include the Highcharts for Python software and all component libraries needed to implement the Highcharts Maps for Python, etc. + +5.1 General Grants and Limitations +======================================== + +The Wrapper License includes the support services provided by HCP set forth in Section 6 below. +Irrespective of the chosen License type, the Wrapper License and any support services for the Wrapper shall be subject to renewal, and contingent upon Licensee’s continued enrollment in the Highcharts Advantage plan, as set out in section 7. + +Licensee may obtain the Wrapper source code by downloading the source code from the Highsoft Website or from Github or equivalent source code repository made available by HCP, by downloading and installing the source code from a public repository such as PyPi, and make its own edits, and keep its own repositories with the modified source code; provided, however, any such modifications shall be at Licensee’s own risk and shall void any support obligation of HCP hereunder. + +Licensee shall not modify, delete or obscure any notices of proprietary rights or any Wrapper identification or restrictions on or in the Wrapper found in the source code. + +*********************************************** +6. Wrapper Support +*********************************************** + +A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee’s valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP. + +All support inquiries related to the Wrapper shall be sent to support@highchartspython.com or filed at https://www.highchartspython.com. + +Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP: + + i. All new releases or updates of the Wrapper released during the applicable Advantage Period; + ii. Up to ten (10) hours of the personalized technical support for the Wrapper and/or the Licensed Software + (combined) per Developer per Support Year based on the number of Developers stated in the License Statement for + the License. Licensee may freely distribute its included total of ten (10) hours of personalized technical + support between support of the Wrapper and support of the Licensed Software; + iii. Technical support by e-mail; + iv. Priority response; + v. Access to 2nd line support for the Wrapper by core developers; + vi. Online text chat with 1st line support Wrapper engineers; + vii. Investigation of any claimed bug/error/malfunction/nonfunctioning of the Wrapper, and when possible, + suggestions as to corrective or work-around solutions to the problems; + viii. Supply of emergency hot fixes to the Wrapper; + ix. Guidance and advice on implementing the Wrapper with the Software, as well as with any third-party systems and + platforms to the extent such implementation is authorized by Highsoft. The guidance and advice shall include + advice on best practices, limited code review, and guidance on parts of the code that are directly related to + using the Wrapper with the Software; + x. Any bug and error fixing, malfunctioning of the Wrapper is to be delivered outside the personalized technical + support hours. + +Licensee is responsible for downloading and installing major version releases and updates of the Wrapper during the applicable Advantage Period. During each Advantage Period in which Licensee is validly enrolled in Highcharts Advantage, HCP will provide support for the current version and last major version releases of the Wrapper. For the avoidance of doubt, HCP shall have no obligation to provide support for any version of the Wrapper released prior to the major version release which immediately preceded the then current major version release of the Wrapper. + +The support services as set forth in this section (i) do not cover issues arising in connection with implementation of the Wrapper or Licensed Software in/to Licensee Products or Licensee’s own applications or to the Wrapper as modified by Licensee, and (ii) shall not extend to any Third Parties to which Licensee distributes Licensee Products, SaaS Application(s) or Web Application(s) containing the Wrapper, Licensed Software or any part thereof. Support to any Licensee customers shall hence be Licensee’s full and sole responsibility. The Licensors may, at its sole discretion, at any time choose to discontinue the supply of new Releases of the Wrapper. + +*********************************************** +7. Term and Renewal +*********************************************** + +The term of the Wrapper License (the ”Wrapper Term”) shall correspond to the Initial Term of the License as indicated in the License Statement issued by Highsoft, and the provisions of the Main Agreement pertaining to the terms and conditions on the Term and Renewal of the License shall apply similarly to the Wrapper License; provided, however, in all cases, the support services set forth in Section 6 above are co-terminus with and contingent upon the Licensee’s enrollment in the Highsoft Advantage Plan as set forth in the applicable Main Agreement, including any renewal thereof, and payment of the corresponding Wrapper Fee. + +During the term of the Wrapper License, the Wrapper shall be made available by the Licensors and Licensee shall be authorized to download the Wrapper from the Highsoft Website, from Github or comparable source code repository maintained by HCP, or from a public Python library repository such as PyPi. + +*********************************************** +8. Termination +*********************************************** + +The termination and expiration provisions in the Main Agreement shall apply similarly to the Agreement, and a termination or expiration of the Main Agreement, however occasioned, shall be construed as, and entail a termination of this Agreement. + +*********************************************************** +9. Annual License Fee, Renewal Fee, and Payment Terms +*********************************************************** + +Licensee shall upon purchase of the Wrapper License pay the applicable Wrapper License Fee as determined by Highsoft, subject to the provisions on payment of the License Fee and Highcharts Advantage Fee as set out in the Main Agreement. +For avoidance of doubt, the Wrapper License and accompanying rights including any subsequent renewals is granted to Licensee on the condition that all the due fees are paid to Highsoft in full and on time. + +*********************************************************** +10. Warranties and Representations +*********************************************************** + +10.1 Scope +================= + +All warranties and representations given herein are provided by HCP, and HCP’s warranties and representations in this section 10 are limited to the Wrapper provided to Licensee under the Agreement. + +10.2 HCP’s Warranties and Representations +=============================================== + +HCP warrants and represents that: + + i. For a period of ninety (90) days following its Delivery Date, the Wrapper will perform substantially in + accordance with HCP’s written specifications, provided that it has been used in accordance with all documentation + and specifications made available on Highsoft's Website and not modified by Licensee, + ii. HCP will perform its obligations under the Wrapper License and these Wrapper T&Cs in accordance with all + applicable laws and regulations, + iii. HCP has the full and unconditional ownership of the Wrapper, + iv. The Wrapper does not infringe intellectual property rights of any Third Party, + v. When installed in accordance with HCP’s written specifications, Third Party Dependencies, defined as software on + which the Wrapper relies that has been developed and made available by Third Parties, shall be installed. HCP + warrants that at the time of the Wrapper’s Release, such software was available for public distribution in + accordance with its applicable licenses and its bundling with the Wrapper is fully compliant with the licenses of + any and all such Third Party Dependencies. The Licensee can review the details of all such Third Party + Dependencies, including their relevant licensing provisions, by reviewing the Wrapper documentation made + available on Highsoft’s Website. + vi. HCP has the requisite knowledge, personnel, resources and know-how to fully perform and deliver the Wrapper and + associated services as stipulated by these Wrapper T&Cs in a professional manner, + vii. HCP has not intentionally placed and will use its best efforts to avoid the placement of any Harmful Codes into + the Wrapper provided under the Wrapper License. For the purpose of this section 10.2, "Harmful Codes" is + defined as any program that infects, damages and/or impairs another program or data, disables hardware or + software, or permits or assists in the breach of data. + +10.3 Licensee’s Remedies +============================= + +In the event of a breach, or alleged breach of any of the warranties in section 10.2, Licensee shall promptly notify either HCP or Highsoft and delete the Wrapper. Licensee’s sole remedy in such an event shall be that HCP shall re-supply or correct the Wrapper so that it operates according to the warranties set out in section 10.2. The warranties shall not apply if Licensee has modified, or used the Wrapper improperly, or on an operating environment not approved by HCP. Improper use and unapproved operating environments will be as set forth in the documentation provided to Licensee on or prior to Delivery Date. + +*********************************************************** +11. Limitation of Liability +*********************************************************** + +11.1 Highsoft +=================== + +The Licensee understands and accepts that the Wrapper is provided by Highsoft as an Official Wrapper, and are hence not covered by the Warranties and Representations included in the Main Agreement, and is provided “as is” by Highsoft and may have errors and omissions. Highsoft disclaims any and all liability for the Wrapper or Licensee’s usage of or reliance on the Wrapper, and makes no warranties, express or implied, including but not limited to, warranties of merchantability, fitness for purpose, performance, accuracy, or non-infringing nature. + +11.2 HCP +================== + +The Wrapper and all related support services supplied by HCP are provided ‘as is’ and may have errors and omissions. Thus, remedies are only available to Licensee in the event of any breach of the warranties set out in section 10. + +UNDER NO CIRCUMSTANCES, AND EVEN IF INFORMED THEREOF BY LICENSEE OR ANY OTHER PARTY, WILL THE LICENSORS BE LIABLE UNDER OR IN CONNECTION WITH A CLAIM RELATING TO THESE WRAPPER T&CS OR ITS SUBJECT MATTER FOR (i) LOSS OF, OR DAMAGE TO, DATA; (ii) SPECIAL, INCIDENTAL, CONSEQUENTIAL OR INDIRECT DAMAGES; OR (iii) LOST PROFITS, BUSINESS, REVENUE, GOODWILL, OR ANTICIPATED SAVINGS. + +Incorporation of the Wrapper into any application as further described in the Main Agreement shall not in any manner expand HCP’s liabilities under the Annual Wrapper License. Thus, HCP shall not under any circumstance be neither responsible nor liable for any aspects of such Licensee application(s), including but not limited to its reliability, uptime/downtime, functioning or fitness for purpose. Any obligations, liabilities or warranties undertaken by Licensee towards its customers with respect to such application(s) shall apply only between mentioned parties, and Licensee hereby undertakes to indemnify and hold the Licensors harmless from and against any and all losses, clams and damages related to such application(s). + +IN NO EVENT WILL THE LIABILITY OF THE LICENSORS UNDER OR IN CONNECTION WITH THESE WRAPPER T&CS OR ITS SUBJECT MATTER, UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE, EXCEED THE TOTAL WRAPPER FEE PAID BY THE LICENSEE DURING THE LAST TWELVE (12) MONTHS PRIOR TO OCCURRENCE GIVING CAUSE TO SUCH LIABILITY. + +*********************************************************** +12. Confidentiality +*********************************************************** + +As a trusted partner of Highsoft, HCP is bound by the confidentiality provisions of the Main Agreement, which shall apply similarly for the Wrapper T&Cs, and Licensee hereby grants to Highsoft the explicit right to share Confidential Information with HCP as needed. + +*********************************************************** +13. Applicable Law and Venue +*********************************************************** + +The construction, validity and operation of the Wrapper License and these Wrapper T&Cs, and the performance of all obligations hereunder, shall be governed by and construed in accordance with the laws of the Commonwealth of Massachusetts, United States of America, without regard to conflict of law principles that would result in the application of any law other than the law of the Commonwealth of Massachusetts. + +In the event of a dispute, controversy or claim between Licensee and HCP arising out of or relating to the Wrapper License and these Wrapper T&Cs, or the breach, termination, or invalidity thereof the Parties shall meet in an effort to resolve such dispute, controversy or claim amicably through negotiation. If the Parties do not reach an amicable solution within two (2) weeks of such efforts being initiated, either Party may initiate legal proceedings in the United States federal courts and state courts located in the Commonwealth of Massachusetts, which courts shall have sole and exclusive jurisdiction and venue to adjudicate any such dispute, controversy or claim. The Parties consent to the exclusive jurisdiction of the courts specified above, and expressly waive any objection to the jurisdiction or convenience of such courts. + +Any dispute, controversy or claim between Licensee and Highsoft, shall be resolved in accordance with the provisions of the Main Agreement. + +*********************************************************** +14. Processing of Personal Data +*********************************************************** + +To the extent the purchase of the Wrapper License involves processing by either Highsoft and/or HCP of personal data about the Licensee or Licensee’s customers or personnel related to the purchase of the Wrapper License, Highsoft and HCP shall be acting as joint and independent data controllers. The provisions of the Main Agreement pertaining to Highsoft’s processing of personal data shall apply similarly to any processing by Highsoft of personal data in relation to the Agreement. + +To the extent the support services performed by HCP under this Agreement involves processing by HCP of personal data about the Licensee or Licensee’s customers or personnel, HCP shall be acting as a data controller. + +*********************************************************** +15. Miscellaneous +*********************************************************** + +The provisions of the Main Agreement entitled “Miscellaneous” shall apply similarly to these Wrapper T&Cs, as applicable. \ No newline at end of file diff --git a/README.rst b/README.rst index 4874df43..0310ce99 100644 --- a/README.rst +++ b/README.rst @@ -1,20 +1,49 @@ -#################################################### -Highcharts for Python -#################################################### +################################################### +Highcharts for Python Toolkit +################################################### -**Python Wrapper for Highcharts JS** +**High-end data visualization for the Python ecosystem** -**Highcharts for Python** is a Python wrapper for the -`Highcharts `_ JS data visualization library. It is designed to -simplify management of `Highcharts `_ visualizations in Python -by providing a Python object representation of the Highcharts ``options`` configuration -and native integration with Pandas and PySpark. +The **Highcharts for Python Toolkit** is a Python library that provides a Python wrapper +for the fantastic `Highcharts JS `__ suite of JavaScript data +visualization libraries, with full integration into the robust Python ecosystem. -**COMPLETE DOCUMENTATION:** http://highcharts-python.readthedocs.org/en/latest/index.html +The toolkit is composed of several different libraries, each of which provides comprehensive support for a component of the Highcharts JS suite: -.. contents:: - :depth: 3 - :backlinks: entry +.. list-table:: + :widths: 30 30 40 + :header-rows: 1 + + * - Python Library + - JavaScript Library + - Description + * - **Highcharts Core for Python** + - `Highcharts Core (JS) `__ + - (this library) the core Highcharts data visualization library + * - `Highcharts Stock for Python `__ + - `Highcharts Stock (JS) `__ + - the robust time series visualization extension to Highcharts Core + * - `Highcharts Maps `__ + - `Highcharts Maps (JS) `__ + - the rich map visualization extension to Highcharts Core + * - `Highcharts Gantt `__ + - `Highcharts Gantt (JS) `__ + - the Gantt charting extension to Highcharts Core + * - (all libraries in the Python toolkit) + - The **Highcharts Export Server** + - enabling the programmatic creation of static (downloadable) data visualizations + +In order to integrate **Highcharts for Python** into the Python ecosystem, the library +features native integration with: + + * **Jupyter Labs/Notebook**. You can now produce high-end and interactive plots and + renders using the full suite of Highcharts visualization capabilities. + * **Pandas**. Automatically produce data visualizations from your Pandas dataframes + * **PySpark**. Automatically produce data visualizations from data in a PySpark + dataframe. + * ...and even more use-case specific integrations in each tool in the toolkit. + +**COMPLETE DOCUMENTATION:** https://highcharts-core.readthedocs.org/en/latest/index.html -------------------- @@ -22,17 +51,12 @@ and native integration with Pandas and PySpark. Installation *************** -To install **Highcharts for Python**, just execute: +To install **Highcharts Core for Python**, just execute: .. code:: bash - $ pip install highcharts-python - - -Dependencies -============== + $ pip install highcharts-core - * `Validator-Collection v1.5.0 `_ or higher ------------- @@ -40,18 +64,316 @@ Dependencies Why Highcharts for Python? ************************************ -When building professional-grade analytical applications, I've found -`Highcharts `_ to be one of the best visualization libraries out -there, providing excellent performance and extensive high-end animated, interactive data -visualization capabilities. However, `Highcharts `_ is -a pure JavaScript library that is primarily configured using a single JavaScript object -which can be inconvenient to manage within Python. - -Lacking a Pythonic object representation of the Highcharts ``options`` configuration -object, developers are forced to manage Python `dict ` objects that then -get serialized to JSON. This can be a pain, since it makes interaction across the -Python / JavaScript border (serializing to JSON, de-serializing from JSON) harder and -can make it less intuitive to manage the object's state. - -This library is meant to fix that by providing a simple class representation of the -Highcharts ``options`` configuration object. +Odds are you are aware of `Highcharts JS `__. If not, why not? +It is the world's most popular, most powerful, category-defining JavaScript data +visualization library. If you are building a web or mobile app/dashboard that will be +visualizing data in some fashion, you should absolutely take a look at the Highcharts +suite of solutions. Just take a look at some of their fantastic +`demo visualizations `_. + +`Highcharts JS `__ is a JavaScript library. It is written in +JavaScript, and is specifically used to configure and render data visualizations in a +web browser (or other JavaScript-executing) environment. As a JavaScript +library, its audience is JavaScript developers. But what about the broader ecosystem of +Python developers and data scientists? + +Python is increasingly used as the technology of choice for data science and for +the backends of leading enterprise-grade applications. In other words, Python is +often the backend that delivers data and content to the front-end...which then renders it +using JavaScript and HTML. + +There are numerous Python frameworks (Django, Flask, Tornado, etc.) with specific +capabilities to simplify integration with Javascript frontend frameworks (React, Angular, +VueJS, etc.). But facilitating that with Highcharts has historically been very difficult. +Part of this difficulty is because the Highcharts JavaScript suite - while supporting JSON as a +serialization/deserialization format - leverages +JavaScript object literals to expose the +full power and interactivity of its data visualizations. And while it's easy to serialize +JSON from Python, serializing and deserializing to/from JavaScript object literal notation +is much more complicated. This means that Python developers looking to integrate with +Highcharts typically had to either invest a lot of effort, or were only able to leverage +a small portion of Highcharts' rich functionality. + +So I wrote the **Highcharts for Python** toolkit to bridge that gap. + +**Highcharts for Python** provides Python object representation for *all* of the +JavaScript objects defined in the +`Highcharts JS API `__. It provides automatic data +validation, and exposes simple and standardized methods for serializing those Python +objects back-and-forth to JavaScript object literal notation. + +Key Highcharts for Python Features +====================================== + +* **Clean and consistent API**. No reliance on "hacky" code, ``dict`` + and JSON serialization, or impossible to maintain / copy-pasted "spaghetti code". +* **Comprehensive Highcharts Support**. Every single Highcharts chart type and every + single configuration option is supported in the **Highcharts for Python** toolkit. + This includes the over 70 data visualization types supported by + `Highcharts JS `__ and the 50+ + technical indicator visualizations available in + `Highcharts Stock `__, with full support for + the rich JavaScript formatter (JS callback functions) + capabilities that are often needed to get the most out of Highcharts' visualization and + interaction capabilities. + + .. note:: + + **See Also** + + * `Supported Visualizations `__ + +* **Simple JavaScript Code Generation**. With one method call, produce production-ready + JavaScript code to render your interactive visualizations using Highcharts' rich + capabilities. +* **Easy and Robust Chart Download**. With one method call, produce high-end static + visualizations that can be downloaded or shared as files with your audience. Produce + static charts using the Highsoft-provided **Highcharts Export Server**, or using your own private export + server as needed. +* **Integration with Pandas and PySpark**. With two lines of code, produce a high-end + interactive visualization of your Pandas or PySpark dataframe. +* **Consistent code style**. For Python developers, switching between Pythonic code + conventions and JavaScript code conventions can be...annoying. So + **Highcharts for Python** applies Pythonic syntax with automatic conversion between + Pythonic ``snake_case`` notation and JavaScript ``camelCase`` styles. + +| + +**Highcharts for Python** vs Alternatives +============================================== + +For a discussion of **Highcharts for Python** in comparison to alternatives, please see +the **COMPLETE DOCUMENTATION:** https://highcharts-core.readthedocs.org/en/latest/index.html + +--------------------- + +******************************** +Hello World, and Basic Usage +******************************** + +1. Import Highcharts Core for Python +========================================== + +.. code-block:: python + + # PRECISE-LOCATION PATTERN: BEST PRACTICE! + # This method of importing Highcharts for Python objects yields the fastest + # performance for the import statement. However, it is more verbose and requires + # you to navigate the extensive Highcharts Core for Python API. + + # Import classes using precise module indications. For example: + from highcharts_core.chart import Chart + from highcharts_core.global_options.shared_options import SharedOptions + from highcharts_core.options import HighchartsOptions + from highcharts_core.options.plot_options.bar import BarOptions + from highcharts_core.options.series.bar import BarSeries + + # CATCH-ALL PATTERN + # This method of importing Highcharts for Python classes has relatively slow + # performance because it imports hundreds of different classes from across the entire + # library. This performance impact may be acceptable to you in your use-case, but + # do use at your own risk. + + # Import objects from the catch-all ".highcharts" module. + from highcharts_core import highcharts + + # You can now access specific classes without individual import statements. + highcharts.Chart + highcharts.SharedOptions + highcharts.HighchartsOptions + highcharts.BarOptions + highcharts.BarSeries + + +2. Create Your Chart +================================ + + .. code-block:: python + + # from a JavaScript file + my_chart = highcharts.Chart.from_js_literal('my_js_literal.js') + + # from a JSON file + my_chart = highcharts.Chart.from_json('my_json.json') + + # from a Python dict + my_chart = highcharts.Chart.from_dict(my_dict_obj) + + # from a Pandas dataframe + my_chart = highcharts.Chart.from_pandas(df, + property_map = { + 'x': 'transactionDate', + 'y': 'invoiceAmt', + 'id': 'id' + }, + series_type = 'line') + + # from a PySpark dataframe + my_chart = highcharts.Chart.from_pyspark(df, + property_map = { + 'x': 'transactionDate', + 'y': 'invoiceAmt', + 'id': 'id' + }, + series_type = 'line') + + # from a CSV + my_chart = highcharts.Chart.from_csv('/some_file_location/filename.csv' + column_property_map = { + 'x': 0, + 'y': 4, + 'id': 14 + }, + series_type = 'line') + + # from a HighchartsOptions configuration object + my_chart = highcharts.Chart.from_options(my_options) + + # from a Series configuration + my_chart = highcharts.Chart.from_series(my_series) + + +3. Configure Global Settings (optional) +============================================= + + .. code-block:: python + + # Import SharedOptions + from highcharts_core.global_options.shared_options import SharedOptions + + # from a JavaScript file + my_global_settings = SharedOptions.from_js_literal('my_js_literal.js') + + # from a JSON file + my_global_settings = SharedOptions.from_json('my_json.json') + + # from a Python dict + my_global_settings = SharedOptions.from_dict(my_dict_obj) + + # from a HighchartsOptions configuration object + my_global_settings = SharedOptions.from_options(my_options) + + +4. Configure Your Chart / Global Settings +================================================ + + .. code-block:: python + + from highcharts_core.options.title import Title + from highcharts_core.options.credits import Credits + + # Using dicts + my_chart.title = { + 'align': 'center' + 'floating': True, + 'text': 'The Title for My Chart', + 'use_html': False, + } + + my_chart.credits = { + 'enabled': True, + 'href': 'https://www.highcharts.com/', + 'position': { + 'align': 'center', + 'vertical_align': 'bottom', + 'x': 123, + 'y': 456 + }, + 'style': { + 'color': '#cccccc', + 'cursor': 'pointer', + 'font_size': '9px' + }, + 'text': 'Chris Modzelewski' + } + + # Using direct objects + from highcharts_core.options.title import Title + from highcharts_core.options.credits import Credits + + my_title = Title(text = 'The Title for My Chart', floating = True, align = 'center') + my_chart.options.title = my_title + + my_credits = Credits(text = 'Chris Modzelewski', enabled = True, href = 'https://www.highcharts.com') + my_chart.options.credits = my_credits + + +5. Generate the JavaScript Code for Your Chart +================================================= + +Now having configured your chart in full, you can easily generate the JavaScript code +that will render the chart wherever it is you want it to go: + + .. code-block:: python + + # as a string + js_as_str = my_chart.to_js_literal() + + # to a file (and as a string) + js_as_str = my_chart.to_js_literal(filename = 'my_target_file.js') + + +6. Generate the JavaScript Code for Your Global Settings (optional) +========================================================================= + + .. code-block:: python + + # as a string + global_settings_js = my_global_settings.to_js_literal() + + # to a file (and as a string) + global_settings_js = my_global_settings.to_js_literal('my_target_file.js') + + +7. Generate a Static Version of Your Chart +============================================== + + .. code-block:: python + + # as in-memory bytes + my_image_bytes = my_chart.download_chart(format = 'png') + + # to an image file (and as in-memory bytes) + my_image_bytes = my_chart.download_chart(filename = 'my_target_file.png', + format = 'png') + +-------------- + +*********************** +Getting Help/Support +*********************** + +The **Highcharts for Python** toolkit comes with all of the great support that you are used to from working with the +Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following tools to get +help using the toolkit. In particular, you can: + + * Use the `Highcharts Forums `__ + * Use `Stack Overflow `__ with the + ``highcharts-for-python`` tag + * `Report bugs or request features `__ in the + library's Github repository + * `File a support ticket `__ with us + * `Schedule a live chat or video call `__ with us + +**FOR MORE INFORMATION:** https://www.highchartspython.com/get-help + +----------------- + +********************* +Contributing +********************* + +We welcome contributions and pull requests! For more information, please see the +`Contributor Guide `__. And thanks to all those who've already contributed! + +------------------- + +********************* +Testing +********************* + +We use `TravisCI `_ for our build automation and +`ReadTheDocs `_ for our documentation. + +Detailed information about our test suite and how to run tests locally can be +found in our Testing Reference. diff --git a/docs/_contributors.rst b/docs/_contributors.rst index 9396d7b4..ebae4db5 100644 --- a/docs/_contributors.rst +++ b/docs/_contributors.rst @@ -1 +1,2 @@ -* Chris Modzelewski (`@insightindustry `_) +* Chris Modzelewski (`@hcpchris `__ / `@insightindustry `__) +* Erin Modzelewski (`@EBModz `__) \ No newline at end of file diff --git a/docs/_dependencies.rst b/docs/_dependencies.rst index 246a9e30..47fe2bc9 100644 --- a/docs/_dependencies.rst +++ b/docs/_dependencies.rst @@ -1,6 +1,6 @@ .. note:: - **Highcharts for Python** has several types of dependencies: + **Highcharts Core for Python** has several types of dependencies: * "hard" dependencies, without which you will not be able to use the library at all, * "soft" dependencies, which will not produce errors but which may limit the value you @@ -16,15 +16,19 @@ .. warning:: If these hard dependencies are not available in the environment where - **Highcharts for Python** is running, then the library will simply not work. Besides + **Highcharts Core for Python** is running, then the library will simply not work. Besides Highcharts JS itself, all of the other hard dependencies are automatically installed - when installing **Highcharts for Python**. + when installing **Highcharts Core for Python** using: + + .. code-block:: bash + + $ pip install highcharts-core * `Highcharts JS `__ v.10.2 or higher .. note:: - Not technically a Python dependency, but obviously **Highcharts for Python** will + Not technically a Python dependency, but obviously **Highcharts Core for Python** will not work properly if your rendering layer does not leverage Highcharts JS. * `esprima-python `_ v.4.0 or higher @@ -37,7 +41,7 @@ .. warning:: If these soft dependencies are not available in the environment where - **Highcharts for Python** is running, then the library will throw a + **Highcharts Core for Python** is running, then the library will throw a :exc:`HighchartsDependencyError ` exception when you try to use functionality that relies on them. @@ -45,16 +49,17 @@ a ``from_pandas()`` method but `pandas `_ is not installed, you will get an error. + You can install *all* soft dependencies by executing: + + .. code-block:: bash + + $ pip install highcharts-core[soft] + + * `IPython `__ v. 8.10 or higher + * `orjson `__ v.3.7.7 or higher * `pandas `_ v. 1.3 or higher * `pyspark `_ v.3.3 or higher - * `python-dotenv `_ v. 0.21 or higher - - .. note:: - - `python-dotenv `_ will fail silently if - not available, as it will only leverage natural environment variables rather than - a ``.env`` file in the runtime environment. .. tab:: Developer @@ -66,11 +71,21 @@ .. code-block:: bash - $ pip install highcharts-python[develop] + $ pip install highcharts-core[dev] * `pytest `_ v.7.1 or higher * `pytest-cov `_ v.3.0 or higher * `pytest-xdist `_ v.2.5 or higher + * `python-dotenv `_ v. 0.21 or higher + + .. note:: + + `python-dotenv `_ will fail silently if + not available, as it will only leverage natural environment variables rather than + a ``.env`` file in the runtime environment. + + * `pytz `__ v.2022.1 or higher + * `tox `__ v.4.0.0 or higher .. tab:: Documentation @@ -81,10 +96,10 @@ .. code-block:: bash - $ pip install highcharts-python[docs] + $ pip install highcharts-core[docs] - * `Sphinx `_ v.5.1 or higher - * `Sphinx RTD Theme `_ v.1.0 + * `Sphinx `_ v.6.1.3 or higher + * `Sphinx RTD Theme `_ v.1.2 or higher * `sphinx-tabs `_ v.3.4.1 or higher - * `Sphinx Toolbox `_ v.3.2 or higher + * `Sphinx Toolbox `_ v.3.4 or higher diff --git a/docs/_installation.rst b/docs/_installation.rst index 8bbc3628..a2b2bfe2 100644 --- a/docs/_installation.rst +++ b/docs/_installation.rst @@ -2,4 +2,4 @@ To install **Highcharts for Python**, just execute: .. code-block:: bash - $ pip install highcharts-python + $ pip install highcharts-core diff --git a/docs/_static/axis-property-mapping.xlsx b/docs/_static/axis-property-mapping.xlsx index 2177a64b..f620379c 100644 Binary files a/docs/_static/axis-property-mapping.xlsx and b/docs/_static/axis-property-mapping.xlsx differ diff --git a/docs/_static/gantt-example.png b/docs/_static/gantt-example.png new file mode 100644 index 00000000..5a8f362f Binary files /dev/null and b/docs/_static/gantt-example.png differ diff --git a/docs/_static/highcharts-for-python-dark-32x32.png b/docs/_static/highcharts-for-python-dark-32x32.png new file mode 100644 index 00000000..9498b40a Binary files /dev/null and b/docs/_static/highcharts-for-python-dark-32x32.png differ diff --git a/docs/_static/highcharts-for-python-light-150x149.png b/docs/_static/highcharts-for-python-light-150x149.png new file mode 100644 index 00000000..b84cca48 Binary files /dev/null and b/docs/_static/highcharts-for-python-light-150x149.png differ diff --git a/docs/_static/map-example.png b/docs/_static/map-example.png new file mode 100644 index 00000000..b4572359 Binary files /dev/null and b/docs/_static/map-example.png differ diff --git a/docs/_static/mapbubble-example.png b/docs/_static/mapbubble-example.png new file mode 100644 index 00000000..8ec8ea2b Binary files /dev/null and b/docs/_static/mapbubble-example.png differ diff --git a/docs/_static/mapline-example.png b/docs/_static/mapline-example.png new file mode 100644 index 00000000..0b37c785 Binary files /dev/null and b/docs/_static/mapline-example.png differ diff --git a/docs/_static/mappoint-example.png b/docs/_static/mappoint-example.png new file mode 100644 index 00000000..0b37c785 Binary files /dev/null and b/docs/_static/mappoint-example.png differ diff --git a/docs/_support.rst b/docs/_support.rst new file mode 100644 index 00000000..0b8c3db0 --- /dev/null +++ b/docs/_support.rst @@ -0,0 +1,13 @@ +The **Highcharts for Python** toolkit comes with all of the great support that you are used to from working with the +Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following tools to get +help using the toolkit. In particular, you can: + + * Use the `Highcharts Forums `__ + * Use `Stack Overflow `__ with the + ``highcharts-for-python`` tag + * `Report bugs or request features `__ in the + library's Github repository + * `File a support ticket `__ with us + * `Schedule a live chat or video call `__ with us + +**FOR MORE INFORMATION:** https://www.highchartspython.com/get-help \ No newline at end of file diff --git a/docs/_unit_tests_code_coverage.rst b/docs/_unit_tests_code_coverage.rst new file mode 100644 index 00000000..e7661e75 --- /dev/null +++ b/docs/_unit_tests_code_coverage.rst @@ -0,0 +1,3 @@ +.. todo:: + + Add unit tests and code coverage badges / details. \ No newline at end of file diff --git a/docs/api.rst b/docs/api.rst index 6c127626..15edd7d8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -24,7 +24,7 @@ Standard Methods Every single object supported by the `Highcharts JS API `__ corresponds to a Python class in **Highcharts for Python**. These classes generally inherit from the -:class:`HighchartsMeta ` metaclass, which +:class:`HighchartsMeta ` metaclass, which provides each class with a number of standard methods. These methods are the "workhorses" of **Highcharts for Python** and you will be relying @@ -96,530 +96,533 @@ Core Components * - Module - Classes / Functions - * - :mod:`.chart ` - - :class:`Chart ` - * - :mod:`.global_options ` + * - :mod:`.chart ` + - :class:`Chart ` + * - :mod:`.global_options ` - - * - :mod:`.global_options.language ` - - :class:`Language ` - * - :mod:`.global_options.language.accessibility ` - - :class:`AccessibilityLanguageOptions ` - * - :mod:`.global_options.language.accessibility.announce_new_data ` - - :class:`AnnounceNewDataLanguageOptions ` - * - :mod:`.global_options.language.accessibility.axis ` - - :class:`AxisLanguageOptions ` - * - :mod:`.global_options.language.accessibility.chart_types ` - - :class:`ChartTypesLanguageOptions ` - * - :mod:`.global_options.language.accessibility.exporting ` - - :class:`ExportingLanguageOptions ` - * - :mod:`.global_options.language.accessibility.legend ` - - :class:`LegendLanguageOptions ` - * - :mod:`.global_options.language.accessibility.range_selector ` - - :class:`RangeSelectorLanguageOptions ` - * - :mod:`.global_options.language.accessibility.screen_reader_section ` - - :class:`ScreenReaderSectionLanguageOptions ` - :class:`ScreenReaderSectionAnnotationLanguage ` - * - :mod:`.global_options.language.accessibility.series ` - - :class:`SeriesLanguageOptions ` - :class:`SeriesSummaryLanguageOptions ` - :class:`SeriesTypeDescriptions ` - * - :mod:`.global_options.language.accessibility.sonification ` - - :class:`SonificationLanguageOptions ` - * - :mod:`.global_options.language.accessibility.table ` - - :class:`TableLanguageOptions ` - * - :mod:`.global_options.language.accessibility.zoom ` - - :class:`ZoomLanguageOptions ` - * - :mod:`.global_options.language.export_data ` - - :class:`ExportDataLanguageOptions ` - * - :mod:`.global_options.language.navigation ` - - :class:`NavigationLanguageOptions ` - :class:`PopupLanguageOptions ` - * - :mod:`.global_options.shared_options ` - - :class:`SharedOptions ` - * - :mod:`.headless_export ` - - :class:`ExportServer ` - * - :mod:`.highcharts ` + * - :mod:`.global_options.language ` + - :class:`Language ` + * - :mod:`.global_options.language.accessibility ` + - :class:`AccessibilityLanguageOptions ` + * - :mod:`.global_options.language.accessibility.announce_new_data ` + - :class:`AnnounceNewDataLanguageOptions ` + * - :mod:`.global_options.language.accessibility.axis ` + - :class:`AxisLanguageOptions ` + * - :mod:`.global_options.language.accessibility.chart_types ` + - :class:`ChartTypesLanguageOptions ` + * - :mod:`.global_options.language.accessibility.exporting ` + - :class:`ExportingLanguageOptions ` + * - :mod:`.global_options.language.accessibility.legend ` + - :class:`LegendLanguageOptions ` + * - :mod:`.global_options.language.accessibility.range_selector ` + - :class:`RangeSelectorLanguageOptions ` + * - :mod:`.global_options.language.accessibility.screen_reader_section ` + - :class:`ScreenReaderSectionLanguageOptions ` + :class:`ScreenReaderSectionAnnotationLanguage ` + * - :mod:`.global_options.language.accessibility.series ` + - :class:`SeriesLanguageOptions ` + :class:`SeriesSummaryLanguageOptions ` + :class:`SeriesTypeDescriptions ` + * - :mod:`.global_options.language.accessibility.sonification ` + - :class:`SonificationLanguageOptions ` + * - :mod:`.global_options.language.accessibility.table ` + - :class:`TableLanguageOptions ` + * - :mod:`.global_options.language.accessibility.zoom ` + - :class:`ZoomLanguageOptions ` + * - :mod:`.global_options.language.export_data ` + - :class:`ExportDataLanguageOptions ` + * - :mod:`.global_options.language.navigation ` + - :class:`NavigationLanguageOptions ` + :class:`PopupLanguageOptions ` + * - :mod:`.global_options.shared_options ` + - :class:`SharedOptions ` + * - :mod:`.headless_export ` + - :class:`ExportServer ` + * - :mod:`.highcharts ` - (most classes from across the rest of the API) - * - :mod:`.options ` - - :class:`HighchartsOptions ` - :class:`Options ` - * - :mod:`.options.accessibility ` - - :class:`Accessibility ` - :class:`CustomAccessibilityComponents ` - * - :mod:`.options.accessibility.announce_new_data ` - - :class:`AnnounceNewData ` - * - :mod:`.options.accessibility.keyboard_navigation ` - - :class:`KeyboardNavigation ` - * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` - - :class:`FocusBorder ` - :class:`FocusBorderStyle ` - * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` - - :class:`SeriesNavigation ` - * - :mod:`options.accessibility.point ` - - :class:`AccessibilityPoint ` - * - :mod:`options.accessibility.screen_reader_section ` - - :class:`ScreenReaderSection ` - * - :mod:`options.accessibility.series ` - - :class:`SeriesAccessibility ` - * - :mod:`.options.annotations ` - - :class:`Annotation ` - * - :mod:`.options.annotations.animation ` - - :class:`AnnotationAnimation ` - * - :mod:`.options.annotations.control_point_options ` - - :class:`AnnotationControlPointOption ` - * - :mod:`.options.annotations.events ` - - :class:`AnnotationEvent ` - * - :mod:`.options.annotations.label_options ` - - :class:`AnnotationLabel ` - :class:`AnnotationLabelOptionAccessibility ` - :class:`LabelOptions ` - * - :mod:`.options.annotations.options.annotations.points ` - - :class:`AnnotationPoint ` - * - :mod:`.options.annotations.shape_options ` - - :class:`AnnotationShape ` - :class:`ShapeOptions ` - * - :mod:`.options.axes ` + * - :mod:`.options ` + - :class:`HighchartsOptions ` + :class:`Options ` + * - :mod:`.options.accessibility ` + - :class:`Accessibility ` + :class:`CustomAccessibilityComponents ` + * - :mod:`.options.accessibility.announce_new_data ` + - :class:`AnnounceNewData ` + * - :mod:`.options.accessibility.keyboard_navigation ` + - :class:`KeyboardNavigation ` + * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` + - :class:`FocusBorder ` + :class:`FocusBorderStyle ` + * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` + - :class:`SeriesNavigation ` + * - :mod:`options.accessibility.point ` + - :class:`AccessibilityPoint ` + * - :mod:`options.accessibility.screen_reader_section ` + - :class:`ScreenReaderSection ` + * - :mod:`options.accessibility.series ` + - :class:`SeriesAccessibility ` + * - :mod:`.options.annotations ` + - :class:`Annotation ` + * - :mod:`.options.annotations.animation ` + - :class:`AnnotationAnimation ` + * - :mod:`.options.annotations.control_point_options ` + - :class:`AnnotationControlPointOption ` + * - :mod:`.options.annotations.events ` + - :class:`AnnotationEvent ` + * - :mod:`.options.annotations.label_options ` + - :class:`AnnotationLabel ` + :class:`AnnotationLabelOptionAccessibility ` + :class:`LabelOptions ` + * - :mod:`.options.annotations.options.annotations.points ` + - :class:`AnnotationPoint ` + * - :mod:`.options.annotations.shape_options ` + - :class:`AnnotationShape ` + :class:`ShapeOptions ` + * - :mod:`.options.axes ` - - * - :mod:`.options.axes.accessibility ` - - :class:`AxisAccessibility ` - * - :mod:`.options.axes.breaks ` - - :class:`AxisBreak ` - * - :mod:`.options.axes.color_axis ` - - :class:`ColorAxis ` - * - :mod:`.options.axes.crosshair ` - - :class:`CrosshairOptions ` - * - :mod:`.options.axes.data_classes ` - - :class:`DataClass ` - * - :mod:`.options.axes.generic ` - - :class:`GenericAxis ` - * - :mod:`.options.axes.labels ` - - :class:`AxisLabelOptions ` - :class:`PlotBandLabel ` - :class:`PlotLineLabel ` - * - :mod:`.options.axes.markers ` - - :class:`AxisMarker ` - * - :mod:`.options.axes.numeric ` - - :class:`NumericAxis ` - * - :mod:`.options.axes.parallel_axes ` - - :class:`ParallelAxesOptions ` - * - :mod:`.options.axes.plot_bands ` - - :class:`PlotBand ` - :class:`PlotLine ` - * - :mod:`.options.axes.title ` - - :class:`AxisTitle ` - * - :mod:`.options.axes.x_axis ` - - :class:`XAxis ` - * - :mod:`.options.axes.y_axis ` - - :class:`YAxis ` - * - :mod:`.options.axes.z_axis ` - - :class:`ZAxis ` - * - :mod:`.options.boost ` - - :class:`Boost ` - :class:`BoostDebug ` - * - :mod:`.options.caption ` - - :class:`Caption ` - * - :mod:`.options.chart ` - - :class:`ChartOptions ` - :class:`PanningOptions ` - * - :mod:`.chart.options_3d ` - - :class:`Options3D ` - :class:`Frame ` - :class:`PanelOptions ` - * - :mod:`.chart.reset_zoom_button ` - - :class:`ResetZoomButtonOptions ` - * - :mod:`.chart.scrollable_plot_area ` - - :class:`ScrollablePlotArea ` - * - :mod:`.options.credits ` - - :class:`Credits ` - :class:`CreditStyleOptions ` - * - :mod:`.options.data ` - - :class:`Data ` - * - :mod:`.options.defs ` - - :class:`MarkerDefinition ` - :class:`MarkerASTNode ` - :class:`MarkerAttributeObject ` - * - :mod:`.options.drilldown ` - - :class:`Drilldown ` - * - :mod:`.options.exporting ` - - :class:`Exporting ` - :class:`ExportingAccessibilityOptions ` - * - :mod:`.options.exporting.csv ` - - :class:`ExportingCSV ` - :class:`CSVAnnotationOptions ` - * - :mod:`.options.exporting.exporting.pdf_font ` - - :class:`PDFFontOptions ` - * - :mod:`.options.legend ` - - :class:`Legend ` - * - :mod:`.options.legend.accessibility ` - - :class:`LegendAccessibilityOptions ` - :class:`LegendKeyboardNavigation ` - * - :mod:`.options.legend.bubble_legend ` - - :class:`BubbleLegend ` - :class:`BubbleLegendRange ` - :class:`BubbleLegendLabelOptions ` - * - :mod:`.options.legend.navigation ` - - :class:`LegendNavigation ` - * - :mod:`.options.legend.title ` - - :class:`LegendTitle ` - * - :mod:`.options.loading ` - - :class:`Loading ` - * - :mod:`.options.navigation ` - - :class:`Navigation ` - * - :mod:`.options.navigation.bindings ` - - :class:`Bindings ` - :class:`RectangleAnnotationBinding ` - :class:`LabelAnnotationBinding ` - :class:`EllipseAnnotationBinding ` - :class:`CircleAnnotationBinding ` - :class:`Binding ` - * - :mod:`.options.no_data ` - - :class:`NoData ` - * - :mod:`.options.pane ` - - :class:`Pane ` - :class:`PaneBackground ` - * - :mod:`.options.plot_options ` - - :class:`PlotOptions ` - * - :mod:`.options.plot_options.accessibility ` - - :class:`TypeOptionsAccessibility ` - :class:`SeriesKeyboardNavigation ` - * - :mod:`.options.plot_options.arcdiagram ` - - :class:`ArcDiagramOptions ` - * - :mod:`.options.plot_options.area ` - - :class:`AreaOptions ` - :class:`AreaRangeOptions ` - :class:`AreaSplineOptions ` - :class:`AreaSplineRangeOptions ` - :class:`LineOptions ` - :class:`StreamGraphOptions ` - * - :mod:`.options.plot_options.bar ` - - :class:`BarOptions ` - :class:`ColumnOptions ` - :class:`ColumnPyramidOptions ` - :class:`ColumnRangeOptions ` - :class:`CylinderOptions ` - :class:`VariwideOptions ` - :class:`WaterfallOptions ` - :class:`WindBarbOptions ` - :class:`XRangeOptions ` - :class:`BaseBarOptions ` - * - :mod:`.options.plot_options.bellcurve ` - - :class:`BellCurveOptions ` - * - :mod:`.options.plot_options.boxplot ` - - :class:`BoxPlotOptions ` - :class:`ErrorBarOptions ` - * - :mod:`.options.plot_options.bubble ` - - :class:`BubbleOptions ` - * - :mod:`.options.plot_options.bullet ` - - :class:`BulletOptions ` - :class:`TargetOptions ` - * - :mod:`.options.plot_options.data_sorting ` - - :class:`DataSorting ` - * - :mod:`.options.plot_options.dependencywheel ` - - :class:`DependencyWheelOptions ` - * - :mod:`.options.plot_options.drag_drop ` - - :class:`DragDropOptions ` - :class:`HighLowDragDropOptions ` - :class:`BoxPlotDragDropOptions ` - :class:`BulletDragDropOptions ` - :class:`GuideBox ` - :class:`GuideBoxOptions ` - :class:`DragHandle ` - * - :mod:`.options.plot_options.dumbbell ` - - :class:`DumbbellOptions ` - :class:`LollipopOptions ` - * - :mod:`.options.plot_options.funnel ` - - :class:`FunnelOptions ` - :class:`Funnel3DOptions ` - * - :mod:`.options.plot_options.gauge ` - - :class:`GaugeOptions ` - :class:`SolidGaugeOptions ` - * - :mod:`.options.plot_options.generic ` - - :class:`GenericTypeOptions ` - * - :mod:`.options.plot_options.Heatmap ` - - :class:`HeatmapOptions ` - :class:`TilemapOptions ` - * - :mod:`.options.plot_options.histogram ` - - :class:`HistogramOptions ` - * - :mod:`.options.plot_options.item ` - - :class:`ItemOptions ` - * - :mod:`.options.plot_options.levels ` - - :class:`LevelOptions ` - :class:`SunburstLevelOptions ` - :class:`TreemapLevelOptions ` - :class:`LevelSize ` - :class:`ColorVariation ` - :class:`BaseLevelOptions ` - * - :mod:`.options.plot_options.link ` - - :class:`LinkOptions ` - * - :mod:`.options.plot_options.networkgraph ` - - :class:`NetworkGraphOptions ` - :class:`LayoutAlgorithm ` - * - :mod:`.options.plot_options.organization ` - - :class:`OrganizationOptions ` - * - :mod:`.options.plot_options.packedbubble ` - - :class:`PackedBubbleOptions ` - :class:`ParentNodeOptions ` - * - :mod:`.options.plot_options.pareto ` - - :class:`ParetoOptions ` - * - :mod:`.options.plot_options.pie ` - - :class:`PieOptions ` - :class:`VariablePieOptions ` - * - :mod:`.options.plot_options.points ` - - :class:`Point ` - :class:`OnPointOptions ` - :class:`ConnectorOptions ` - * - :mod:`.options.plot_options.polygon ` - - :class:`PolygonOptions ` - * - :mod:`.options.plot_options.pyramid ` - - :class:`PyramidOptions ` - :class:`Pyramid3DOptions ` - * - :mod:`.options.plot_options.sankey ` - - :class:`SankeyOptions ` - * - :mod:`.options.plot_options.scatter ` - - :class:`ScatterOptions ` - :class:`Scatter3DOptions ` - * - :mod:`.options.plot_options.series ` - - :class:`SeriesOptions ` - * - :mod:`.options.plot_options.spline ` - - :class:`SplineOptions ` - * - :mod:`.options.plot_options.sunburst ` - - :class:`SunburstOptions ` - * - :mod:`.options.plot_options.timeline ` - - :class:`TimelineOptions ` - * - :mod:`.options.plot_options.treemap ` - - :class:`TreemapOptions ` - * - :mod:`.options.plot_options.vector ` - - :class:`VectorOptions ` - * - :mod:`.options.plot_options.venn ` - - :class:`VennOptions ` - * - :mod:`.options.plot_options.wordcloud ` - - :class:`WordcloudOptions ` - :class:`RotationOptions ` - * - :mod:`.options.responsive ` - - :class:`Responsive ` - :class:`ResponsiveRules ` - :class:`Condition ` - * - :mod:`.options.series ` + * - :mod:`.options.axes.accessibility ` + - :class:`AxisAccessibility ` + * - :mod:`.options.axes.breaks ` + - :class:`AxisBreak ` + * - :mod:`.options.axes.color_axis ` + - :class:`ColorAxis ` + * - :mod:`.options.axes.crosshair ` + - :class:`CrosshairOptions ` + * - :mod:`.options.axes.data_classes ` + - :class:`DataClass ` + * - :mod:`.options.axes.generic ` + - :class:`GenericAxis ` + * - :mod:`.options.axes.labels ` + - :class:`AxisLabelOptions ` + :class:`PlotBandLabel ` + :class:`PlotLineLabel ` + * - :mod:`.options.axes.markers ` + - :class:`AxisMarker ` + * - :mod:`.options.axes.numeric ` + - :class:`NumericAxis ` + * - :mod:`.options.axes.parallel_axes ` + - :class:`ParallelAxesOptions ` + * - :mod:`.options.axes.plot_bands ` + - :class:`PlotBand ` + :class:`PlotLine ` + * - :mod:`.options.axes.title ` + - :class:`AxisTitle ` + * - :mod:`.options.axes.x_axis ` + - :class:`XAxis ` + * - :mod:`.options.axes.y_axis ` + - :class:`YAxis ` + * - :mod:`.options.axes.z_axis ` + - :class:`ZAxis ` + * - :mod:`.options.boost ` + - :class:`Boost ` + :class:`BoostDebug ` + * - :mod:`.options.caption ` + - :class:`Caption ` + * - :mod:`.options.chart ` + - :class:`ChartOptions ` + :class:`PanningOptions ` + * - :mod:`.options.chart.options_3d ` + - :class:`Options3D ` + :class:`Frame ` + :class:`PanelOptions ` + * - :mod:`.options.chart.reset_zoom_button ` + - :class:`ResetZoomButtonOptions ` + * - :mod:`.options.chart.scrollable_plot_area ` + - :class:`ScrollablePlotArea ` + * - :mod:`.options.chart.zooming ` + - :class:`ZoomingOptions ` + * - :mod:`.options.credits ` + - :class:`Credits ` + :class:`CreditStyleOptions ` + * - :mod:`.options.data ` + - :class:`Data ` + * - :mod:`.options.defs ` + - :class:`MarkerDefinition ` + :class:`MarkerASTNode ` + :class:`MarkerAttributeObject ` + * - :mod:`.options.drilldown ` + - :class:`Drilldown ` + * - :mod:`.options.exporting ` + - :class:`Exporting ` + :class:`ExportingAccessibilityOptions ` + * - :mod:`.options.exporting.csv ` + - :class:`ExportingCSV ` + :class:`CSVAnnotationOptions ` + * - :mod:`.options.exporting.exporting.pdf_font ` + - :class:`PDFFontOptions ` + * - :mod:`.options.legend ` + - :class:`Legend ` + * - :mod:`.options.legend.accessibility ` + - :class:`LegendAccessibilityOptions ` + :class:`LegendKeyboardNavigation ` + * - :mod:`.options.legend.bubble_legend ` + - :class:`BubbleLegend ` + :class:`BubbleLegendRange ` + :class:`BubbleLegendLabelOptions ` + * - :mod:`.options.legend.navigation ` + - :class:`LegendNavigation ` + * - :mod:`.options.legend.title ` + - :class:`LegendTitle ` + * - :mod:`.options.loading ` + - :class:`Loading ` + * - :mod:`.options.navigation ` + - :class:`Navigation ` + * - :mod:`.options.navigation.bindings ` + - :class:`Bindings ` + :class:`RectangleAnnotationBinding ` + :class:`LabelAnnotationBinding ` + :class:`EllipseAnnotationBinding ` + :class:`CircleAnnotationBinding ` + :class:`Binding ` + * - :mod:`.options.no_data ` + - :class:`NoData ` + * - :mod:`.options.pane ` + - :class:`Pane ` + :class:`PaneBackground ` + * - :mod:`.options.plot_options ` + - :class:`PlotOptions ` + * - :mod:`.options.plot_options.accessibility ` + - :class:`TypeOptionsAccessibility ` + :class:`SeriesKeyboardNavigation ` + * - :mod:`.options.plot_options.arcdiagram ` + - :class:`ArcDiagramOptions ` + * - :mod:`.options.plot_options.area ` + - :class:`AreaOptions ` + :class:`AreaRangeOptions ` + :class:`AreaSplineOptions ` + :class:`AreaSplineRangeOptions ` + :class:`LineOptions ` + :class:`StreamGraphOptions ` + * - :mod:`.options.plot_options.bar ` + - :class:`BarOptions ` + :class:`ColumnOptions ` + :class:`ColumnPyramidOptions ` + :class:`ColumnRangeOptions ` + :class:`CylinderOptions ` + :class:`VariwideOptions ` + :class:`WaterfallOptions ` + :class:`WindBarbOptions ` + :class:`XRangeOptions ` + :class:`BaseBarOptions ` + * - :mod:`.options.plot_options.bellcurve ` + - :class:`BellCurveOptions ` + * - :mod:`.options.plot_options.boxplot ` + - :class:`BoxPlotOptions ` + :class:`ErrorBarOptions ` + * - :mod:`.options.plot_options.bubble ` + - :class:`BubbleOptions ` + * - :mod:`.options.plot_options.bullet ` + - :class:`BulletOptions ` + :class:`TargetOptions ` + * - :mod:`.options.plot_options.data_sorting ` + - :class:`DataSorting ` + * - :mod:`.options.plot_options.dependencywheel ` + - :class:`DependencyWheelOptions ` + * - :mod:`.options.plot_options.drag_drop ` + - :class:`DragDropOptions ` + :class:`HighLowDragDropOptions ` + :class:`BoxPlotDragDropOptions ` + :class:`BulletDragDropOptions ` + :class:`GuideBox ` + :class:`GuideBoxOptions ` + :class:`DragHandle ` + * - :mod:`.options.plot_options.dumbbell ` + - :class:`DumbbellOptions ` + :class:`LollipopOptions ` + * - :mod:`.options.plot_options.funnel ` + - :class:`FunnelOptions ` + :class:`Funnel3DOptions ` + * - :mod:`.options.plot_options.gauge ` + - :class:`GaugeOptions ` + :class:`SolidGaugeOptions ` + * - :mod:`.options.plot_options.generic ` + - :class:`GenericTypeOptions ` + * - :mod:`.options.plot_options.Heatmap ` + - :class:`HeatmapOptions ` + :class:`TilemapOptions ` + * - :mod:`.options.plot_options.histogram ` + - :class:`HistogramOptions ` + * - :mod:`.options.plot_options.item ` + - :class:`ItemOptions ` + * - :mod:`.options.plot_options.levels ` + - :class:`LevelOptions ` + :class:`SunburstLevelOptions ` + :class:`TreemapLevelOptions ` + :class:`LevelSize ` + :class:`ColorVariation ` + :class:`BaseLevelOptions ` + * - :mod:`.options.plot_options.link ` + - :class:`LinkOptions ` + * - :mod:`.options.plot_options.networkgraph ` + - :class:`NetworkGraphOptions ` + :class:`LayoutAlgorithm ` + * - :mod:`.options.plot_options.organization ` + - :class:`OrganizationOptions ` + * - :mod:`.options.plot_options.packedbubble ` + - :class:`PackedBubbleOptions ` + :class:`ParentNodeOptions ` + * - :mod:`.options.plot_options.pareto ` + - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pie ` + - :class:`PieOptions ` + :class:`VariablePieOptions ` + * - :mod:`.options.plot_options.points ` + - :class:`Point ` + :class:`OnPointOptions ` + :class:`ConnectorOptions ` + * - :mod:`.options.plot_options.polygon ` + - :class:`PolygonOptions ` + * - :mod:`.options.plot_options.pyramid ` + - :class:`PyramidOptions ` + :class:`Pyramid3DOptions ` + * - :mod:`.options.plot_options.sankey ` + - :class:`SankeyOptions ` + * - :mod:`.options.plot_options.scatter ` + - :class:`ScatterOptions ` + :class:`Scatter3DOptions ` + * - :mod:`.options.plot_options.series ` + - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.spline ` + - :class:`SplineOptions ` + * - :mod:`.options.plot_options.sunburst ` + - :class:`SunburstOptions ` + * - :mod:`.options.plot_options.timeline ` + - :class:`TimelineOptions ` + * - :mod:`.options.plot_options.treemap ` + - :class:`TreemapOptions ` + * - :mod:`.options.plot_options.vector ` + - :class:`VectorOptions ` + * - :mod:`.options.plot_options.venn ` + - :class:`VennOptions ` + * - :mod:`.options.plot_options.wordcloud ` + - :class:`WordcloudOptions ` + :class:`RotationOptions ` + * - :mod:`.options.responsive ` + - :class:`Responsive ` + :class:`ResponsiveRules ` + :class:`Condition ` + * - :mod:`.options.series ` - - * - :mod:`.options.series.arcdiagram ` - - :class:`ArcDiagramSeries ` - * - :mod:`.options.series.area ` - - :class:`AreaSeries ` - :class:`AreaRangeSeries ` - :class:`AreaSplineSeries ` - :class:`AreaSplineRangeSeries ` - :class:`LineSeries ` - :class:`StreamGraphSeries ` - * - :mod:`.options.series.bar ` - - :class:`BarSeries ` - :class:`ColumnSeries ` - :class:`ColumnPyramidSeries ` - :class:`ColumnRangeSeries ` - :class:`CylinderSeries ` - :class:`VariwideSeries ` - :class:`WaterfallSeries ` - :class:`WindBarbSeries ` - :class:`XRangeSeries ` - :class:`BaseBarSeries ` - * - :mod:`.options.series.base ` - - :class:`SeriesBase ` - * - :mod:`.options.series.bellcurve ` - - :class:`BellCurveSeries ` - * - :mod:`.options.series.boxplot ` - - :class:`BoxPlotSeries ` - :class:`ErrorBarSeries ` - * - :mod:`.options.series.bubble ` - - :class:`BubbleSeries ` - * - :mod:`.options.series.bullet ` - - :class:`BulletSeries ` - * - :mod:`.options.series.data ` + * - :mod:`.options.series.arcdiagram ` + - :class:`ArcDiagramSeries ` + * - :mod:`.options.series.area ` + - :class:`AreaSeries ` + :class:`AreaRangeSeries ` + :class:`AreaSplineSeries ` + :class:`AreaSplineRangeSeries ` + :class:`LineSeries ` + :class:`StreamGraphSeries ` + * - :mod:`.options.series.bar ` + - :class:`BarSeries ` + :class:`ColumnSeries ` + :class:`ColumnPyramidSeries ` + :class:`ColumnRangeSeries ` + :class:`CylinderSeries ` + :class:`VariwideSeries ` + :class:`WaterfallSeries ` + :class:`WindBarbSeries ` + :class:`XRangeSeries ` + :class:`BaseBarSeries ` + * - :mod:`.options.series.base ` + - :class:`SeriesBase ` + * - :mod:`.options.series.bellcurve ` + - :class:`BellCurveSeries ` + * - :mod:`.options.series.boxplot ` + - :class:`BoxPlotSeries ` + :class:`ErrorBarSeries ` + * - :mod:`.options.series.bubble ` + - :class:`BubbleSeries ` + * - :mod:`.options.series.bullet ` + - :class:`BulletSeries ` + * - :mod:`.options.series.data ` - - * - :mod:`.options.series.data.accessibility ` - - :class:`DataPointAccessibility ` - * - :mod:`.options.series.data.arcdiagram ` - - :class:`ArcDiagramData ` - * - :mod:`.options.series.data.bar ` - - :class:`BarData ` - :class:`WaterfallData ` - :class:`WindBarbData ` - :class:`XRangeData ` - * - :mod:`.options.series.data.base ` - - :class:`DataBase ` - * - :mod:`.options.series.data.boxplot ` - - :class:`BoxPlotData ` - * - :mod:`.options.series.data.bullet ` - - :class:`BulletData ` - * - :mod:`.options.series.data.cartesian ` - - :class:`CartesianData ` - :class:`Cartesian3DData ` - :class:`CartesianValueData ` - * - :mod:`.options.series.data.connections ` - - :class:`ConnectionData ` - :class:`WeightedConnectionData ` - :class:`OutgoingWeightedConnectionData ` - :class:`ConnectionBase ` - * - :mod:`.options.series.data.pie ` - - :class:`PieData ` - :class:`VariablePieData ` - * - :mod:`.options.series.data.range ` - - :class:`RangeData ` - :class:`ConnectedRangeData ` - * - :mod:`.options.series.data.single_point ` - - :class:`SinglePointData ` - :class:`SingleValueData ` - :class:`SingleXData ` - :class:`LabeledSingleXData ` - :class:`ConnectedSingleXData ` - :class:`SinglePointBase ` - * - :mod:`.options.series.data.sunburst ` - - :class:`SunburstData ` - * - :mod:`.options.series.data.treemap ` - - :class:`TreemapData ` - * - :mod:`.options.series.data.vector ` - - :class:`VectorData ` - * - :mod:`.options.series.data.venn ` - - :class:`VennData ` - * - :mod:`.options.series.data.wordcloud ` - - :class:`WordcloudData ` - * - :mod:`.options.series.dependencywheel ` - - :class:`DependencyWheelSeries ` - * - :mod:`.options.series.dumbbell ` - - :class:`DumbbellSeries ` - :class:`LollipopSeries ` - * - :mod:`.options.series.funnel ` - - :class:`FunnelSeries ` - :class:`Funnel3DSeries ` - * - :mod:`.options.series.gauge ` - - :class:`GaugeSeries ` - :class:`SolidGaugeSeries ` - * - :mod:`.options.series.heatmap ` - - :class:`HeatmapSeries ` - :class:`TilemapSeries ` - * - :mod:`.options.series.histogram ` - - :class:`HistogramSeries ` - * - :mod:`.options.series.item ` - - :class:`ItemSeries ` - * - :mod:`.options.series.labels ` - - :class:`SeriesLabel ` - :class:`Box ` - * - :mod:`.options.series.networkgraph ` - - :class:`NetworkGraphSeries ` - * - :mod:`.options.series.organization ` - - :class:`OrganizationSeries ` - * - :mod:`.options.series.packedbubble ` - - :class:`PackedBubbleSeries ` - * - :mod:`.options.series.pareto ` - - :class:`ParetoSeries ` - * - :mod:`.options.series.pie ` - - :class:`PieSeries ` - :class:`VariablePieSeries ` - * - :mod:`.options.series.polygon ` - - :class:`PolygonSeries ` - * - :mod:`.options.series.pyramid ` - - :class:`PyramidSeries ` - :class:`Pyramid3DSeries ` - * - :mod:`.options.series.sankey ` - - :class:`SankeySeries ` - * - :mod:`.options.series.scatter ` - - :class:`ScatterSeries ` - :class:`Scatter3DSeries ` - * - :mod:`.options.series.series_generator ` - - :func:`create_series_obj() ` - * - :mod:`.options.series.spline ` - - :class:`SplineSeries ` - * - :mod:`.options.series.sunburst ` - - :class:`SunburstSeries ` - * - :mod:`.options.series.timeline ` - - :class:`TimelineSeries ` - * - :mod:`.options.series.treemap ` - - :class:`TreemapSeries ` - * - :mod:`.options.series.vector ` - - :class:`VectorSeries ` - * - :mod:`.options.series.venn ` - - :class:`VennSeries ` - * - :mod:`.options.series.wordcloud ` - - :class:`WordcloudSeries ` - * - :mod:`.options.subtitle ` - - :class:`Subtitle ` - * - :mod:`.options.time ` - - :class:`Time ` - * - :mod:`.options.title ` - - :class:`Title ` - * - :mod:`.options.tooltips ` - - :class:`Tooltip ` - * - :mod:`.utility_classes ` + * - :mod:`.options.series.data.accessibility ` + - :class:`DataPointAccessibility ` + * - :mod:`.options.series.data.arcdiagram ` + - :class:`ArcDiagramData ` + * - :mod:`.options.series.data.bar ` + - :class:`BarData ` + :class:`WaterfallData ` + :class:`WindBarbData ` + :class:`XRangeData ` + * - :mod:`.options.series.data.base ` + - :class:`DataBase ` + * - :mod:`.options.series.data.boxplot ` + - :class:`BoxPlotData ` + * - :mod:`.options.series.data.bullet ` + - :class:`BulletData ` + * - :mod:`.options.series.data.cartesian ` + - :class:`CartesianData ` + :class:`Cartesian3DData ` + :class:`CartesianValueData ` + * - :mod:`.options.series.data.connections ` + - :class:`ConnectionData ` + :class:`WeightedConnectionData ` + :class:`OutgoingWeightedConnectionData ` + :class:`ConnectionBase ` + * - :mod:`.options.series.data.pie ` + - :class:`PieData ` + :class:`VariablePieData ` + * - :mod:`.options.series.data.range ` + - :class:`RangeData ` + :class:`ConnectedRangeData ` + * - :mod:`.options.series.data.single_point ` + - :class:`SinglePointData ` + :class:`SingleValueData ` + :class:`SingleXData ` + :class:`LabeledSingleXData ` + :class:`ConnectedSingleXData ` + :class:`SinglePointBase ` + * - :mod:`.options.series.data.sunburst ` + - :class:`SunburstData ` + * - :mod:`.options.series.data.treemap ` + - :class:`TreemapData ` + * - :mod:`.options.series.data.vector ` + - :class:`VectorData ` + * - :mod:`.options.series.data.venn ` + - :class:`VennData ` + * - :mod:`.options.series.data.wordcloud ` + - :class:`WordcloudData ` + * - :mod:`.options.series.dependencywheel ` + - :class:`DependencyWheelSeries ` + * - :mod:`.options.series.dumbbell ` + - :class:`DumbbellSeries ` + :class:`LollipopSeries ` + * - :mod:`.options.series.funnel ` + - :class:`FunnelSeries ` + :class:`Funnel3DSeries ` + * - :mod:`.options.series.gauge ` + - :class:`GaugeSeries ` + :class:`SolidGaugeSeries ` + * - :mod:`.options.series.heatmap ` + - :class:`HeatmapSeries ` + :class:`TilemapSeries ` + * - :mod:`.options.series.histogram ` + - :class:`HistogramSeries ` + * - :mod:`.options.series.item ` + - :class:`ItemSeries ` + * - :mod:`.options.series.labels ` + - :class:`SeriesLabel ` + :class:`Box ` + * - :mod:`.options.series.networkgraph ` + - :class:`NetworkGraphSeries ` + * - :mod:`.options.series.organization ` + - :class:`OrganizationSeries ` + * - :mod:`.options.series.packedbubble ` + - :class:`PackedBubbleSeries ` + * - :mod:`.options.series.pareto ` + - :class:`ParetoSeries ` + * - :mod:`.options.series.pie ` + - :class:`PieSeries ` + :class:`VariablePieSeries ` + * - :mod:`.options.series.polygon ` + - :class:`PolygonSeries ` + * - :mod:`.options.series.pyramid ` + - :class:`PyramidSeries ` + :class:`Pyramid3DSeries ` + * - :mod:`.options.series.sankey ` + - :class:`SankeySeries ` + * - :mod:`.options.series.scatter ` + - :class:`ScatterSeries ` + :class:`Scatter3DSeries ` + * - :mod:`.options.series.series_generator ` + - :func:`create_series_obj() ` + * - :mod:`.options.series.spline ` + - :class:`SplineSeries ` + * - :mod:`.options.series.sunburst ` + - :class:`SunburstSeries ` + * - :mod:`.options.series.timeline ` + - :class:`TimelineSeries ` + * - :mod:`.options.series.treemap ` + - :class:`TreemapSeries ` + * - :mod:`.options.series.vector ` + - :class:`VectorSeries ` + * - :mod:`.options.series.venn ` + - :class:`VennSeries ` + * - :mod:`.options.series.wordcloud ` + - :class:`WordcloudSeries ` + * - :mod:`.options.subtitle ` + - :class:`Subtitle ` + * - :mod:`.options.time ` + - :class:`Time ` + * - :mod:`.options.title ` + - :class:`Title ` + * - :mod:`.options.tooltips ` + - :class:`Tooltip ` + * - :mod:`.utility_classes ` - - * - :mod:`.utility_classes.animation ` - - :class:`AnimationOptions ` - * - :mod:`.utility_classes.ast ` - - :class:`ASTMap ` - :class:`ASTNode ` - :class:`TextPath ` - :class:`AttributeObject ` - * - :mod:`.utility_classes.breadcrumbs ` - - :class:`BreadcrumbOptions ` - :class:`Separator ` - * - :mod:`.utility_classes.buttons ` - - :class:`ExportingButtons ` - :class:`ContextButtonConfiguration ` - :class:`ButtonConfiguration ` - :class:`ButtonTheme ` - * - :mod:`.utility_classes.clusters ` - - :class:`ClusterOptions ` - :class:`VectorLayoutAlgorithm ` - * - :mod:`.utility_classes.data_grouping ` - - :class:`DataGroupingOptions ` - * - :mod:`.utility_classes.data_labels ` - - :class:`DataLabel ` - :class:`NodeDataLabel ` - :class:`Filter ` - * - :mod:`.utility_classes.date_time_label_formats ` - - :class:`DateTimeLabelFormats ` - * - :mod:`.utility_classes.events ` - - :class:`ChartEvents ` - :class:`BreadcrumbEvents ` - :class:`NavigationEvents ` - :class:`PointEvents ` - :class:`SeriesEvents ` - :class:`ClusterEvents ` - :class:`AxisEvents ` - :class:`MouseEvents ` - * - :mod:`.utility_classes.gradients ` - - :class:`Gradient ` - :class:`LinearGradient ` - :class:`RadialGradient ` - * - :mod:`.utility_classes.javascript_functions ` - - :class:`CallbackFunction ` - :class:`JavaScriptClass ` - * - :mod:`.utility_classes.jitter ` - - :class:`Jitter ` - * - :mod:`.utility_classes.markers ` - - :class:`Marker ` - * - :mod:`.utility_classes.menus ` - - :class:`MenuObject ` - :class:`MenuItem ` - * - :mod:`.utility_classes.nodes ` - - :class:`NodeOptions ` - :class:`DependencyWheelNodeOptions ` - :class:`OrganizationNodeOptions ` - * - :mod:`.utility_classes.partial_fill ` - - :class:`PartialFillOptions ` - * - :mod:`.utility_classes.patterns ` - - :class:`Pattern ` - :class:`PatternOptions ` - * - :mod:`.utility_classes.position ` - - :class:`Position ` - * - :mod:`.utility_classes.shadows ` - - :class:`ShadowOptions ` - * - :mod:`.utility_classes.states ` - - :class:`States ` - :class:`HoverState ` - :class:`InactiveState ` - :class:`NormalState ` - :class:`SelectState ` - * - :mod:`.utility_classes.zones ` - - :class:`Zone ` - :class:`ClusterZone ` + * - :mod:`.utility_classes.animation ` + - :class:`AnimationOptions ` + * - :mod:`.utility_classes.ast ` + - :class:`ASTMap ` + :class:`ASTNode ` + :class:`TextPath ` + :class:`AttributeObject ` + * - :mod:`.utility_classes.breadcrumbs ` + - :class:`BreadcrumbOptions ` + :class:`Separator ` + * - :mod:`.utility_classes.buttons ` + - :class:`ExportingButtons ` + :class:`ContextButtonConfiguration ` + :class:`ButtonConfiguration ` + :class:`ButtonTheme ` + * - :mod:`.utility_classes.clusters ` + - :class:`ClusterOptions ` + :class:`VectorLayoutAlgorithm ` + * - :mod:`.utility_classes.data_grouping ` + - :class:`DataGroupingOptions ` + * - :mod:`.utility_classes.data_labels ` + - :class:`DataLabel ` + :class:`NodeDataLabel ` + :class:`Filter ` + * - :mod:`.utility_classes.date_time_label_formats ` + - :class:`DateTimeLabelFormats ` + * - :mod:`.utility_classes.events ` + - :class:`ChartEvents ` + :class:`BreadcrumbEvents ` + :class:`NavigationEvents ` + :class:`PointEvents ` + :class:`SeriesEvents ` + :class:`ClusterEvents ` + :class:`AxisEvents ` + :class:`MouseEvents ` + * - :mod:`.utility_classes.gradients ` + - :class:`Gradient ` + :class:`LinearGradient ` + :class:`RadialGradient ` + * - :mod:`.utility_classes.javascript_functions ` + - :class:`CallbackFunction ` + :class:`JavaScriptClass ` + :class:`VariableName ` + * - :mod:`.utility_classes.jitter ` + - :class:`Jitter ` + * - :mod:`.utility_classes.markers ` + - :class:`Marker ` + * - :mod:`.utility_classes.menus ` + - :class:`MenuObject ` + :class:`MenuItem ` + * - :mod:`.utility_classes.nodes ` + - :class:`NodeOptions ` + :class:`DependencyWheelNodeOptions ` + :class:`OrganizationNodeOptions ` + * - :mod:`.utility_classes.partial_fill ` + - :class:`PartialFillOptions ` + * - :mod:`.utility_classes.patterns ` + - :class:`Pattern ` + :class:`PatternOptions ` + * - :mod:`.utility_classes.position ` + - :class:`Position ` + * - :mod:`.utility_classes.shadows ` + - :class:`ShadowOptions ` + * - :mod:`.utility_classes.states ` + - :class:`States ` + :class:`HoverState ` + :class:`InactiveState ` + :class:`NormalState ` + :class:`SelectState ` + * - :mod:`.utility_classes.zones ` + - :class:`Zone ` + :class:`ClusterZone ` .. toctree:: :hidden: @@ -652,29 +655,29 @@ familiarize yourself with these internals. * - Module - Classes / Functions - * - :mod:`.metaclasses ` - - :class:`HighchartsMeta ` - :class:`JavaScriptDict ` - * - :mod:`.decorators ` - - :deco:`@class_sensitive() ` - :func:`validate_types() ` - * - :mod:`.js_literal_functions ` - - :func:`serialize_to_js_literal() ` - :func:`attempt_variable_declaration() ` - :func:`is_js_function_or_class() ` - :func:`get_js_literal() ` - :func:`assemble_js_literal() ` - :func:`convert_js_literal_to_python() ` - :func:`convert_js_property_to_python() ` - :func:`convert_js_to_python() ` - :func:`get_key_value_pairs() ` - * - :mod:`.utility_functions ` - - :func:`mro_to_dict() ` - :func:`get_remaining_mro() ` - :func:`mro__to_untrimmed_dict() ` - :func:`validate_color() ` - :func:`to_camelCase() ` - :func:`parse_csv() ` + * - :mod:`.metaclasses ` + - :class:`HighchartsMeta ` + :class:`JavaScriptDict ` + * - :mod:`.decorators ` + - :deco:`@class_sensitive() ` + :func:`validate_types() ` + * - :mod:`.js_literal_functions ` + - :func:`serialize_to_js_literal() ` + :func:`attempt_variable_declaration() ` + :func:`is_js_function_or_class() ` + :func:`get_js_literal() ` + :func:`assemble_js_literal() ` + :func:`convert_js_literal_to_python() ` + :func:`convert_js_property_to_python() ` + :func:`convert_js_to_python() ` + :func:`get_key_value_pairs() ` + * - :mod:`.utility_functions ` + - :func:`mro_to_dict() ` + :func:`get_remaining_mro() ` + :func:`mro__to_untrimmed_dict() ` + :func:`validate_color() ` + :func:`to_camelCase() ` + :func:`parse_csv() ` .. target-notes:: diff --git a/docs/api/_module_structure.rst b/docs/api/_module_structure.rst index 22348e22..176a03a4 100644 --- a/docs/api/_module_structure.rst +++ b/docs/api/_module_structure.rst @@ -3,46 +3,46 @@ The structure of the **Highcharts for Python** library closely matches the struc of the `Highcharts JS `_ options object (see the relevant `reference documentation `_). -At the root of the library - importable from ``highcharts_python`` you will find the -:mod:`highcharts_python.highcharts` module. This module is a catch-all importable module, +At the root of the library - importable from ``highcharts_core`` you will find the +:mod:`highcharts_core.highcharts` module. This module is a catch-all importable module, which allows you to easily access the most-commonly-used Highcharts for Python classes and modules. .. note:: Whlie you can access all of the **Highcharts for Python** classes from - ``highcharts_python.highcharts``, if you want to more precisely navigate to specific + ``highcharts_core.highcharts``, if you want to more precisely navigate to specific class definitions you can do fairly easily using the folder organization and naming conventions used in the library. - In the root of the ``highcharts_python`` library you can find universally-shared - class definitions, like :mod:`.metaclasses ` which + In the root of the ``highcharts_core`` library you can find universally-shared + class definitions, like :mod:`.metaclasses ` which contains the :class:`HighchartsMeta` definition and the :class:`JavaScriptDict` - definition or :mod:`.decorators ` which define + definition or :mod:`.decorators ` which define method/property decorators that are used throughout the library. - The :mod:`.utility_classes ` folder contains class + The :mod:`.utility_classes ` folder contains class definitions for classes that are referenced or used throughout the other class definitions. And you can find the Highcharts JS ``options`` object and all of its - properties defined in the :mod:`.options ` module, with + properties defined in the :mod:`.options ` module, with specific (complicated or extensive) sub-folders providing property-specific classes - (e.g. the :mod:`.options.plot_options ` + (e.g. the :mod:`.options.plot_options ` module defines all of the different configuration options for different series types, - while the :mod:`.options.series ` module defines all + while the :mod:`.options.series ` module defines all of the classes that represent :term:`series` of data in a given chart). .. tip:: To keep things simple, we recommend importing classes you need directly from the - :mod:`highcharts_python.highcharts` module. There are two paths to do so easily: + :mod:`highcharts_core.highcharts` module. There are two paths to do so easily: .. code-block:: python # APPROACH #1: Import the highcharts module, and access its child classes directly. # for example by now calling highcharts.Chart(). - from highcharts_python import highcharts + from highcharts_core import highcharts my_chart = highcharts.Chart() my_shared_options = highcharts.SharedOptions() @@ -50,7 +50,7 @@ modules. my_line_series = highcharts.options.series.area.LineSeries() # APPROACH #2: Import a specific class or module by name from the "highcharts" module. - from highcharts_python.highcharts import Chart, SharedOptions, options + from highcharts_core.highcharts import Chart, SharedOptions, options my_chart = Chart() my_shared_options = SharedOptions() diff --git a/docs/api/chart.rst b/docs/api/chart.rst index 226a74d6..4548fc83 100644 --- a/docs/api/chart.rst +++ b/docs/api/chart.rst @@ -1,5 +1,5 @@ ################################################## -:mod:`.chart ` +:mod:`.chart ` ################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.chart +.. module:: highcharts_core.chart ****************************************************** -class: :class:`Chart ` +class: :class:`Chart ` ****************************************************** .. autoclass:: Chart @@ -22,7 +22,7 @@ class: :class:`Chart ` .. collapse:: Class Inheritance .. inheritance-diagram:: Chart - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/global_options/index.rst b/docs/api/global_options/index.rst index 4c40fc29..30ce5362 100644 --- a/docs/api/global_options/index.rst +++ b/docs/api/global_options/index.rst @@ -1,5 +1,5 @@ ############################################################## -:mod:`.global_options ` +:mod:`.global_options ` ############################################################## **Module Contents** @@ -12,7 +12,7 @@ -------------- -.. module:: highcharts_python.global_options +.. module:: highcharts_core.global_options *************************** Sub-components @@ -24,41 +24,41 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.global_options ` + * - :mod:`.global_options ` - - * - :mod:`.global_options.language ` - - :class:`Language ` - * - :mod:`.global_options.language.accessibility ` - - :class:`AccessibilityLanguageOptions ` - * - :mod:`.global_options.language.accessibility.announce_new_data ` - - :class:`AnnounceNewDataLanguageOptions ` - * - :mod:`.global_options.language.accessibility.axis ` - - :class:`AxisLanguageOptions ` - * - :mod:`global_options.language.accessibility.chart_types ` - - :class:`ChartTypesLanguageOptions ` - * - :mod:`global_options.language.accessibility.exporting ` - - :class:`ExportingLanguageOptions ` - * - :mod:`global_options.language.accessibility.legend ` - - :class:`LegendLanguageOptions ` - * - :mod:`global_options.language.accessibility.range_selector ` - - :class:`RangeSelectorLanguageOptions ` - * - :mod:`global_options.language.accessibility.screen_reader_section ` - - :class:`ScreenReaderSectionLanguageOptions ` - :class:`ScreenReaderSectionAnnotationLanguage ` - * - :mod:`global_options.language.accessibility.series ` - - :class:`SeriesLanguageOptions ` - :class:`SeriesSummaryLanguageOptions ` - :class:`SeriesTypeDescriptions ` - * - :mod:`global_options.language.accessibility.sonification ` - - :class:`SonificationLanguageOptions ` - * - :mod:`global_options.language.accessibility.table ` - - :class:`TableLanguageOptions ` - * - :mod:`global_options.language.accessibility.zoom ` - - :class:`ZoomLanguageOptions ` - * - :mod:`.global_options.language.export_data ` - - :class:`ExportDataLanguageOptions ` - * - :mod:`.global_options.language.navigation ` - - :class:`NavigationLanguageOptions ` - :class:`PopupLanguageOptions ` - * - :mod:`.global_options.shared_options ` - - :class:`SharedOptions ` + * - :mod:`.global_options.language ` + - :class:`Language ` + * - :mod:`.global_options.language.accessibility ` + - :class:`AccessibilityLanguageOptions ` + * - :mod:`.global_options.language.accessibility.announce_new_data ` + - :class:`AnnounceNewDataLanguageOptions ` + * - :mod:`.global_options.language.accessibility.axis ` + - :class:`AxisLanguageOptions ` + * - :mod:`global_options.language.accessibility.chart_types ` + - :class:`ChartTypesLanguageOptions ` + * - :mod:`global_options.language.accessibility.exporting ` + - :class:`ExportingLanguageOptions ` + * - :mod:`global_options.language.accessibility.legend ` + - :class:`LegendLanguageOptions ` + * - :mod:`global_options.language.accessibility.range_selector ` + - :class:`RangeSelectorLanguageOptions ` + * - :mod:`global_options.language.accessibility.screen_reader_section ` + - :class:`ScreenReaderSectionLanguageOptions ` + :class:`ScreenReaderSectionAnnotationLanguage ` + * - :mod:`global_options.language.accessibility.series ` + - :class:`SeriesLanguageOptions ` + :class:`SeriesSummaryLanguageOptions ` + :class:`SeriesTypeDescriptions ` + * - :mod:`global_options.language.accessibility.sonification ` + - :class:`SonificationLanguageOptions ` + * - :mod:`global_options.language.accessibility.table ` + - :class:`TableLanguageOptions ` + * - :mod:`global_options.language.accessibility.zoom ` + - :class:`ZoomLanguageOptions ` + * - :mod:`.global_options.language.export_data ` + - :class:`ExportDataLanguageOptions ` + * - :mod:`.global_options.language.navigation ` + - :class:`NavigationLanguageOptions ` + :class:`PopupLanguageOptions ` + * - :mod:`.global_options.shared_options ` + - :class:`SharedOptions ` diff --git a/docs/api/global_options/language/accessibility/announce_new_data.rst b/docs/api/global_options/language/accessibility/announce_new_data.rst index 6364608c..d6971a09 100644 --- a/docs/api/global_options/language/accessibility/announce_new_data.rst +++ b/docs/api/global_options/language/accessibility/announce_new_data.rst @@ -1,5 +1,5 @@ ######################################################################################################### -:mod:`.announce_new_data ` +:mod:`.announce_new_data ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.announce_new_data +.. module:: highcharts_core.global_options.language.accessibility.announce_new_data ************************************************************************************************************************************************************* -class: :class:`AnnounceNewDataLanguageOptions ` +class: :class:`AnnounceNewDataLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: AnnounceNewDataLanguageOptions @@ -22,7 +22,7 @@ class: :class:`AnnounceNewDataLanguageOptions ` +:mod:`.axis ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.axis +.. module:: highcharts_core.global_options.language.accessibility.axis ************************************************************************************************************************************************************* -class: :class:`AxisLanguageOptions ` +class: :class:`AxisLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: AxisLanguageOptions @@ -22,7 +22,7 @@ class: :class:`AxisLanguageOptions ` +:mod:`.chart_types ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.chart_types +.. module:: highcharts_core.global_options.language.accessibility.chart_types ************************************************************************************************************************************************************* -class: :class:`ChartTypesLanguageOptions ` +class: :class:`ChartTypesLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: ChartTypesLanguageOptions @@ -22,7 +22,7 @@ class: :class:`ChartTypesLanguageOptions ` +:mod:`.exporting ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.exporting +.. module:: highcharts_core.global_options.language.accessibility.exporting ************************************************************************************************************************************************************* -class: :class:`ExportingLanguageOptions ` +class: :class:`ExportingLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: ExportingLanguageOptions @@ -22,7 +22,7 @@ class: :class:`ExportingLanguageOptions ` +:mod:`.accessibility ` ################################################################################### .. contents:: Module Contents @@ -24,10 +24,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility +.. module:: highcharts_core.global_options.language.accessibility **************************************************************************************************************************************** -class: :class:`AccessibilityLanguageOptions ` +class: :class:`AccessibilityLanguageOptions ` **************************************************************************************************************************************** .. autoclass:: AccessibilityLanguageOptions @@ -37,7 +37,7 @@ class: :class:`AccessibilityLanguageOptions ` - - :class:`AccessibilityLanguageOptions ` - * - :mod:`.global_options.language.accessibility.announce_new_data ` - - :class:`AnnounceNewDataLanguageOptions ` - * - :mod:`.global_options.language.accessibility.axis ` - - :class:`AxisLanguageOptions ` - * - :mod:`global_options.language.accessibility.chart_types ` - - :class:`ChartTypesLanguageOptions ` - * - :mod:`global_options.language.accessibility.exporting ` - - :class:`ExportingLanguageOptions ` - * - :mod:`global_options.language.accessibility.legend ` - - :class:`LegendLanguageOptions ` - * - :mod:`global_options.language.accessibility.range_selector ` - - :class:`RangeSelectorLanguageOptions ` - * - :mod:`global_options.language.accessibility.screen_reader_section ` - - :class:`ScreenReaderSectionLanguageOptions ` - :class:`ScreenReaderSectionAnnotationLanguage ` - * - :mod:`global_options.language.accessibility.series ` - - :class:`SeriesLanguageOptions ` - :class:`SeriesSummaryLanguageOptions ` - :class:`SeriesTypeDescriptions ` - * - :mod:`global_options.language.accessibility.sonification ` - - :class:`SonificationLanguageOptions ` - * - :mod:`global_options.language.accessibility.table ` - - :class:`TableLanguageOptions ` - * - :mod:`global_options.language.accessibility.zoom ` - - :class:`ZoomLanguageOptions ` + * - :mod:`.global_options.language.accessibility ` + - :class:`AccessibilityLanguageOptions ` + * - :mod:`.global_options.language.accessibility.announce_new_data ` + - :class:`AnnounceNewDataLanguageOptions ` + * - :mod:`.global_options.language.accessibility.axis ` + - :class:`AxisLanguageOptions ` + * - :mod:`global_options.language.accessibility.chart_types ` + - :class:`ChartTypesLanguageOptions ` + * - :mod:`global_options.language.accessibility.exporting ` + - :class:`ExportingLanguageOptions ` + * - :mod:`global_options.language.accessibility.legend ` + - :class:`LegendLanguageOptions ` + * - :mod:`global_options.language.accessibility.range_selector ` + - :class:`RangeSelectorLanguageOptions ` + * - :mod:`global_options.language.accessibility.screen_reader_section ` + - :class:`ScreenReaderSectionLanguageOptions ` + :class:`ScreenReaderSectionAnnotationLanguage ` + * - :mod:`global_options.language.accessibility.series ` + - :class:`SeriesLanguageOptions ` + :class:`SeriesSummaryLanguageOptions ` + :class:`SeriesTypeDescriptions ` + * - :mod:`global_options.language.accessibility.sonification ` + - :class:`SonificationLanguageOptions ` + * - :mod:`global_options.language.accessibility.table ` + - :class:`TableLanguageOptions ` + * - :mod:`global_options.language.accessibility.zoom ` + - :class:`ZoomLanguageOptions ` diff --git a/docs/api/global_options/language/accessibility/legend.rst b/docs/api/global_options/language/accessibility/legend.rst index 668ece7f..26c7d783 100644 --- a/docs/api/global_options/language/accessibility/legend.rst +++ b/docs/api/global_options/language/accessibility/legend.rst @@ -1,5 +1,5 @@ ######################################################################################################### -:mod:`.legend ` +:mod:`.legend ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.legend +.. module:: highcharts_core.global_options.language.accessibility.legend ************************************************************************************************************************************************************* -class: :class:`LegendLanguageOptions ` +class: :class:`LegendLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: LegendLanguageOptions @@ -22,7 +22,7 @@ class: :class:`LegendLanguageOptions ` +:mod:`.range_selector ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.range_selector +.. module:: highcharts_core.global_options.language.accessibility.range_selector ************************************************************************************************************************************************************* -class: :class:`RangeSelectorLanguageOptions ` +class: :class:`RangeSelectorLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: RangeSelectorLanguageOptions @@ -22,7 +22,7 @@ class: :class:`RangeSelectorLanguageOptions ` +:mod:`.screen_reader_section ` ################################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.screen_reader_section +.. module:: highcharts_core.global_options.language.accessibility.screen_reader_section ************************************************************************************************************************************************************************ -class: :class:`ScreenReaderSectionLanguageOptions ` +class: :class:`ScreenReaderSectionLanguageOptions ` ************************************************************************************************************************************************************************ .. autoclass:: ScreenReaderSectionLanguageOptions @@ -22,7 +22,7 @@ class: :class:`ScreenReaderSectionLanguageOptions ` +class: :class:`ScreenReaderSectionAnnotationLanguage ` ***************************************************************************************************************************************************************************** .. autoclass:: ScreenReaderSectionAnnotationLanguage @@ -40,7 +40,7 @@ class: :class:`ScreenReaderSectionAnnotationLanguage ` +:mod:`.series ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.series +.. module:: highcharts_core.global_options.language.accessibility.series ************************************************************************************************************************************************************* -class: :class:`SeriesLanguageOptions ` +class: :class:`SeriesLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: SeriesLanguageOptions @@ -22,7 +22,7 @@ class: :class:`SeriesLanguageOptions ` +class: :class:`SeriesSummaryLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: SeriesSummaryLanguageOptions @@ -40,7 +40,7 @@ class: :class:`SeriesSummaryLanguageOptions ` +class: :class:`SeriesTypeDescriptions ` ************************************************************************************************************************************************************* .. autoclass:: SeriesTypeDescriptions @@ -58,7 +58,7 @@ class: :class:`SeriesTypeDescriptions ` +:mod:`.sonification ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.sonification +.. module:: highcharts_core.global_options.language.accessibility.sonification ************************************************************************************************************************************************************* -class: :class:`SonificationLanguageOptions ` +class: :class:`SonificationLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: SonificationLanguageOptions @@ -22,7 +22,7 @@ class: :class:`SonificationLanguageOptions ` +:mod:`.table ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.table +.. module:: highcharts_core.global_options.language.accessibility.table ************************************************************************************************************************************************************* -class: :class:`TableLanguageOptions ` +class: :class:`TableLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: TableLanguageOptions @@ -22,7 +22,7 @@ class: :class:`TableLanguageOptions ` +:mod:`.zoom ` ######################################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.accessibility.zoom +.. module:: highcharts_core.global_options.language.accessibility.zoom ************************************************************************************************************************************************************* -class: :class:`ZoomLanguageOptions ` +class: :class:`ZoomLanguageOptions ` ************************************************************************************************************************************************************* .. autoclass:: ZoomLanguageOptions @@ -22,7 +22,7 @@ class: :class:`ZoomLanguageOptions ` +:mod:`.export_data ` ############################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.export_data +.. module:: highcharts_core.global_options.language.export_data ********************************************************************************************************************************* -class: :class:`ExportDataLanguageOptions ` +class: :class:`ExportDataLanguageOptions ` ********************************************************************************************************************************* .. autoclass:: ExportDataLanguageOptions @@ -22,7 +22,7 @@ class: :class:`ExportDataLanguageOptions ` +:mod:`.language ` ################################################################# .. contents:: Module Contents @@ -16,10 +16,10 @@ -------------- -.. module:: highcharts_python.global_options.language +.. module:: highcharts_core.global_options.language ****************************************************************************************** -class: :class:`Language ` +class: :class:`Language ` ****************************************************************************************** .. autoclass:: Language @@ -29,7 +29,7 @@ class: :class:`Language ` .. collapse:: Class Inheritance .. inheritance-diagram:: Language - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -46,37 +46,37 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.global_options.language ` - - :class:`Language ` - * - :mod:`.global_options.language.accessibility ` - - :class:`AccessibilityLanguageOptions ` - * - :mod:`.global_options.language.accessibility.announce_new_data ` - - :class:`AnnounceNewDataLanguageOptions ` - * - :mod:`.global_options.language.accessibility.axis ` - - :class:`AxisLanguageOptions ` - * - :mod:`global_options.language.accessibility.chart_types ` - - :class:`ChartTypesLanguageOptions ` - * - :mod:`global_options.language.accessibility.exporting ` - - :class:`ExportingLanguageOptions ` - * - :mod:`global_options.language.accessibility.legend ` - - :class:`LegendLanguageOptions ` - * - :mod:`global_options.language.accessibility.range_selector ` - - :class:`RangeSelectorLanguageOptions ` - * - :mod:`global_options.language.accessibility.screen_reader_section ` - - :class:`ScreenReaderSectionLanguageOptions ` - :class:`ScreenReaderSectionAnnotationLanguage ` - * - :mod:`global_options.language.accessibility.series ` - - :class:`SeriesLanguageOptions ` - :class:`SeriesSummaryLanguageOptions ` - :class:`SeriesTypeDescriptions ` - * - :mod:`global_options.language.accessibility.sonification ` - - :class:`SonificationLanguageOptions ` - * - :mod:`global_options.language.accessibility.table ` - - :class:`TableLanguageOptions ` - * - :mod:`global_options.language.accessibility.zoom ` - - :class:`ZoomLanguageOptions ` - * - :mod:`.global_options.language.export_data ` - - :class:`ExportDataLanguageOptions ` - * - :mod:`.global_options.language.navigation ` - - :class:`NavigationLanguageOptions ` - :class:`PopupLanguageOptions ` + * - :mod:`.global_options.language ` + - :class:`Language ` + * - :mod:`.global_options.language.accessibility ` + - :class:`AccessibilityLanguageOptions ` + * - :mod:`.global_options.language.accessibility.announce_new_data ` + - :class:`AnnounceNewDataLanguageOptions ` + * - :mod:`.global_options.language.accessibility.axis ` + - :class:`AxisLanguageOptions ` + * - :mod:`global_options.language.accessibility.chart_types ` + - :class:`ChartTypesLanguageOptions ` + * - :mod:`global_options.language.accessibility.exporting ` + - :class:`ExportingLanguageOptions ` + * - :mod:`global_options.language.accessibility.legend ` + - :class:`LegendLanguageOptions ` + * - :mod:`global_options.language.accessibility.range_selector ` + - :class:`RangeSelectorLanguageOptions ` + * - :mod:`global_options.language.accessibility.screen_reader_section ` + - :class:`ScreenReaderSectionLanguageOptions ` + :class:`ScreenReaderSectionAnnotationLanguage ` + * - :mod:`global_options.language.accessibility.series ` + - :class:`SeriesLanguageOptions ` + :class:`SeriesSummaryLanguageOptions ` + :class:`SeriesTypeDescriptions ` + * - :mod:`global_options.language.accessibility.sonification ` + - :class:`SonificationLanguageOptions ` + * - :mod:`global_options.language.accessibility.table ` + - :class:`TableLanguageOptions ` + * - :mod:`global_options.language.accessibility.zoom ` + - :class:`ZoomLanguageOptions ` + * - :mod:`.global_options.language.export_data ` + - :class:`ExportDataLanguageOptions ` + * - :mod:`.global_options.language.navigation ` + - :class:`NavigationLanguageOptions ` + :class:`PopupLanguageOptions ` diff --git a/docs/api/global_options/language/navigation.rst b/docs/api/global_options/language/navigation.rst index bbacc7da..81a40e64 100644 --- a/docs/api/global_options/language/navigation.rst +++ b/docs/api/global_options/language/navigation.rst @@ -1,5 +1,5 @@ ############################################################################# -:mod:`.navigation ` +:mod:`.navigation ` ############################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.language.navigation +.. module:: highcharts_core.global_options.language.navigation ********************************************************************************************************************************* -class: :class:`NavigationLanguageOptions ` +class: :class:`NavigationLanguageOptions ` ********************************************************************************************************************************* .. autoclass:: NavigationLanguageOptions @@ -22,7 +22,7 @@ class: :class:`NavigationLanguageOptions ` +class: :class:`PopupLanguageOptions ` ********************************************************************************************************************************* .. autoclass:: PopupLanguageOptions @@ -40,7 +40,7 @@ class: :class:`PopupLanguageOptions ` +:mod:`.shared_options ` ############################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.global_options.shared_options +.. module:: highcharts_core.global_options.shared_options ********************************************************************************************** -class: :class:`SharedOptions ` +class: :class:`SharedOptions ` ********************************************************************************************** .. autoclass:: SharedOptions @@ -22,7 +22,7 @@ class: :class:`SharedOptions ` +:mod:`.headless_export ` ############################################################ .. contents:: Module Contents @@ -9,10 +9,10 @@ ----------------- -.. module:: highcharts_python.headless_export +.. module:: highcharts_core.headless_export ********************************************************************************* -class: :class:`ExportServer ` +class: :class:`ExportServer ` ********************************************************************************* .. autoclass:: ExportServer @@ -22,7 +22,7 @@ class: :class:`ExportServer ` .. collapse:: Class Inheritance .. inheritance-diagram:: ExportServer - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/highcharts.rst b/docs/api/highcharts.rst index 53970d41..5b7aeceb 100644 --- a/docs/api/highcharts.rst +++ b/docs/api/highcharts.rst @@ -1,5 +1,5 @@ ################################################## -:mod:`.highcharts ` +:mod:`.highcharts ` ################################################## .. contents:: Module Contents @@ -7,9 +7,9 @@ :depth: 3 :backlinks: entry -.. module:: highcharts_python.highcharts +.. module:: highcharts_core.highcharts -The :mod:`highcharts_python.highcharts` module is designed to be a catch-all module for +The :mod:`highcharts_core.highcharts` module is designed to be a catch-all module for ease of importing. It does not actually define any functionality itself, but instead imports classes from across the **Highcharts for Python** library to expose them under a single import statement. This enables you to choose between whatever import-style you @@ -19,7 +19,7 @@ prefer to apply: .. caution:: - You should be aware that importing the :mod:`highcharts_python.highcharts` module takes + You should be aware that importing the :mod:`highcharts_core.highcharts` module takes a relatively long time. This is because it needs to import hundreds of other classes from across the entire library. Assuming you are just doing it once, this may be acceptable to you. However you should be aware that is much less performant than diff --git a/docs/api/internals.rst b/docs/api/internals.rst index ae83c8da..7f40ada2 100644 --- a/docs/api/internals.rst +++ b/docs/api/internals.rst @@ -9,18 +9,18 @@ Library Internals -------------- -.. module:: highcharts_python.metaclasses +.. module:: highcharts_core.metaclasses ****************************************************************************** -module: :mod:`.metaclasses ` +module: :mod:`.metaclasses ` ****************************************************************************** -The :mod:`.metaclasses ` module contains - as one might +The :mod:`.metaclasses ` module contains - as one might expect - :term:`metaclasses ` that are used to ensure a consistent interface throughout the **Highcharts for Python** library. -class: :class:`HighchartsMeta ` +class: :class:`HighchartsMeta ` =================================================================================== .. autoclass:: HighchartsMeta @@ -35,7 +35,7 @@ class: :class:`HighchartsMeta ` | -class: :class:`JavaScriptDict ` +class: :class:`JavaScriptDict ` ==================================================================================== .. autoclass:: JavaScriptDict @@ -52,120 +52,120 @@ class: :class:`JavaScriptDict ` ---------------------- -.. module:: highcharts_python.decorators +.. module:: highcharts_core.decorators ****************************************************************************** -module: :mod:`.decorators ` +module: :mod:`.decorators ` ****************************************************************************** -The :mod:`.decorators ` module contains decorators and +The :mod:`.decorators ` module contains decorators and decorator-assisting functions used throughout the **Highcharts for Python** library. -decorator: :deco:`@class_sensitive ` +decorator: :deco:`@class_sensitive ` ======================================================================================= .. autodecorator:: class_sensitive -function: :func:`validate_types() ` +function: :func:`validate_types() ` =================================================================================== .. autofunction:: validate_types ---------------------------------- -.. module:: highcharts_python.js_literal_functions +.. module:: highcharts_core.js_literal_functions ****************************************************************************************** -module:: :mod:`.js_literal_functions ` +module:: :mod:`.js_literal_functions ` ****************************************************************************************** -The :mod:`.js_literal_functions ` module contains +The :mod:`.js_literal_functions ` module contains functions that are used to parse, process, de-serialize, and serialize JavaScript literal notation. -function: :func:`serialize_to_js_literal() ` +function: :func:`serialize_to_js_literal() ` =================================================================================================================================== .. autofunction:: serialize_to_js_literal -function: :func:`attempt_variable_declaration() ` +function: :func:`attempt_variable_declaration() ` =================================================================================================================================== .. autofunction:: attempt_variable_declaration -function: :func:`is_js_function_or_class() ` +function: :func:`is_js_function_or_class() ` =================================================================================================================================== .. autofunction:: is_js_function_or_class -function: :func:`get_js_literal() ` +function: :func:`get_js_literal() ` =================================================================================================================================== .. autofunction:: get_js_literal -function: :func:`assemble_js_literal() ` +function: :func:`assemble_js_literal() ` =================================================================================================================================== .. autofunction:: assemble_js_literal -function: :func:`convert_js_literal_to_python() ` +function: :func:`convert_js_literal_to_python() ` =================================================================================================================================== .. autofunction:: convert_js_literal_to_python -function: :func:`convert_js_property_to_python() ` +function: :func:`convert_js_property_to_python() ` =================================================================================================================================== .. autofunction:: convert_js_property_to_python -function: :func:`convert_js_to_python() ` +function: :func:`convert_js_to_python() ` =================================================================================================================================== .. autofunction:: convert_js_to_python -function: :func:`get_key_value_pairs() ` +function: :func:`get_key_value_pairs() ` =================================================================================================================================== .. autofunction:: get_key_value_pairs ------------------------- -.. module:: highcharts_python.utility_functions +.. module:: highcharts_core.utility_functions ******************************************************************** -:mod:`.utility_functions ` +:mod:`.utility_functions ` ******************************************************************** -The :mod:`.utility_functions ` module contains a +The :mod:`.utility_functions ` module contains a small number of functions which serve as utilities across the **Highcharts for Python** library. Think of it as a function "catch all" module. -function:: :func:`mro_to_dict() ` +function:: :func:`mro_to_dict() ` ===================================================================================================== .. autofunction:: mro_to_dict -function:: :func:`get_remaining_mro() ` +function:: :func:`get_remaining_mro() ` ===================================================================================================== .. autofunction:: get_remaining_mro -function:: :func:`mro__to_untrimmed_dict() ` +function:: :func:`mro__to_untrimmed_dict() ` ============================================================================================================== .. autofunction:: mro__to_untrimmed_dict -function:: :func:`validate_color() ` +function:: :func:`validate_color() ` ===================================================================================================== .. autofunction:: validate_color -function:: :func:`to_camelCase() ` +function:: :func:`to_camelCase() ` ===================================================================================================== .. autofunction:: to_camelCase -function:: :func:`parse_csv() ` +function:: :func:`parse_csv() ` ===================================================================================================== .. autofunction:: parse_csv diff --git a/docs/api/options/accessibility/announce_new_data.rst b/docs/api/options/accessibility/announce_new_data.rst index 603e2a1a..95df2c9b 100644 --- a/docs/api/options/accessibility/announce_new_data.rst +++ b/docs/api/options/accessibility/announce_new_data.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.announce_new_data ` +:mod:`.announce_new_data ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.announce_new_data +.. module:: highcharts_core.options.accessibility.announce_new_data **************************************************************************************************************** -class: :class:`AnnounceNewData ` +class: :class:`AnnounceNewData ` **************************************************************************************************************** .. autoclass:: AnnounceNewData @@ -22,7 +22,7 @@ class: :class:`AnnounceNewData ` +:mod:`.accessibility ` ################################################################ .. contents:: Module Contents @@ -18,10 +18,10 @@ -------------- -.. module:: highcharts_python.options.accessibility +.. module:: highcharts_core.options.accessibility **************************************************************************************** -class: :class:`Accessibility +class: :class:`Accessibility **************************************************************************************** .. autoclass:: Accessibility @@ -31,7 +31,7 @@ class: :class:`Accessibility +class: :class:`CustomAccessibilityComponents *************************************************************************************************************************** .. autoclass:: CustomAccessibilityComponents @@ -49,7 +49,7 @@ class: :class:`CustomAccessibilityComponents ` - - :class:`Accessibility ` - :class:`CustomAccessibilityComponents ` - * - :mod:`.options.accessibility.announce_new_data ` - - :class:`AnnounceNewData ` - * - :mod:`.options.accessibility.keyboard_navigation ` - - :class:`KeyboardNavigation ` - * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` - - :class:`FocusBorder ` - :class:`FocusBorderStyle ` - * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` - - :class:`SeriesNavigation ` - * - :mod:`options.accessibility.point ` - - :class:`AccessibilityPoint ` - * - :mod:`options.accessibility.screen_reader_section ` - - :class:`ScreenReaderSection ` - * - :mod:`options.accessibility.series ` - - :class:`SeriesAccessibility ` + * - :mod:`.options.accessibility ` + - :class:`Accessibility ` + :class:`CustomAccessibilityComponents ` + * - :mod:`.options.accessibility.announce_new_data ` + - :class:`AnnounceNewData ` + * - :mod:`.options.accessibility.keyboard_navigation ` + - :class:`KeyboardNavigation ` + * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` + - :class:`FocusBorder ` + :class:`FocusBorderStyle ` + * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` + - :class:`SeriesNavigation ` + * - :mod:`options.accessibility.point ` + - :class:`AccessibilityPoint ` + * - :mod:`options.accessibility.screen_reader_section ` + - :class:`ScreenReaderSection ` + * - :mod:`options.accessibility.series ` + - :class:`SeriesAccessibility ` diff --git a/docs/api/options/accessibility/keyboard_navigation/focus_border.rst b/docs/api/options/accessibility/keyboard_navigation/focus_border.rst index 7d257a0a..8813d560 100644 --- a/docs/api/options/accessibility/keyboard_navigation/focus_border.rst +++ b/docs/api/options/accessibility/keyboard_navigation/focus_border.rst @@ -1,5 +1,5 @@ ################################################################################################# -:mod:`.focus_border ` +:mod:`.focus_border ` ################################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.keyboard_navigation.focus_border +.. module:: highcharts_core.options.accessibility.keyboard_navigation.focus_border ********************************************************************************************************************************************** -class: :class:`FocusBorder ` +class: :class:`FocusBorder ` ********************************************************************************************************************************************** .. autoclass:: FocusBorder @@ -22,7 +22,7 @@ class: :class:`FocusBorder ` +class: :class:`FocusBorderStyle ` ********************************************************************************************************************************************** .. autoclass:: FocusBorderStyle @@ -40,7 +40,7 @@ class: :class:`FocusBorderStyle ` +:mod:`.keyboard_navigation ` ########################################################################################## .. contents:: Module Contents @@ -15,10 +15,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.keyboard_navigation +.. module:: highcharts_core.options.accessibility.keyboard_navigation ***************************************************************************************************************************************** -class: :class:`KeyboardNavigation ` +class: :class:`KeyboardNavigation ` ***************************************************************************************************************************************** .. autoclass:: KeyboardNavigation @@ -28,7 +28,7 @@ class: :class:`KeyboardNavigation ` - - :class:`KeyboardNavigation ` - * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` - - :class:`FocusBorder ` - :class:`FocusBorderStyle ` - * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` - - :class:`SeriesNavigation ` + * - :mod:`.options.accessibility.keyboard_navigation ` + - :class:`KeyboardNavigation ` + * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` + - :class:`FocusBorder ` + :class:`FocusBorderStyle ` + * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` + - :class:`SeriesNavigation ` diff --git a/docs/api/options/accessibility/keyboard_navigation/series_navigation.rst b/docs/api/options/accessibility/keyboard_navigation/series_navigation.rst index 6cb35a80..ddf8248d 100644 --- a/docs/api/options/accessibility/keyboard_navigation/series_navigation.rst +++ b/docs/api/options/accessibility/keyboard_navigation/series_navigation.rst @@ -1,5 +1,5 @@ ############################################################################################################ -:mod:`.series_navigation ` +:mod:`.series_navigation ` ############################################################################################################ .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.keyboard_navigation.series_navigation +.. module:: highcharts_core.options.accessibility.keyboard_navigation.series_navigation ********************************************************************************************************************************************** -class: :class:`SeriesNavigation ` +class: :class:`SeriesNavigation ` ********************************************************************************************************************************************** .. autoclass:: SeriesNavigation @@ -22,7 +22,7 @@ class: :class:`SeriesNavigation ` +:mod:`.point ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.point +.. module:: highcharts_core.options.accessibility.point ******************************************************************************************************** -class: :class:`AccessibilityPoint ` +class: :class:`AccessibilityPoint ` ******************************************************************************************************** .. autoclass:: AccessibilityPoint @@ -22,7 +22,7 @@ class: :class:`AccessibilityPoint ` +:mod:`.screen_reader_section ` ################################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.screen_reader_section +.. module:: highcharts_core.options.accessibility.screen_reader_section ********************************************************************************************************************************************** -class: :class:`ScreenReaderSection ` +class: :class:`ScreenReaderSection ` ********************************************************************************************************************************************** .. autoclass:: ScreenReaderSection @@ -22,7 +22,7 @@ class: :class:`ScreenReaderSection ` +:mod:`.series ` ################################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.accessibility.series +.. module:: highcharts_core.options.accessibility.series ********************************************************************************************************************************************** -class: :class:`SeriesAccessibility ` +class: :class:`SeriesAccessibility ` ********************************************************************************************************************************************** .. autoclass:: SeriesAccessibility @@ -22,7 +22,7 @@ class: :class:`SeriesAccessibility ` +:mod:`.animation ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.animation +.. module:: highcharts_core.options.annotations.animation ******************************************************************************************************************** -class: :class:`AnnotationAnimation ` +class: :class:`AnnotationAnimation ` ******************************************************************************************************************** .. autoclass:: AnnotationAnimation @@ -22,7 +22,7 @@ class: :class:`AnnotationAnimation ` +:mod:`.control_point_options ` ############################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.control_point_options +.. module:: highcharts_core.options.annotations.control_point_options ******************************************************************************************************************************************* -class: :class:`AnnotationControlPointOption ` +class: :class:`AnnotationControlPointOption ` ******************************************************************************************************************************************* .. autoclass:: AnnotationControlPointOption @@ -22,7 +22,7 @@ class: :class:`AnnotationControlPointOption ` +:mod:`.events ` ############################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.events +.. module:: highcharts_core.options.annotations.events ******************************************************************************************************************************************* -class: :class:`AnnotationEvent ` +class: :class:`AnnotationEvent ` ******************************************************************************************************************************************* .. autoclass:: AnnotationEvent @@ -22,7 +22,7 @@ class: :class:`AnnotationEvent ` +:mod:`.annotations ` ################################################################ .. contents:: Module Contents @@ -19,10 +19,10 @@ -------------- -.. module:: highcharts_python.options.annotations +.. module:: highcharts_core.options.annotations **************************************************************************************** -class: :class:`Annotation ` +class: :class:`Annotation ` **************************************************************************************** .. autoclass:: Annotation @@ -32,7 +32,7 @@ class: :class:`Annotation ` .. collapse:: Class Inheritance .. inheritance-diagram:: Annotation - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -49,20 +49,20 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.annotations ` - - :class:`Annotation ` - * - :mod:`.options.annotations.animation ` - - :class:`AnnotationAnimation ` - * - :mod:`.options.annotations.control_point_options ` - - :class:`AnnotationControlPointOption ` - * - :mod:`.options.annotations.events ` - - :class:`AnnotationEvent ` - * - :mod:`.options.annotations.label_options ` - - :class:`AnnotationLabel ` - :class:`AnnotationLabelOptionAccessibility ` - :class:`LabelOptions ` - * - :mod:`.options.annotations.options.annotations.points ` - - :class:`AnnotationPoint ` - * - :mod:`.options.annotations.shape_options ` - - :class:`AnnotationShape ` - :class:`ShapeOptions ` + * - :mod:`.options.annotations ` + - :class:`Annotation ` + * - :mod:`.options.annotations.animation ` + - :class:`AnnotationAnimation ` + * - :mod:`.options.annotations.control_point_options ` + - :class:`AnnotationControlPointOption ` + * - :mod:`.options.annotations.events ` + - :class:`AnnotationEvent ` + * - :mod:`.options.annotations.label_options ` + - :class:`AnnotationLabel ` + :class:`AnnotationLabelOptionAccessibility ` + :class:`LabelOptions ` + * - :mod:`.options.annotations.options.annotations.points ` + - :class:`AnnotationPoint ` + * - :mod:`.options.annotations.shape_options ` + - :class:`AnnotationShape ` + :class:`ShapeOptions ` diff --git a/docs/api/options/annotations/label_options.rst b/docs/api/options/annotations/label_options.rst index adafe5f8..da2329ba 100644 --- a/docs/api/options/annotations/label_options.rst +++ b/docs/api/options/annotations/label_options.rst @@ -1,5 +1,5 @@ ############################################################################################# -:mod:`.label_options ` +:mod:`.label_options ` ############################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.label_options +.. module:: highcharts_core.options.annotations.label_options ******************************************************************************************************************************************* -class: :class:`AnnotationLabel ` +class: :class:`AnnotationLabel ` ******************************************************************************************************************************************* .. autoclass:: AnnotationLabel @@ -22,7 +22,7 @@ class: :class:`AnnotationLabel ` +class: :class:`AnnotationLabelOptionAccessibility ` ******************************************************************************************************************************************** .. autoclass:: AnnotationLabelOptionAccessibility @@ -40,7 +40,7 @@ class: :class:`AnnotationLabelOptionAccessibility ` +class: :class:`LabelOptions ` ******************************************************************************************************************************************** .. autoclass:: LabelOptions @@ -58,7 +58,7 @@ class: :class:`LabelOptions ` +:mod:`.points ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.points +.. module:: highcharts_core.options.annotations.points ******************************************************************************************************** -class: :class:`AnnotationPoint ` +class: :class:`AnnotationPoint ` ******************************************************************************************************** .. autoclass:: AnnotationPoint @@ -22,7 +22,7 @@ class: :class:`AnnotationPoint ` +:mod:`.shape_options ` ############################################################################################# .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.annotations.shape_options +.. module:: highcharts_core.options.annotations.shape_options ******************************************************************************************************************************************* -class: :class:`AnnotationShape ` +class: :class:`AnnotationShape ` ******************************************************************************************************************************************* .. autoclass:: AnnotationShape @@ -22,13 +22,13 @@ class: :class:`AnnotationShape ` +class: :class:`ShapeOptions ` ******************************************************************************************************************************************* .. autoclass:: ShapeOptions @@ -38,5 +38,5 @@ class: :class:`ShapeOptions ` +:mod:`.accessibility ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.accessibility +.. module:: highcharts_core.options.axes.accessibility ******************************************************************************************************************** -class: :class:`AxisAccessibility ` +class: :class:`AxisAccessibility ` ******************************************************************************************************************** .. autoclass:: AxisAccessibility @@ -22,7 +22,7 @@ class: :class:`AxisAccessibility ` +:mod:`.breaks ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.breaks +.. module:: highcharts_core.options.axes.breaks ******************************************************************************************************************** -class: :class:`AxisBreak ` +class: :class:`AxisBreak ` ******************************************************************************************************************** .. autoclass:: AxisBreak @@ -22,7 +22,7 @@ class: :class:`AxisBreak ` .. collapse:: Class Inheritance .. inheritance-diagram:: AxisBreak - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/color_axis.rst b/docs/api/options/axes/color_axis.rst index 7bab7897..9764707c 100644 --- a/docs/api/options/axes/color_axis.rst +++ b/docs/api/options/axes/color_axis.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.color_axis ` +:mod:`.color_axis ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.color_axis +.. module:: highcharts_core.options.axes.color_axis ******************************************************************************************************************** -class: :class:`ColorAxis ` +class: :class:`ColorAxis ` ******************************************************************************************************************** .. autoclass:: ColorAxis @@ -22,7 +22,7 @@ class: :class:`ColorAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: ColorAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/crosshair.rst b/docs/api/options/axes/crosshair.rst index 54417948..f39e33b1 100644 --- a/docs/api/options/axes/crosshair.rst +++ b/docs/api/options/axes/crosshair.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.crosshair ` +:mod:`.crosshair ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.crosshair +.. module:: highcharts_core.options.axes.crosshair ******************************************************************************************************************** -class: :class:`CrosshairOptions ` +class: :class:`CrosshairOptions ` ******************************************************************************************************************** .. autoclass:: CrosshairOptions @@ -22,7 +22,7 @@ class: :class:`CrosshairOptions ` +:mod:`.data_classes ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.data_classes +.. module:: highcharts_core.options.axes.data_classes ******************************************************************************************************************** -class: :class:`DataClass ` +class: :class:`DataClass ` ******************************************************************************************************************** .. autoclass:: DataClass @@ -22,7 +22,7 @@ class: :class:`DataClass .. collapse:: Class Inheritance .. inheritance-diagram:: DataClass - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/generic.rst b/docs/api/options/axes/generic.rst index d643d92e..89f5c7e5 100644 --- a/docs/api/options/axes/generic.rst +++ b/docs/api/options/axes/generic.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.generic ` +:mod:`.generic ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.generic +.. module:: highcharts_core.options.axes.generic ******************************************************************************************************************** -class: :class:`GenericAxis ` +class: :class:`GenericAxis ` ******************************************************************************************************************** .. autoclass:: GenericAxis @@ -22,7 +22,7 @@ class: :class:`GenericAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: GenericAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/index.rst b/docs/api/options/axes/index.rst index 5e782efd..0160a3bf 100644 --- a/docs/api/options/axes/index.rst +++ b/docs/api/options/axes/index.rst @@ -1,5 +1,5 @@ ################################################################ -:mod:`.axes ` +:mod:`.axes ` ################################################################ .. contents:: Module Contents @@ -38,38 +38,38 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.axes ` + * - :mod:`.options.axes ` - - * - :mod:`.options.axes.accessibility ` - - :class:`AxisAccessibility ` - * - :mod:`.options.axes.breaks ` - - :class:`AxisBreak ` - * - :mod:`.options.axes.color_axis ` - - :class:`ColorAxis ` - * - :mod:`.options.axes.crosshair ` - - :class:`CrosshairOptions ` - * - :mod:`.options.axes.data_classes ` - - :class:`DataClass ` - * - :mod:`.options.axes.generic ` - - :class:`GenericAxis ` - * - :mod:`.options.axes.labels ` - - :class:`AxisLabelOptions ` - :class:`PlotBandLabel ` - :class:`PlotLineLabel ` - * - :mod:`.options.axes.markers ` - - :class:`AxisMarker ` - * - :mod:`.options.axes.numeric ` - - :class:`NumericAxis ` - * - :mod:`.options.axes.parallel_axes ` - - :class:`ParallelAxesOptions ` - * - :mod:`.options.axes.plot_bands ` - - :class:`PlotBand ` - :class:`PlotLine ` - * - :mod:`.options.axes.title ` - - :class:`AxisTitle ` - * - :mod:`.options.axes.x_axis ` - - :class:`XAxis ` - * - :mod:`.options.axes.y_axis ` - - :class:`YAxis ` - * - :mod:`.options.axes.z_axis ` - - :class:`ZAxis ` + * - :mod:`.options.axes.accessibility ` + - :class:`AxisAccessibility ` + * - :mod:`.options.axes.breaks ` + - :class:`AxisBreak ` + * - :mod:`.options.axes.color_axis ` + - :class:`ColorAxis ` + * - :mod:`.options.axes.crosshair ` + - :class:`CrosshairOptions ` + * - :mod:`.options.axes.data_classes ` + - :class:`DataClass ` + * - :mod:`.options.axes.generic ` + - :class:`GenericAxis ` + * - :mod:`.options.axes.labels ` + - :class:`AxisLabelOptions ` + :class:`PlotBandLabel ` + :class:`PlotLineLabel ` + * - :mod:`.options.axes.markers ` + - :class:`AxisMarker ` + * - :mod:`.options.axes.numeric ` + - :class:`NumericAxis ` + * - :mod:`.options.axes.parallel_axes ` + - :class:`ParallelAxesOptions ` + * - :mod:`.options.axes.plot_bands ` + - :class:`PlotBand ` + :class:`PlotLine ` + * - :mod:`.options.axes.title ` + - :class:`AxisTitle ` + * - :mod:`.options.axes.x_axis ` + - :class:`XAxis ` + * - :mod:`.options.axes.y_axis ` + - :class:`YAxis ` + * - :mod:`.options.axes.z_axis ` + - :class:`ZAxis ` diff --git a/docs/api/options/axes/labels.rst b/docs/api/options/axes/labels.rst index 81a83e7a..90fc1214 100644 --- a/docs/api/options/axes/labels.rst +++ b/docs/api/options/axes/labels.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.labels ` +:mod:`.labels ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.labels +.. module:: highcharts_core.options.axes.labels ******************************************************************************************************************** -class: :class:`AxisLabelOptions ` +class: :class:`AxisLabelOptions ` ******************************************************************************************************************** .. autoclass:: AxisLabelOptions @@ -22,7 +22,7 @@ class: :class:`AxisLabelOptions ` +class: :class:`PlotBandLabel ` ******************************************************************************************************************** .. autoclass:: PlotBandLabel @@ -40,7 +40,7 @@ class: :class:`PlotBandLabel ` +class: :class:`PlotLineLabel ` ******************************************************************************************************************** .. autoclass:: PlotLineLabel @@ -58,7 +58,7 @@ class: :class:`PlotLineLabel ` +:mod:`.markers ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.markers +.. module:: highcharts_core.options.axes.markers ******************************************************************************************************************** -class: :class:`AxisMarker ` +class: :class:`AxisMarker ` ******************************************************************************************************************** .. autoclass:: AxisMarker @@ -22,7 +22,7 @@ class: :class:`AxisMarker ` .. collapse:: Class Inheritance .. inheritance-diagram:: AxisMarker - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/numeric.rst b/docs/api/options/axes/numeric.rst index 705c4a1e..9b177cad 100644 --- a/docs/api/options/axes/numeric.rst +++ b/docs/api/options/axes/numeric.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.numeric ` +:mod:`.numeric ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.numeric +.. module:: highcharts_core.options.axes.numeric ******************************************************************************************************************** -class: :class:`NumericAxis ` +class: :class:`NumericAxis ` ******************************************************************************************************************** .. autoclass:: NumericAxis @@ -22,7 +22,7 @@ class: :class:`NumericAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: NumericAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/parallel_axes.rst b/docs/api/options/axes/parallel_axes.rst index 6d20b22e..ea880a97 100644 --- a/docs/api/options/axes/parallel_axes.rst +++ b/docs/api/options/axes/parallel_axes.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.parallel_axes ` +:mod:`.parallel_axes ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.parallel_axes +.. module:: highcharts_core.options.axes.parallel_axes ******************************************************************************************************************** -class: :class:`ParallelAxesOptions ` +class: :class:`ParallelAxesOptions ` ******************************************************************************************************************** .. autoclass:: ParallelAxesOptions @@ -22,7 +22,7 @@ class: :class:`ParallelAxesOptions ` +:mod:`.plot_bands ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.plot_bands +.. module:: highcharts_core.options.axes.plot_bands ******************************************************************************************************************** -class: :class:`PlotBand ` +class: :class:`PlotBand ` ******************************************************************************************************************** .. autoclass:: PlotBand @@ -22,7 +22,7 @@ class: :class:`PlotBand ` .. collapse:: Class Inheritance .. inheritance-diagram:: PlotBand - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`PlotBand ` ------------------------- ******************************************************************************************************************** -class: :class:`PlotLine ` +class: :class:`PlotLine ` ******************************************************************************************************************** .. autoclass:: PlotLine @@ -40,7 +40,7 @@ class: :class:`PlotLine ` .. collapse:: Class Inheritance .. inheritance-diagram:: PlotLine - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/title.rst b/docs/api/options/axes/title.rst index 5d080416..85498531 100644 --- a/docs/api/options/axes/title.rst +++ b/docs/api/options/axes/title.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.title ` +:mod:`.title ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.title +.. module:: highcharts_core.options.axes.title ******************************************************************************************************************** -class: :class:`AxisTitle ` +class: :class:`AxisTitle ` ******************************************************************************************************************** .. autoclass:: AxisTitle @@ -22,7 +22,7 @@ class: :class:`AxisTitle ` .. collapse:: Class Inheritance .. inheritance-diagram:: AxisTitle - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/x_axis.rst b/docs/api/options/axes/x_axis.rst index bfee07cd..00656e5b 100644 --- a/docs/api/options/axes/x_axis.rst +++ b/docs/api/options/axes/x_axis.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.x_axis ` +:mod:`.x_axis ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.x_axis +.. module:: highcharts_core.options.axes.x_axis ******************************************************************************************************************** -class: :class:`XAxis ` +class: :class:`XAxis ` ******************************************************************************************************************** .. autoclass:: XAxis @@ -22,7 +22,7 @@ class: :class:`XAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: XAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/y_axis.rst b/docs/api/options/axes/y_axis.rst index 8a0f82aa..49bc41ea 100644 --- a/docs/api/options/axes/y_axis.rst +++ b/docs/api/options/axes/y_axis.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.y_axis ` +:mod:`.y_axis ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.y_axis +.. module:: highcharts_core.options.axes.y_axis ******************************************************************************************************************** -class: :class:`YAxis ` +class: :class:`YAxis ` ******************************************************************************************************************** .. autoclass:: YAxis @@ -22,7 +22,7 @@ class: :class:`YAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: YAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/axes/z_axis.rst b/docs/api/options/axes/z_axis.rst index 01c31c86..c37497f7 100644 --- a/docs/api/options/axes/z_axis.rst +++ b/docs/api/options/axes/z_axis.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.z_axis ` +:mod:`.z_axis ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.axes.z_axis +.. module:: highcharts_core.options.axes.z_axis ******************************************************************************************************************** -class: :class:`ZAxis ` +class: :class:`ZAxis ` ******************************************************************************************************************** .. autoclass:: ZAxis @@ -22,7 +22,7 @@ class: :class:`ZAxis ` .. collapse:: Class Inheritance .. inheritance-diagram:: ZAxis - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/boost.rst b/docs/api/options/boost.rst index 78227416..3cc1a050 100644 --- a/docs/api/options/boost.rst +++ b/docs/api/options/boost.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.boost ` +:mod:`.boost ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.boost +.. module:: highcharts_core.options.boost ******************************************************************************************************************** -class: :class:`Boost ` +class: :class:`Boost ` ******************************************************************************************************************** .. autoclass:: Boost @@ -22,7 +22,7 @@ class: :class:`Boost ` .. collapse:: Class Inheritance .. inheritance-diagram:: Boost - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Boost ` ---------------------------- ******************************************************************************************************************** -class: :class:`BoostDebug ` +class: :class:`BoostDebug ` ******************************************************************************************************************** .. autoclass:: BoostDebug @@ -40,7 +40,7 @@ class: :class:`BoostDebug ` .. collapse:: Class Inheritance .. inheritance-diagram:: BoostDebug - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/caption.rst b/docs/api/options/caption.rst index 6be43905..95a2a9ea 100644 --- a/docs/api/options/caption.rst +++ b/docs/api/options/caption.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.caption ` +:mod:`.caption ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.caption +.. module:: highcharts_core.options.caption ******************************************************************************************************************** -class: :class:`Caption ` +class: :class:`Caption ` ******************************************************************************************************************** .. autoclass:: Caption @@ -22,7 +22,7 @@ class: :class:`Caption ` .. collapse:: Class Inheritance .. inheritance-diagram:: Caption - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/chart/index.rst b/docs/api/options/chart/index.rst index ee3a00f6..f2831345 100644 --- a/docs/api/options/chart/index.rst +++ b/docs/api/options/chart/index.rst @@ -1,5 +1,5 @@ ################################################################ -:mod:`.chart ` +:mod:`.options.chart ` ################################################################ .. contents:: Module Contents @@ -13,13 +13,14 @@ options_3d reset_zoom_button scrollable_plot_area + zooming ------------------------- -.. module:: highcharts_python.options.chart +.. module:: highcharts_core.options.chart ******************************************************************************************************************** -class: :class:`ChartOptions ` +class: :class:`ChartOptions ` ******************************************************************************************************************** .. autoclass:: ChartOptions @@ -29,7 +30,7 @@ class: :class:`ChartOptions ` .. collapse:: Class Inheritance .. inheritance-diagram:: ChartOptions - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -37,7 +38,7 @@ class: :class:`ChartOptions ` ------------------------- ******************************************************************************************************************** -class: :class:`PanningOptions ` +class: :class:`PanningOptions ` ******************************************************************************************************************** .. autoclass:: PanningOptions @@ -47,7 +48,7 @@ class: :class:`PanningOptions ` .. collapse:: Class Inheritance .. inheritance-diagram:: PanningOptions - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -64,14 +65,16 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.chart ` - - :class:`ChartOptions ` - :class:`PanningOptions ` - * - :mod:`.chart.options_3d ` - - :class:`Options3D ` - :class:`Frame ` - :class:`PanelOptions ` - * - :mod:`.chart.reset_zoom_button ` - - :class:`ResetZoomButtonOptions ` - * - :mod:`.chart.scrollable_plot_area ` - - :class:`ScrollablePlotArea ` + * - :mod:`.options.chart ` + - :class:`ChartOptions ` + :class:`PanningOptions ` + * - :mod:`.options.chart.options_3d ` + - :class:`Options3D ` + :class:`Frame ` + :class:`PanelOptions ` + * - :mod:`.options.chart.reset_zoom_button ` + - :class:`ResetZoomButtonOptions ` + * - :mod:`.options.chart.scrollable_plot_area ` + - :class:`ScrollablePlotArea ` + * - :mod:`.options.chart.zooming ` + - :class:`ZoomingOptions ` diff --git a/docs/api/options/chart/options_3d.rst b/docs/api/options/chart/options_3d.rst index f71ec57d..b276b671 100644 --- a/docs/api/options/chart/options_3d.rst +++ b/docs/api/options/chart/options_3d.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.options_3d ` +:mod:`.options_3d ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.chart.options_3d +.. module:: highcharts_core.options.chart.options_3d ******************************************************************************************************************** -class: :class:`Options3D ` +class: :class:`Options3D ` ******************************************************************************************************************** .. autoclass:: Options3D @@ -22,7 +22,7 @@ class: :class:`Options3D ` .. collapse:: Class Inheritance .. inheritance-diagram:: Options3D - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Options3D ` ------------------- ******************************************************************************************************************** -class: :class:`Frame ` +class: :class:`Frame ` ******************************************************************************************************************** .. autoclass:: Frame @@ -40,7 +40,7 @@ class: :class:`Frame ` .. collapse:: Class Inheritance .. inheritance-diagram:: Frame - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -48,7 +48,7 @@ class: :class:`Frame ` ------------------- ******************************************************************************************************************** -class: :class:`PanelOptions ` +class: :class:`PanelOptions ` ******************************************************************************************************************** .. autoclass:: PanelOptions @@ -58,7 +58,7 @@ class: :class:`PanelOptions ` +:mod:`.reset_zoom_button ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.chart.reset_zoom_button +.. module:: highcharts_core.options.chart.reset_zoom_button ******************************************************************************************************************** -class: :class:`ResetZoomButtonOptions ` +class: :class:`ResetZoomButtonOptions ` ******************************************************************************************************************** .. autoclass:: ResetZoomButtonOptions @@ -22,7 +22,7 @@ class: :class:`ResetZoomButtonOptions ` +:mod:`.scrollable_plot_area ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.chart.scrollable_plot_area +.. module:: highcharts_core.options.chart.scrollable_plot_area ******************************************************************************************************************** -class: :class:`ScrollablePlotArea ` +class: :class:`ScrollablePlotArea ` ******************************************************************************************************************** .. autoclass:: ScrollablePlotArea @@ -22,7 +22,7 @@ class: :class:`ScrollablePlotArea ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.chart.zooming + +******************************************************************************************************************** +class: :class:`ZoomingOptions ` +******************************************************************************************************************** + +.. autoclass:: ZoomingOptions + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: ZoomingOptions + :top-classes: highcharts_core.metaclasses.HighchartsMeta, highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/credits.rst b/docs/api/options/credits.rst index d8d7235b..c58fc611 100644 --- a/docs/api/options/credits.rst +++ b/docs/api/options/credits.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.scrollable_plot_area ` +:mod:`.scrollable_plot_area ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.credits +.. module:: highcharts_core.options.credits ******************************************************************************************************************** -class: :class:`Credits ` +class: :class:`Credits ` ******************************************************************************************************************** .. autoclass:: Credits @@ -22,7 +22,7 @@ class: :class:`Credits ` .. collapse:: Class Inheritance .. inheritance-diagram:: Credits - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Credits ` ----------------------- ******************************************************************************************************************** -class: :class:`CreditStyleOptions ` +class: :class:`CreditStyleOptions ` ******************************************************************************************************************** .. autoclass:: CreditStyleOptions @@ -40,7 +40,7 @@ class: :class:`CreditStyleOptions ` +:mod:`.data ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.data +.. module:: highcharts_core.options.data ******************************************************************************************************************** -class: :class:`Data ` +class: :class:`Data ` ******************************************************************************************************************** .. autoclass:: Data @@ -22,7 +22,7 @@ class: :class:`Data ` .. collapse:: Class Inheritance .. inheritance-diagram:: Data - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/defs.rst b/docs/api/options/defs.rst index 76dccc17..942b1089 100644 --- a/docs/api/options/defs.rst +++ b/docs/api/options/defs.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.defs ` +:mod:`.defs ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.defs +.. module:: highcharts_core.options.defs ******************************************************************************************************************** -class: :class:`MarkerDefinition ` +class: :class:`MarkerDefinition ` ******************************************************************************************************************** .. autoclass:: MarkerDefinition @@ -22,7 +22,7 @@ class: :class:`MarkerDefinition ` +class: :class:`MarkerASTNode ` ******************************************************************************************************************** .. autoclass:: MarkerASTNode @@ -40,7 +40,7 @@ class: :class:`MarkerASTNode ` .. collapse:: Class Inheritance .. inheritance-diagram:: MarkerASTNode - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -49,7 +49,7 @@ class: :class:`MarkerASTNode ` ---------------- ******************************************************************************************************************** -class: :class:`MarkerAttributeObject ` +class: :class:`MarkerAttributeObject ` ******************************************************************************************************************** .. autoclass:: MarkerAttributeObject @@ -59,7 +59,7 @@ class: :class:`MarkerAttributeObject ` +:mod:`.drilldown ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.drilldown +.. module:: highcharts_core.options.drilldown ******************************************************************************************************************** -class: :class:`Drilldown ` +class: :class:`Drilldown ` ******************************************************************************************************************** .. autoclass:: Drilldown @@ -22,7 +22,7 @@ class: :class:`Drilldown ` .. collapse:: Class Inheritance .. inheritance-diagram:: Drilldown - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/exporting/csv.rst b/docs/api/options/exporting/csv.rst index 21123781..0ccc6cb0 100644 --- a/docs/api/options/exporting/csv.rst +++ b/docs/api/options/exporting/csv.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.csv ` +:mod:`.csv ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.exporting.csv +.. module:: highcharts_core.options.exporting.csv ******************************************************************************************************************** -class: :class:`ExportingCSV ` +class: :class:`ExportingCSV ` ******************************************************************************************************************** .. autoclass:: ExportingCSV @@ -22,7 +22,7 @@ class: :class:`ExportingCSV ` +class: :class:`CSVAnnotationOptions ` ******************************************************************************************************************** .. autoclass:: CSVAnnotationOptions @@ -40,7 +40,7 @@ class: :class:`CSVAnnotationOptions ` +:mod:`.exporting ` ################################################################ .. contents:: Module Contents @@ -15,10 +15,10 @@ ------------------------- -.. module:: highcharts_python.options.exporting +.. module:: highcharts_core.options.exporting ******************************************************************************************************************** -class: :class:`Exporting ` +class: :class:`Exporting ` ******************************************************************************************************************** .. autoclass:: Exporting @@ -28,7 +28,7 @@ class: :class:`Exporting ` .. collapse:: Class Inheritance .. inheritance-diagram:: Exporting - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -36,7 +36,7 @@ class: :class:`Exporting ` ------------------------- ******************************************************************************************************************** -class: :class:`ExportingAccessibilityOptions ` +class: :class:`ExportingAccessibilityOptions ` ******************************************************************************************************************** .. autoclass:: ExportingAccessibilityOptions @@ -46,7 +46,7 @@ class: :class:`ExportingAccessibilityOptions ` - - :class:`Exporting ` - :class:`ExportingAccessibilityOptions ` - * - :mod:`.options.exporting.csv ` - - :class:`ExportingCSV ` - :class:`CSVAnnotationOptions ` - * - :mod:`.options.exporting.exporting.pdf_font ` - - :class:`PDFFontOptions ` + * - :mod:`.options.exporting ` + - :class:`Exporting ` + :class:`ExportingAccessibilityOptions ` + * - :mod:`.options.exporting.csv ` + - :class:`ExportingCSV ` + :class:`CSVAnnotationOptions ` + * - :mod:`.options.exporting.exporting.pdf_font ` + - :class:`PDFFontOptions ` diff --git a/docs/api/options/exporting/pdf_font.rst b/docs/api/options/exporting/pdf_font.rst index 3394bf8a..10dd6688 100644 --- a/docs/api/options/exporting/pdf_font.rst +++ b/docs/api/options/exporting/pdf_font.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.pdf_font ` +:mod:`.pdf_font ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.exporting.pdf_font +.. module:: highcharts_core.options.exporting.pdf_font ******************************************************************************************************************** -class: :class:`PDFFontOptions ` +class: :class:`PDFFontOptions ` ******************************************************************************************************************** .. autoclass:: PDFFontOptions @@ -22,7 +22,7 @@ class: :class:`PDFFontOptions ` +:mod:`.options ` ############################################################## .. contents:: Module Contents @@ -36,10 +36,10 @@ -------------- -.. module:: highcharts_python.options +.. module:: highcharts_core.options **************************************************************************************** -class: :class:`HighchartsOptions ` +class: :class:`HighchartsOptions ` **************************************************************************************** .. autoclass:: HighchartsOptions @@ -49,7 +49,7 @@ class: :class:`HighchartsOptions ` ----------------------- **************************************************************************************** -class: :class:`Options ` +class: :class:`Options ` **************************************************************************************** .. autoclass:: Options @@ -68,410 +68,412 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options ` - - :class:`HighchartsOptions ` - :class:`Options ` - * - :mod:`.options.accessibility ` - - :class:`Accessibility ` - :class:`CustomAccessibilityComponents ` - * - :mod:`.options.accessibility.announce_new_data ` - - :class:`AnnounceNewData ` - * - :mod:`.options.accessibility.keyboard_navigation ` - - :class:`KeyboardNavigation ` - * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` - - :class:`FocusBorder ` - :class:`FocusBorderStyle ` - * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` - - :class:`SeriesNavigation ` - * - :mod:`options.accessibility.point ` - - :class:`AccessibilityPoint ` - * - :mod:`options.accessibility.screen_reader_section ` - - :class:`ScreenReaderSection ` - * - :mod:`options.accessibility.series ` - - :class:`SeriesAccessibility ` - * - :mod:`.options.annotations ` - - :class:`Annotation ` - * - :mod:`.options.annotations.animation ` - - :class:`AnnotationAnimation ` - * - :mod:`.options.annotations.control_point_options ` - - :class:`AnnotationControlPointOption ` - * - :mod:`.options.annotations.events ` - - :class:`AnnotationEvent ` - * - :mod:`.options.annotations.label_options ` - - :class:`AnnotationLabel ` - :class:`AnnotationLabelOptionAccessibility ` - :class:`LabelOptions ` - * - :mod:`.options.annotations.options.annotations.points ` - - :class:`AnnotationPoint ` - * - :mod:`.options.annotations.shape_options ` - - :class:`AnnotationShape ` - :class:`ShapeOptions ` - * - :mod:`.options.axes ` + * - :mod:`.options ` + - :class:`HighchartsOptions ` + :class:`Options ` + * - :mod:`.options.accessibility ` + - :class:`Accessibility ` + :class:`CustomAccessibilityComponents ` + * - :mod:`.options.accessibility.announce_new_data ` + - :class:`AnnounceNewData ` + * - :mod:`.options.accessibility.keyboard_navigation ` + - :class:`KeyboardNavigation ` + * - :mod:`.options.accessibility.keyboard_navigation.focus_border ` + - :class:`FocusBorder ` + :class:`FocusBorderStyle ` + * - :mod:`.options.accessibility.keyboard_navigation.series_navigation ` + - :class:`SeriesNavigation ` + * - :mod:`options.accessibility.point ` + - :class:`AccessibilityPoint ` + * - :mod:`options.accessibility.screen_reader_section ` + - :class:`ScreenReaderSection ` + * - :mod:`options.accessibility.series ` + - :class:`SeriesAccessibility ` + * - :mod:`.options.annotations ` + - :class:`Annotation ` + * - :mod:`.options.annotations.animation ` + - :class:`AnnotationAnimation ` + * - :mod:`.options.annotations.control_point_options ` + - :class:`AnnotationControlPointOption ` + * - :mod:`.options.annotations.events ` + - :class:`AnnotationEvent ` + * - :mod:`.options.annotations.label_options ` + - :class:`AnnotationLabel ` + :class:`AnnotationLabelOptionAccessibility ` + :class:`LabelOptions ` + * - :mod:`.options.annotations.options.annotations.points ` + - :class:`AnnotationPoint ` + * - :mod:`.options.annotations.shape_options ` + - :class:`AnnotationShape ` + :class:`ShapeOptions ` + * - :mod:`.options.axes ` - - * - :mod:`.options.axes.accessibility ` - - :class:`AxisAccessibility ` - * - :mod:`.options.axes.breaks ` - - :class:`AxisBreak ` - * - :mod:`.options.axes.color_axis ` - - :class:`ColorAxis ` - * - :mod:`.options.axes.crosshair ` - - :class:`CrosshairOptions ` - * - :mod:`.options.axes.data_classes ` - - :class:`DataClass ` - * - :mod:`.options.axes.generic ` - - :class:`GenericAxis ` - * - :mod:`.options.axes.labels ` - - :class:`AxisLabelOptions ` - :class:`PlotBandLabel ` - :class:`PlotLineLabel ` - * - :mod:`.options.axes.markers ` - - :class:`AxisMarker ` - * - :mod:`.options.axes.numeric ` - - :class:`NumericAxis ` - * - :mod:`.options.axes.parallel_axes ` - - :class:`ParallelAxesOptions ` - * - :mod:`.options.axes.plot_bands ` - - :class:`PlotBand ` - :class:`PlotLine ` - * - :mod:`.options.axes.title ` - - :class:`AxisTitle ` - * - :mod:`.options.axes.x_axis ` - - :class:`XAxis ` - * - :mod:`.options.axes.y_axis ` - - :class:`YAxis ` - * - :mod:`.options.axes.z_axis ` - - :class:`ZAxis ` - * - :mod:`.options.boost ` - - :class:`Boost ` - :class:`BoostDebug ` - * - :mod:`.options.caption ` - - :class:`Caption ` - * - :mod:`.options.chart ` - - :class:`ChartOptions ` - :class:`PanningOptions ` - * - :mod:`.chart.options_3d ` - - :class:`Options3D ` - :class:`Frame ` - :class:`PanelOptions ` - * - :mod:`.chart.reset_zoom_button ` - - :class:`ResetZoomButtonOptions ` - * - :mod:`.chart.scrollable_plot_area ` - - :class:`ScrollablePlotArea ` - * - :mod:`.options.credits ` - - :class:`Credits ` - :class:`CreditStyleOptions ` - * - :mod:`.options.data ` - - :class:`Data ` - * - :mod:`.options.defs ` - - :class:`MarkerDefinition ` - :class:`MarkerASTNode ` - :class:`MarkerAttributeObject ` - * - :mod:`.options.drilldown ` - - :class:`Drilldown ` - * - :mod:`.options.exporting ` - - :class:`Exporting ` - :class:`ExportingAccessibilityOptions ` - * - :mod:`.options.exporting.csv ` - - :class:`ExportingCSV ` - :class:`CSVAnnotationOptions ` - * - :mod:`.options.exporting.exporting.pdf_font ` - - :class:`PDFFontOptions ` - * - :mod:`.options.legend ` - - :class:`Legend ` - * - :mod:`.options.legend.accessibility ` - - :class:`LegendAccessibilityOptions ` - :class:`LegendKeyboardNavigation ` - * - :mod:`.options.legend.bubble_legend ` - - :class:`BubbleLegend ` - :class:`BubbleLegendRange ` - :class:`BubbleLegendLabelOptions ` - * - :mod:`.options.legend.navigation ` - - :class:`LegendNavigation ` - * - :mod:`.options.legend.title ` - - :class:`LegendTitle ` - * - :mod:`.options.loading ` - - :class:`Loading ` - * - :mod:`.options.navigation ` - - :class:`Navigation ` - * - :mod:`.options.navigation.bindings ` - - :class:`Bindings ` - :class:`RectangleAnnotationBinding ` - :class:`LabelAnnotationBinding ` - :class:`EllipseAnnotationBinding ` - :class:`CircleAnnotationBinding ` - :class:`Binding ` - * - :mod:`.options.no_data ` - - :class:`NoData ` - * - :mod:`.options.pane ` - - :class:`Pane ` - :class:`PaneBackground ` - * - :mod:`.options.plot_options ` - - :class:`PlotOptions ` - * - :mod:`.options.plot_options.accessibility ` - - :class:`TypeOptionsAccessibility ` - :class:`SeriesKeyboardNavigation ` - * - :mod:`.options.plot_options.arcdiagram ` - - :class:`ArcDiagramOptions ` - * - :mod:`.options.plot_options.area ` - - :class:`AreaOptions ` - :class:`AreaRangeOptions ` - :class:`AreaSplineOptions ` - :class:`AreaSplineRangeOptions ` - :class:`LineOptions ` - :class:`StreamGraphOptions ` - * - :mod:`.options.plot_options.bar ` - - :class:`BarOptions ` - :class:`ColumnOptions ` - :class:`ColumnPyramidOptions ` - :class:`ColumnRangeOptions ` - :class:`CylinderOptions ` - :class:`VariwideOptions ` - :class:`WaterfallOptions ` - :class:`WindBarbOptions ` - :class:`XRangeOptions ` - :class:`BaseBarOptions ` - * - :mod:`.options.plot_options.bellcurve ` - - :class:`BellCurveOptions ` - * - :mod:`.options.plot_options.boxplot ` - - :class:`BoxPlotOptions ` - :class:`ErrorBarOptions ` - * - :mod:`.options.plot_options.bubble ` - - :class:`BubbleOptions ` - * - :mod:`.options.plot_options.bullet ` - - :class:`BulletOptions ` - :class:`TargetOptions ` - * - :mod:`.options.plot_options.data_sorting ` - - :class:`DataSorting ` - * - :mod:`.options.plot_options.dependencywheel ` - - :class:`DependencyWheelOptions ` - * - :mod:`.options.plot_options.drag_drop ` - - :class:`DragDropOptions ` - :class:`HighLowDragDropOptions ` - :class:`BoxPlotDragDropOptions ` - :class:`BulletDragDropOptions ` - :class:`GuideBox ` - :class:`GuideBoxOptions ` - :class:`DragHandle ` - * - :mod:`.options.plot_options.dumbbell ` - - :class:`DumbbellOptions ` - :class:`LollipopOptions ` - * - :mod:`.options.plot_options.funnel ` - - :class:`FunnelOptions ` - :class:`Funnel3DOptions ` - * - :mod:`.options.plot_options.gauge ` - - :class:`GaugeOptions ` - :class:`SolidGaugeOptions ` - * - :mod:`.options.plot_options.generic ` - - :class:`GenericTypeOptions ` - * - :mod:`.options.plot_options.Heatmap ` - - :class:`HeatmapOptions ` - :class:`TilemapOptions ` - * - :mod:`.options.plot_options.histogram ` - - :class:`HistogramOptions ` - * - :mod:`.options.plot_options.item ` - - :class:`ItemOptions ` - * - :mod:`.options.plot_options.levels ` - - :class:`LevelOptions ` - :class:`SunburstLevelOptions ` - :class:`TreemapLevelOptions ` - :class:`LevelSize ` - :class:`ColorVariation ` - :class:`BaseLevelOptions ` - * - :mod:`.options.plot_options.link ` - - :class:`LinkOptions ` - * - :mod:`.options.plot_options.networkgraph ` - - :class:`NetworkGraphOptions ` - :class:`LayoutAlgorithm ` - * - :mod:`.options.plot_options.organization ` - - :class:`OrganizationOptions ` - * - :mod:`.options.plot_options.packedbubble ` - - :class:`PackedBubbleOptions ` - :class:`ParentNodeOptions ` - * - :mod:`.options.plot_options.pareto ` - - :class:`ParetoOptions ` - * - :mod:`.options.plot_options.pie ` - - :class:`PieOptions ` - :class:`VariablePieOptions ` - * - :mod:`.options.plot_options.points ` - - :class:`Point ` - :class:`OnPointOptions ` - :class:`ConnectorOptions ` - * - :mod:`.options.plot_options.polygon ` - - :class:`PolygonOptions ` - * - :mod:`.options.plot_options.pyramid ` - - :class:`PyramidOptions ` - :class:`Pyramid3DOptions ` - * - :mod:`.options.plot_options.sankey ` - - :class:`SankeyOptions ` - * - :mod:`.options.plot_options.scatter ` - - :class:`ScatterOptions ` - :class:`Scatter3DOptions ` - * - :mod:`.options.plot_options.series ` - - :class:`SeriesOptions ` - * - :mod:`.options.plot_options.spline ` - - :class:`SplineOptions ` - * - :mod:`.options.plot_options.sunburst ` - - :class:`SunburstOptions ` - * - :mod:`.options.plot_options.timeline ` - - :class:`TimelineOptions ` - * - :mod:`.options.plot_options.treemap ` - - :class:`TreemapOptions ` - * - :mod:`.options.plot_options.vector ` - - :class:`VectorOptions ` - * - :mod:`.options.plot_options.venn ` - - :class:`VennOptions ` - * - :mod:`.options.plot_options.wordcloud ` - - :class:`WordcloudOptions ` - :class:`RotationOptions ` - * - :mod:`.options.responsive ` - - :class:`Responsive ` - :class:`ResponsiveRules ` - :class:`Condition ` - * - :mod:`.options.series ` + * - :mod:`.options.axes.accessibility ` + - :class:`AxisAccessibility ` + * - :mod:`.options.axes.breaks ` + - :class:`AxisBreak ` + * - :mod:`.options.axes.color_axis ` + - :class:`ColorAxis ` + * - :mod:`.options.axes.crosshair ` + - :class:`CrosshairOptions ` + * - :mod:`.options.axes.data_classes ` + - :class:`DataClass ` + * - :mod:`.options.axes.generic ` + - :class:`GenericAxis ` + * - :mod:`.options.axes.labels ` + - :class:`AxisLabelOptions ` + :class:`PlotBandLabel ` + :class:`PlotLineLabel ` + * - :mod:`.options.axes.markers ` + - :class:`AxisMarker ` + * - :mod:`.options.axes.numeric ` + - :class:`NumericAxis ` + * - :mod:`.options.axes.parallel_axes ` + - :class:`ParallelAxesOptions ` + * - :mod:`.options.axes.plot_bands ` + - :class:`PlotBand ` + :class:`PlotLine ` + * - :mod:`.options.axes.title ` + - :class:`AxisTitle ` + * - :mod:`.options.axes.x_axis ` + - :class:`XAxis ` + * - :mod:`.options.axes.y_axis ` + - :class:`YAxis ` + * - :mod:`.options.axes.z_axis ` + - :class:`ZAxis ` + * - :mod:`.options.boost ` + - :class:`Boost ` + :class:`BoostDebug ` + * - :mod:`.options.caption ` + - :class:`Caption ` + * - :mod:`.options.chart ` + - :class:`ChartOptions ` + :class:`PanningOptions ` + * - :mod:`.options.chart.options_3d ` + - :class:`Options3D ` + :class:`Frame ` + :class:`PanelOptions ` + * - :mod:`.options.chart.reset_zoom_button ` + - :class:`ResetZoomButtonOptions ` + * - :mod:`.options.chart.scrollable_plot_area ` + - :class:`ScrollablePlotArea ` + * - :mod:`.options.chart.zooming ` + - :class:`ZoomingOptions ` + * - :mod:`.options.credits ` + - :class:`Credits ` + :class:`CreditStyleOptions ` + * - :mod:`.options.data ` + - :class:`Data ` + * - :mod:`.options.defs ` + - :class:`MarkerDefinition ` + :class:`MarkerASTNode ` + :class:`MarkerAttributeObject ` + * - :mod:`.options.drilldown ` + - :class:`Drilldown ` + * - :mod:`.options.exporting ` + - :class:`Exporting ` + :class:`ExportingAccessibilityOptions ` + * - :mod:`.options.exporting.csv ` + - :class:`ExportingCSV ` + :class:`CSVAnnotationOptions ` + * - :mod:`.options.exporting.exporting.pdf_font ` + - :class:`PDFFontOptions ` + * - :mod:`.options.legend ` + - :class:`Legend ` + * - :mod:`.options.legend.accessibility ` + - :class:`LegendAccessibilityOptions ` + :class:`LegendKeyboardNavigation ` + * - :mod:`.options.legend.bubble_legend ` + - :class:`BubbleLegend ` + :class:`BubbleLegendRange ` + :class:`BubbleLegendLabelOptions ` + * - :mod:`.options.legend.navigation ` + - :class:`LegendNavigation ` + * - :mod:`.options.legend.title ` + - :class:`LegendTitle ` + * - :mod:`.options.loading ` + - :class:`Loading ` + * - :mod:`.options.navigation ` + - :class:`Navigation ` + * - :mod:`.options.navigation.bindings ` + - :class:`Bindings ` + :class:`RectangleAnnotationBinding ` + :class:`LabelAnnotationBinding ` + :class:`EllipseAnnotationBinding ` + :class:`CircleAnnotationBinding ` + :class:`Binding ` + * - :mod:`.options.no_data ` + - :class:`NoData ` + * - :mod:`.options.pane ` + - :class:`Pane ` + :class:`PaneBackground ` + * - :mod:`.options.plot_options ` + - :class:`PlotOptions ` + * - :mod:`.options.plot_options.accessibility ` + - :class:`TypeOptionsAccessibility ` + :class:`SeriesKeyboardNavigation ` + * - :mod:`.options.plot_options.arcdiagram ` + - :class:`ArcDiagramOptions ` + * - :mod:`.options.plot_options.area ` + - :class:`AreaOptions ` + :class:`AreaRangeOptions ` + :class:`AreaSplineOptions ` + :class:`AreaSplineRangeOptions ` + :class:`LineOptions ` + :class:`StreamGraphOptions ` + * - :mod:`.options.plot_options.bar ` + - :class:`BarOptions ` + :class:`ColumnOptions ` + :class:`ColumnPyramidOptions ` + :class:`ColumnRangeOptions ` + :class:`CylinderOptions ` + :class:`VariwideOptions ` + :class:`WaterfallOptions ` + :class:`WindBarbOptions ` + :class:`XRangeOptions ` + :class:`BaseBarOptions ` + * - :mod:`.options.plot_options.bellcurve ` + - :class:`BellCurveOptions ` + * - :mod:`.options.plot_options.boxplot ` + - :class:`BoxPlotOptions ` + :class:`ErrorBarOptions ` + * - :mod:`.options.plot_options.bubble ` + - :class:`BubbleOptions ` + * - :mod:`.options.plot_options.bullet ` + - :class:`BulletOptions ` + :class:`TargetOptions ` + * - :mod:`.options.plot_options.data_sorting ` + - :class:`DataSorting ` + * - :mod:`.options.plot_options.dependencywheel ` + - :class:`DependencyWheelOptions ` + * - :mod:`.options.plot_options.drag_drop ` + - :class:`DragDropOptions ` + :class:`HighLowDragDropOptions ` + :class:`BoxPlotDragDropOptions ` + :class:`BulletDragDropOptions ` + :class:`GuideBox ` + :class:`GuideBoxOptions ` + :class:`DragHandle ` + * - :mod:`.options.plot_options.dumbbell ` + - :class:`DumbbellOptions ` + :class:`LollipopOptions ` + * - :mod:`.options.plot_options.funnel ` + - :class:`FunnelOptions ` + :class:`Funnel3DOptions ` + * - :mod:`.options.plot_options.gauge ` + - :class:`GaugeOptions ` + :class:`SolidGaugeOptions ` + * - :mod:`.options.plot_options.generic ` + - :class:`GenericTypeOptions ` + * - :mod:`.options.plot_options.Heatmap ` + - :class:`HeatmapOptions ` + :class:`TilemapOptions ` + * - :mod:`.options.plot_options.histogram ` + - :class:`HistogramOptions ` + * - :mod:`.options.plot_options.item ` + - :class:`ItemOptions ` + * - :mod:`.options.plot_options.levels ` + - :class:`LevelOptions ` + :class:`SunburstLevelOptions ` + :class:`TreemapLevelOptions ` + :class:`LevelSize ` + :class:`ColorVariation ` + :class:`BaseLevelOptions ` + * - :mod:`.options.plot_options.link ` + - :class:`LinkOptions ` + * - :mod:`.options.plot_options.networkgraph ` + - :class:`NetworkGraphOptions ` + :class:`LayoutAlgorithm ` + * - :mod:`.options.plot_options.organization ` + - :class:`OrganizationOptions ` + * - :mod:`.options.plot_options.packedbubble ` + - :class:`PackedBubbleOptions ` + :class:`ParentNodeOptions ` + * - :mod:`.options.plot_options.pareto ` + - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pie ` + - :class:`PieOptions ` + :class:`VariablePieOptions ` + * - :mod:`.options.plot_options.points ` + - :class:`Point ` + :class:`OnPointOptions ` + :class:`ConnectorOptions ` + * - :mod:`.options.plot_options.polygon ` + - :class:`PolygonOptions ` + * - :mod:`.options.plot_options.pyramid ` + - :class:`PyramidOptions ` + :class:`Pyramid3DOptions ` + * - :mod:`.options.plot_options.sankey ` + - :class:`SankeyOptions ` + * - :mod:`.options.plot_options.scatter ` + - :class:`ScatterOptions ` + :class:`Scatter3DOptions ` + * - :mod:`.options.plot_options.series ` + - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.spline ` + - :class:`SplineOptions ` + * - :mod:`.options.plot_options.sunburst ` + - :class:`SunburstOptions ` + * - :mod:`.options.plot_options.timeline ` + - :class:`TimelineOptions ` + * - :mod:`.options.plot_options.treemap ` + - :class:`TreemapOptions ` + * - :mod:`.options.plot_options.vector ` + - :class:`VectorOptions ` + * - :mod:`.options.plot_options.venn ` + - :class:`VennOptions ` + * - :mod:`.options.plot_options.wordcloud ` + - :class:`WordcloudOptions ` + :class:`RotationOptions ` + * - :mod:`.options.responsive ` + - :class:`Responsive ` + :class:`ResponsiveRules ` + :class:`Condition ` + * - :mod:`.options.series ` - - * - :mod:`.options.series.arcdiagram ` - - :class:`ArcDiagramSeries ` - * - :mod:`.options.series.area ` - - :class:`AreaSeries ` - :class:`AreaRangeSeries ` - :class:`AreaSplineSeries ` - :class:`AreaSplineRangeSeries ` - :class:`LineSeries ` - :class:`StreamGraphSeries ` - * - :mod:`.options.series.bar ` - - :class:`BarSeries ` - :class:`ColumnSeries ` - :class:`ColumnPyramidSeries ` - :class:`ColumnRangeSeries ` - :class:`CylinderSeries ` - :class:`VariwideSeries ` - :class:`WaterfallSeries ` - :class:`WindBarbSeries ` - :class:`XRangeSeries ` - :class:`BaseBarSeries ` - * - :mod:`.options.series.base ` - - :class:`SeriesBase ` - * - :mod:`.options.series.bellcurve ` - - :class:`BellCurveSeries ` - * - :mod:`.options.series.boxplot ` - - :class:`BoxPlotSeries ` - :class:`ErrorBarSeries ` - * - :mod:`.options.series.bubble ` - - :class:`BubbleSeries ` - * - :mod:`.options.series.bullet ` - - :class:`BulletSeries ` - * - :mod:`.options.series.data ` + * - :mod:`.options.series.arcdiagram ` + - :class:`ArcDiagramSeries ` + * - :mod:`.options.series.area ` + - :class:`AreaSeries ` + :class:`AreaRangeSeries ` + :class:`AreaSplineSeries ` + :class:`AreaSplineRangeSeries ` + :class:`LineSeries ` + :class:`StreamGraphSeries ` + * - :mod:`.options.series.bar ` + - :class:`BarSeries ` + :class:`ColumnSeries ` + :class:`ColumnPyramidSeries ` + :class:`ColumnRangeSeries ` + :class:`CylinderSeries ` + :class:`VariwideSeries ` + :class:`WaterfallSeries ` + :class:`WindBarbSeries ` + :class:`XRangeSeries ` + :class:`BaseBarSeries ` + * - :mod:`.options.series.base ` + - :class:`SeriesBase ` + * - :mod:`.options.series.bellcurve ` + - :class:`BellCurveSeries ` + * - :mod:`.options.series.boxplot ` + - :class:`BoxPlotSeries ` + :class:`ErrorBarSeries ` + * - :mod:`.options.series.bubble ` + - :class:`BubbleSeries ` + * - :mod:`.options.series.bullet ` + - :class:`BulletSeries ` + * - :mod:`.options.series.data ` - - * - :mod:`.options.series.data.accessibility ` - - :class:`DataPointAccessibility ` - * - :mod:`.options.series.data.arcdiagram ` - - :class:`ArcDiagramData ` - * - :mod:`.options.series.data.bar ` - - :class:`BarData ` - :class:`WaterfallData ` - :class:`WindBarbData ` - :class:`XRangeData ` - * - :mod:`.options.series.data.base ` - - :class:`DataBase ` - * - :mod:`.options.series.data.boxplot ` - - :class:`BoxPlotData ` - * - :mod:`.options.series.data.bullet ` - - :class:`BulletData ` - * - :mod:`.options.series.data.cartesian ` - - :class:`CartesianData ` - :class:`Cartesian3DData ` - :class:`CartesianValueData ` - * - :mod:`.options.series.data.connections ` - - :class:`ConnectionData ` - :class:`WeightedConnectionData ` - :class:`OutgoingWeightedConnectionData ` - :class:`ConnectionBase ` - * - :mod:`.options.series.data.pie ` - - :class:`PieData ` - :class:`VariablePieData ` - * - :mod:`.options.series.data.range ` - - :class:`RangeData ` - :class:`ConnectedRangeData ` - * - :mod:`.options.series.data.single_point ` - - :class:`SinglePointData ` - :class:`SingleValueData ` - :class:`SingleXData ` - :class:`LabeledSingleXData ` - :class:`ConnectedSingleXData ` - :class:`SinglePointBase ` - * - :mod:`.options.series.data.sunburst ` - - :class:`SunburstData ` - * - :mod:`.options.series.data.treemap ` - - :class:`TreemapData ` - * - :mod:`.options.series.data.vector ` - - :class:`VectorData ` - * - :mod:`.options.series.data.venn ` - - :class:`VennData ` - * - :mod:`.options.series.data.wordcloud ` - - :class:`WordcloudData ` - * - :mod:`.options.series.dependencywheel ` - - :class:`DependencyWheelSeries ` - * - :mod:`.options.series.dumbbell ` - - :class:`DumbbellSeries ` - :class:`LollipopSeries ` - * - :mod:`.options.series.funnel ` - - :class:`FunnelSeries ` - :class:`Funnel3DSeries ` - * - :mod:`.options.series.gauge ` - - :class:`GaugeSeries ` - :class:`SolidGaugeSeries ` - * - :mod:`.options.series.heatmap ` - - :class:`HeatmapSeries ` - :class:`TilemapSeries ` - * - :mod:`.options.series.histogram ` - - :class:`HistogramSeries ` - * - :mod:`.options.series.item ` - - :class:`ItemSeries ` - * - :mod:`.options.series.labels ` - - :class:`SeriesLabel ` - :class:`Box ` - * - :mod:`.options.series.networkgraph ` - - :class:`NetworkGraphSeries ` - * - :mod:`.options.series.organization ` - - :class:`OrganizationSeries ` - * - :mod:`.options.series.packedbubble ` - - :class:`PackedBubbleSeries ` - * - :mod:`.options.series.pareto ` - - :class:`ParetoSeries ` - * - :mod:`.options.series.pie ` - - :class:`PieSeries ` - :class:`VariablePieSeries ` - * - :mod:`.options.series.polygon ` - - :class:`PolygonSeries ` - * - :mod:`.options.series.pyramid ` - - :class:`PyramidSeries ` - :class:`Pyramid3DSeries ` - * - :mod:`.options.series.sankey ` - - :class:`SankeySeries ` - * - :mod:`.options.series.scatter ` - - :class:`ScatterSeries ` - :class:`Scatter3DSeries ` - * - :mod:`.options.series.series_generator ` - - :func:`create_series_obj() ` - * - :mod:`.options.series.spline ` - - :class:`SplineSeries ` - * - :mod:`.options.series.sunburst ` - - :class:`SunburstSeries ` - * - :mod:`.options.series.timeline ` - - :class:`TimelineSeries ` - * - :mod:`.options.series.treemap ` - - :class:`TreemapSeries ` - * - :mod:`.options.series.vector ` - - :class:`VectorSeries ` - * - :mod:`.options.series.venn ` - - :class:`VennSeries ` - * - :mod:`.options.series.wordcloud ` - - :class:`WordcloudSeries ` - * - :mod:`.options.subtitle ` - - :class:`Subtitle ` - * - :mod:`.options.time ` - - :class:`Time ` - * - :mod:`.options.title ` - - :class:`Title ` - * - :mod:`.options.tooltips ` - - :class:`Tooltip ` + * - :mod:`.options.series.data.accessibility ` + - :class:`DataPointAccessibility ` + * - :mod:`.options.series.data.arcdiagram ` + - :class:`ArcDiagramData ` + * - :mod:`.options.series.data.bar ` + - :class:`BarData ` + :class:`WaterfallData ` + :class:`WindBarbData ` + :class:`XRangeData ` + * - :mod:`.options.series.data.base ` + - :class:`DataBase ` + * - :mod:`.options.series.data.boxplot ` + - :class:`BoxPlotData ` + * - :mod:`.options.series.data.bullet ` + - :class:`BulletData ` + * - :mod:`.options.series.data.cartesian ` + - :class:`CartesianData ` + :class:`Cartesian3DData ` + :class:`CartesianValueData ` + * - :mod:`.options.series.data.connections ` + - :class:`ConnectionData ` + :class:`WeightedConnectionData ` + :class:`OutgoingWeightedConnectionData ` + :class:`ConnectionBase ` + * - :mod:`.options.series.data.pie ` + - :class:`PieData ` + :class:`VariablePieData ` + * - :mod:`.options.series.data.range ` + - :class:`RangeData ` + :class:`ConnectedRangeData ` + * - :mod:`.options.series.data.single_point ` + - :class:`SinglePointData ` + :class:`SingleValueData ` + :class:`SingleXData ` + :class:`LabeledSingleXData ` + :class:`ConnectedSingleXData ` + :class:`SinglePointBase ` + * - :mod:`.options.series.data.sunburst ` + - :class:`SunburstData ` + * - :mod:`.options.series.data.treemap ` + - :class:`TreemapData ` + * - :mod:`.options.series.data.vector ` + - :class:`VectorData ` + * - :mod:`.options.series.data.venn ` + - :class:`VennData ` + * - :mod:`.options.series.data.wordcloud ` + - :class:`WordcloudData ` + * - :mod:`.options.series.dependencywheel ` + - :class:`DependencyWheelSeries ` + * - :mod:`.options.series.dumbbell ` + - :class:`DumbbellSeries ` + :class:`LollipopSeries ` + * - :mod:`.options.series.funnel ` + - :class:`FunnelSeries ` + :class:`Funnel3DSeries ` + * - :mod:`.options.series.gauge ` + - :class:`GaugeSeries ` + :class:`SolidGaugeSeries ` + * - :mod:`.options.series.heatmap ` + - :class:`HeatmapSeries ` + :class:`TilemapSeries ` + * - :mod:`.options.series.histogram ` + - :class:`HistogramSeries ` + * - :mod:`.options.series.item ` + - :class:`ItemSeries ` + * - :mod:`.options.series.labels ` + - :class:`SeriesLabel ` + :class:`Box ` + * - :mod:`.options.series.networkgraph ` + - :class:`NetworkGraphSeries ` + * - :mod:`.options.series.organization ` + - :class:`OrganizationSeries ` + * - :mod:`.options.series.packedbubble ` + - :class:`PackedBubbleSeries ` + * - :mod:`.options.series.pareto ` + - :class:`ParetoSeries ` + * - :mod:`.options.series.pie ` + - :class:`PieSeries ` + :class:`VariablePieSeries ` + * - :mod:`.options.series.polygon ` + - :class:`PolygonSeries ` + * - :mod:`.options.series.pyramid ` + - :class:`PyramidSeries ` + :class:`Pyramid3DSeries ` + * - :mod:`.options.series.sankey ` + - :class:`SankeySeries ` + * - :mod:`.options.series.scatter ` + - :class:`ScatterSeries ` + :class:`Scatter3DSeries ` + * - :mod:`.options.series.series_generator ` + - :func:`create_series_obj() ` + * - :mod:`.options.series.spline ` + - :class:`SplineSeries ` + * - :mod:`.options.series.sunburst ` + - :class:`SunburstSeries ` + * - :mod:`.options.series.timeline ` + - :class:`TimelineSeries ` + * - :mod:`.options.series.treemap ` + - :class:`TreemapSeries ` + * - :mod:`.options.series.vector ` + - :class:`VectorSeries ` + * - :mod:`.options.series.venn ` + - :class:`VennSeries ` + * - :mod:`.options.series.wordcloud ` + - :class:`WordcloudSeries ` + * - :mod:`.options.subtitle ` + - :class:`Subtitle ` + * - :mod:`.options.time ` + - :class:`Time ` + * - :mod:`.options.title ` + - :class:`Title ` + * - :mod:`.options.tooltips ` + - :class:`Tooltip ` diff --git a/docs/api/options/legend/accessibility.rst b/docs/api/options/legend/accessibility.rst index 02d6caff..187eba77 100644 --- a/docs/api/options/legend/accessibility.rst +++ b/docs/api/options/legend/accessibility.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.accessibility ` +:mod:`.accessibility ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.legend.accessibility +.. module:: highcharts_core.options.legend.accessibility ************************************************************************************************************************* -class: :class:`LegendAccessibilityOptions ` +class: :class:`LegendAccessibilityOptions ` ************************************************************************************************************************* .. autoclass:: LegendAccessibilityOptions @@ -22,7 +22,7 @@ class: :class:`LegendAccessibilityOptions ` +class: :class:`LegendKeyboardNavigation ` ************************************************************************************************************************* .. autoclass:: LegendKeyboardNavigation @@ -40,7 +40,7 @@ class: :class:`LegendKeyboardNavigation ` +:mod:`.bubble_legend ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.legend.bubble_legend +.. module:: highcharts_core.options.legend.bubble_legend ******************************************************************************************************************** -class: :class:`BubbleLegend ` +class: :class:`BubbleLegend ` ******************************************************************************************************************** .. autoclass:: BubbleLegend @@ -22,7 +22,7 @@ class: :class:`BubbleLegend ` +class: :class:`BubbleLegendRange ` ******************************************************************************************************************** .. autoclass:: BubbleLegendRange @@ -40,7 +40,7 @@ class: :class:`BubbleLegendRange ` +class: :class:`BubbleLegendLabelOptions ` ******************************************************************************************************************** .. autoclass:: BubbleLegendLabelOptions @@ -58,7 +58,7 @@ class: :class:`BubbleLegendLabelOptions ` +:mod:`.legend ` ################################################################ .. contents:: Module Contents @@ -17,10 +17,10 @@ ------------------------- -.. module:: highcharts_python.options.legend +.. module:: highcharts_core.options.legend ******************************************************************************************************************** -class: :class:`Legend ` +class: :class:`Legend ` ******************************************************************************************************************** .. autoclass:: Legend @@ -30,7 +30,7 @@ class: :class:`Legend ` .. collapse:: Class Inheritance .. inheritance-diagram:: Legend - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -47,18 +47,18 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.legend ` - - :class:`Legend ` - * - :mod:`.options.legend.accessibility ` - - :class:`LegendAccessibilityOptions ` - :class:`LegendKeyboardNavigation ` - * - :mod:`.options.legend.bubble_legend ` - - :class:`BubbleLegend ` - :class:`BubbleLegendRange ` - :class:`BubbleLegendLabelOptions ` - * - :mod:`.options.legend.navigation ` - - :class:`LegendNavigation ` - * - :mod:`.options.legend.title ` - - :class:`LegendTitle ` - * - :mod:`.options.loading ` - - :class:`Loading ` + * - :mod:`.options.legend ` + - :class:`Legend ` + * - :mod:`.options.legend.accessibility ` + - :class:`LegendAccessibilityOptions ` + :class:`LegendKeyboardNavigation ` + * - :mod:`.options.legend.bubble_legend ` + - :class:`BubbleLegend ` + :class:`BubbleLegendRange ` + :class:`BubbleLegendLabelOptions ` + * - :mod:`.options.legend.navigation ` + - :class:`LegendNavigation ` + * - :mod:`.options.legend.title ` + - :class:`LegendTitle ` + * - :mod:`.options.loading ` + - :class:`Loading ` diff --git a/docs/api/options/legend/navigation.rst b/docs/api/options/legend/navigation.rst index cfc43416..e331693e 100644 --- a/docs/api/options/legend/navigation.rst +++ b/docs/api/options/legend/navigation.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.navigation ` +:mod:`.navigation ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.legend.navigation +.. module:: highcharts_core.options.legend.navigation ******************************************************************************************************************** -class: :class:`LegendNavigation ` +class: :class:`LegendNavigation ` ******************************************************************************************************************** .. autoclass:: LegendNavigation @@ -22,7 +22,7 @@ class: :class:`LegendNavigation ` +:mod:`.title ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.legend.title +.. module:: highcharts_core.options.legend.title ******************************************************************************************************************** -class: :class:`LegendTitle ` +class: :class:`LegendTitle ` ******************************************************************************************************************** .. autoclass:: LegendTitle @@ -22,7 +22,7 @@ class: :class:`LegendTitle ` .. collapse:: Class Inheritance .. inheritance-diagram:: LegendTitle - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/loading.rst b/docs/api/options/loading.rst index f1cf0e24..da802e2c 100644 --- a/docs/api/options/loading.rst +++ b/docs/api/options/loading.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.loading ` +:mod:`.loading ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.loading +.. module:: highcharts_core.options.loading ******************************************************************************************************************** -class: :class:`Loading ` +class: :class:`Loading ` ******************************************************************************************************************** .. autoclass:: Loading @@ -22,7 +22,7 @@ class: :class:`Loading ` .. collapse:: Class Inheritance .. inheritance-diagram:: Loading - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/navigation/bindings.rst b/docs/api/options/navigation/bindings.rst index 11d873bd..97f685cb 100644 --- a/docs/api/options/navigation/bindings.rst +++ b/docs/api/options/navigation/bindings.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.bindings ` +:mod:`.bindings ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.navigation.bindings +.. module:: highcharts_core.options.navigation.bindings ******************************************************************************************************************** -class: :class:`Bindings ` +class: :class:`Bindings ` ******************************************************************************************************************** .. autoclass:: Bindings @@ -22,7 +22,7 @@ class: :class:`Bindings .. collapse:: Class Inheritance .. inheritance-diagram:: Bindings - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Bindings ----------------- *********************************************************************************************************************** -class: :class:`RectangleAnnotationBinding ` +class: :class:`RectangleAnnotationBinding ` *********************************************************************************************************************** .. autoclass:: RectangleAnnotationBinding @@ -40,7 +40,7 @@ class: :class:`RectangleAnnotationBinding ` +class: :class:`LabelAnnotationBinding ` ******************************************************************************************************************** .. autoclass:: LabelAnnotationBinding @@ -58,7 +58,7 @@ class: :class:`LabelAnnotationBinding ` +class: :class:`EllipseAnnotationBinding ` ******************************************************************************************************************** .. autoclass:: EllipseAnnotationBinding @@ -76,7 +76,7 @@ class: :class:`EllipseAnnotationBinding ` +class: :class:`CircleAnnotationBinding ` ******************************************************************************************************************** .. autoclass:: CircleAnnotationBinding @@ -94,7 +94,7 @@ class: :class:`CircleAnnotationBinding ` +class: :class:`Binding ` ******************************************************************************************************************** .. autoclass:: Binding @@ -112,7 +112,7 @@ class: :class:`Binding ` .. collapse:: Class Inheritance .. inheritance-diagram:: Binding - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/navigation/index.rst b/docs/api/options/navigation/index.rst index d44ddf05..8908b5d0 100644 --- a/docs/api/options/navigation/index.rst +++ b/docs/api/options/navigation/index.rst @@ -1,5 +1,5 @@ ################################################################ -:mod:`.navigation ` +:mod:`.navigation ` ################################################################ .. contents:: Module Contents @@ -14,10 +14,10 @@ ------------------------- -.. module:: highcharts_python.options.navigation +.. module:: highcharts_core.options.navigation ******************************************************************************************************************** -class: :class:`Navigation ` +class: :class:`Navigation ` ******************************************************************************************************************** .. autoclass:: Navigation @@ -27,7 +27,7 @@ class: :class:`Navigation ` .. collapse:: Class Inheritance .. inheritance-diagram:: Navigation - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -44,12 +44,12 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.navigation ` - - :class:`Navigation ` - * - :mod:`.options.navigation.bindings ` - - :class:`Bindings ` - :class:`RectangleAnnotationBinding ` - :class:`LabelAnnotationBinding ` - :class:`EllipseAnnotationBinding ` - :class:`CircleAnnotationBinding ` - :class:`Binding ` + * - :mod:`.options.navigation ` + - :class:`Navigation ` + * - :mod:`.options.navigation.bindings ` + - :class:`Bindings ` + :class:`RectangleAnnotationBinding ` + :class:`LabelAnnotationBinding ` + :class:`EllipseAnnotationBinding ` + :class:`CircleAnnotationBinding ` + :class:`Binding ` diff --git a/docs/api/options/no_data.rst b/docs/api/options/no_data.rst index 2e9dfbd1..1b4a8360 100644 --- a/docs/api/options/no_data.rst +++ b/docs/api/options/no_data.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.no_data ` +:mod:`.no_data ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.no_data +.. module:: highcharts_core.options.no_data ******************************************************************************************************************** -class: :class:`NoData ` +class: :class:`NoData ` ******************************************************************************************************************** .. autoclass:: NoData @@ -22,7 +22,7 @@ class: :class:`NoData ` .. collapse:: Class Inheritance .. inheritance-diagram:: NoData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/pane.rst b/docs/api/options/pane.rst index edd7ede2..73796f0f 100644 --- a/docs/api/options/pane.rst +++ b/docs/api/options/pane.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.pane ` +:mod:`.pane ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.pane +.. module:: highcharts_core.options.pane ******************************************************************************************************************** -class: :class:`Pane ` +class: :class:`Pane ` ******************************************************************************************************************** .. autoclass:: Pane @@ -22,7 +22,7 @@ class: :class:`Pane ` .. collapse:: Class Inheritance .. inheritance-diagram:: Pane - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Pane ` ------------------ ******************************************************************************************************************** -class: :class:`PaneBackground ` +class: :class:`PaneBackground ` ******************************************************************************************************************** .. autoclass:: PaneBackground @@ -40,7 +40,7 @@ class: :class:`PaneBackground ` .. collapse:: Class Inheritance .. inheritance-diagram:: PaneBackground - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/plot_options/accessibility.rst b/docs/api/options/plot_options/accessibility.rst index df18af20..dd213a54 100644 --- a/docs/api/options/plot_options/accessibility.rst +++ b/docs/api/options/plot_options/accessibility.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.accessibility ` +:mod:`.accessibility ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.accessibility +.. module:: highcharts_core.options.plot_options.accessibility *************************************************************************************************************************** -class: :class:`TypeOptionsAccessibility ` +class: :class:`TypeOptionsAccessibility ` *************************************************************************************************************************** .. autoclass:: TypeOptionsAccessibility @@ -22,7 +22,7 @@ class: :class:`TypeOptionsAccessibility ` +class: :class:`SeriesKeyboardNavigation ` *************************************************************************************************************************** .. autoclass:: SeriesKeyboardNavigation @@ -40,7 +40,7 @@ class: :class:`SeriesKeyboardNavigation ` +:mod:`.arcdiagram ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.arcdiagram +.. module:: highcharts_core.options.plot_options.arcdiagram ******************************************************************************************************************** -class: :class:`ArcDiagramOptions ` +class: :class:`ArcDiagramOptions ` ******************************************************************************************************************** .. autoclass:: ArcDiagramOptions @@ -22,7 +22,7 @@ class: :class:`ArcDiagramOptions ` +:mod:`.area ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.area +.. module:: highcharts_core.options.plot_options.area ******************************************************************************************************************** -class: :class:`AreaOptions ` +class: :class:`AreaOptions ` ******************************************************************************************************************** .. autoclass:: AreaOptions @@ -22,7 +22,7 @@ class: :class:`AreaOptions ` +class: :class:`AreaRangeOptions ` ******************************************************************************************************************** .. autoclass:: AreaRangeOptions @@ -40,7 +40,7 @@ class: :class:`AreaRangeOptions ` +class: :class:`AreaSplineOptions ` ******************************************************************************************************************** .. autoclass:: AreaSplineOptions @@ -58,7 +58,7 @@ class: :class:`AreaSplineOptions ` +class: :class:`AreaSplineRangeOptions ` ******************************************************************************************************************** .. autoclass:: AreaSplineRangeOptions @@ -76,7 +76,7 @@ class: :class:`AreaSplineRangeOptions ` +class: :class:`LineOptions ` ******************************************************************************************************************** .. autoclass:: LineOptions @@ -94,7 +94,7 @@ class: :class:`LineOptions ` +class: :class:`StreamGraphOptions ` ******************************************************************************************************************** .. autoclass:: StreamGraphOptions @@ -112,7 +112,7 @@ class: :class:`StreamGraphOptions ` +:mod:`.bar ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.bar +.. module:: highcharts_core.options.plot_options.bar ******************************************************************************************************************** -class: :class:`BarOptions ` +class: :class:`BarOptions ` ******************************************************************************************************************** .. autoclass:: BarOptions @@ -22,7 +22,7 @@ class: :class:`BarOptions ` +class: :class:`ColumnOptions ` ******************************************************************************************************************** .. autoclass:: ColumnOptions @@ -40,7 +40,7 @@ class: :class:`ColumnOptions ` +class: :class:`ColumnPyramidOptions ` ******************************************************************************************************************** .. autoclass:: ColumnPyramidOptions @@ -58,7 +58,7 @@ class: :class:`ColumnPyramidOptions ` +class: :class:`ColumnRangeOptions ` ******************************************************************************************************************** .. autoclass:: ColumnRangeOptions @@ -76,7 +76,7 @@ class: :class:`ColumnRangeOptions ` +class: :class:`CylinderOptions ` ******************************************************************************************************************** .. autoclass:: CylinderOptions @@ -94,7 +94,7 @@ class: :class:`CylinderOptions ` +class: :class:`VariwideOptions ` ******************************************************************************************************************** .. autoclass:: VariwideOptions @@ -112,7 +112,7 @@ class: :class:`VariwideOptions ` +class: :class:`WaterfallOptions ` ******************************************************************************************************************** .. autoclass:: WaterfallOptions @@ -130,7 +130,7 @@ class: :class:`WaterfallOptions ` +class: :class:`WindBarbOptions ` ******************************************************************************************************************** .. autoclass:: WindBarbOptions @@ -148,7 +148,7 @@ class: :class:`WindBarbOptions ` +class: :class:`XRangeOptions ` ******************************************************************************************************************** .. autoclass:: XRangeOptions @@ -166,7 +166,7 @@ class: :class:`XRangeOptions ` +class: :class:`BaseBarOptions ` ******************************************************************************************************************** .. autoclass:: BaseBarOptions @@ -184,7 +184,7 @@ class: :class:`BaseBarOptions ` +:mod:`.bellcurve ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.bellcurve +.. module:: highcharts_core.options.plot_options.bellcurve ******************************************************************************************************************** -class: :class:`BellCurveOptions ` +class: :class:`BellCurveOptions ` ******************************************************************************************************************** .. autoclass:: BellCurveOptions @@ -22,7 +22,7 @@ class: :class:`BellCurveOptions ` +:mod:`.boxplot ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.boxplot +.. module:: highcharts_core.options.plot_options.boxplot ******************************************************************************************************************** -class: :class:`BoxPlotOptions ` +class: :class:`BoxPlotOptions ` ******************************************************************************************************************** .. autoclass:: BoxPlotOptions @@ -22,7 +22,7 @@ class: :class:`BoxPlotOptions ` +class: :class:`ErrorBarOptions ` ******************************************************************************************************************** .. autoclass:: ErrorBarOptions @@ -40,7 +40,7 @@ class: :class:`ErrorBarOptions ` +:mod:`.bubble ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.bubble +.. module:: highcharts_core.options.plot_options.bubble ******************************************************************************************************************** -class: :class:`BubbleOptions ` +class: :class:`BubbleOptions ` ******************************************************************************************************************** .. autoclass:: BubbleOptions @@ -22,7 +22,7 @@ class: :class:`BubbleOptions ` +:mod:`.bullet ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.bullet +.. module:: highcharts_core.options.plot_options.bullet ******************************************************************************************************************** -class: :class:`BulletOptions ` +class: :class:`BulletOptions ` ******************************************************************************************************************** .. autoclass:: BulletOptions @@ -22,7 +22,7 @@ class: :class:`BulletOptions ` +class: :class:`TargetOptions ` ******************************************************************************************************************** .. autoclass:: TargetOptions @@ -40,7 +40,7 @@ class: :class:`TargetOptions ` +:mod:`.data_sorting ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.data_sorting +.. module:: highcharts_core.options.plot_options.data_sorting ******************************************************************************************************************** -class: :class:`DataSorting ` +class: :class:`DataSorting ` ******************************************************************************************************************** .. autoclass:: DataSorting @@ -22,7 +22,7 @@ class: :class:`DataSorting ` +:mod:`.dependencywheel ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.dependencywheel +.. module:: highcharts_core.options.plot_options.dependencywheel ************************************************************************************************************************ -class: :class:`DependencyWheelOptions ` +class: :class:`DependencyWheelOptions ` ************************************************************************************************************************ .. autoclass:: DependencyWheelOptions @@ -22,7 +22,7 @@ class: :class:`DependencyWheelOptions ` +:mod:`.drag_drop ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.drag_drop +.. module:: highcharts_core.options.plot_options.drag_drop ******************************************************************************************************************** -class: :class:`DragDropOptions ` +class: :class:`DragDropOptions ` ******************************************************************************************************************** .. autoclass:: DragDropOptions @@ -22,7 +22,7 @@ class: :class:`DragDropOptions ` +class: :class:`HighLowDragDropOptions ` ******************************************************************************************************************** .. autoclass:: HighLowDragDropOptions @@ -40,7 +40,7 @@ class: :class:`HighLowDragDropOptions ` +class: :class:`BoxPlotDragDropOptions ` ******************************************************************************************************************** .. autoclass:: BoxPlotDragDropOptions @@ -58,7 +58,7 @@ class: :class:`BoxPlotDragDropOptions ` +class: :class:`BulletDragDropOptions ` ******************************************************************************************************************** .. autoclass:: BulletDragDropOptions @@ -76,7 +76,7 @@ class: :class:`BulletDragDropOptions ` +class: :class:`GuideBox ` ******************************************************************************************************************** .. autoclass:: GuideBox @@ -94,7 +94,7 @@ class: :class:`GuideBox ` +class: :class:`GuideBoxOptions ` ******************************************************************************************************************** .. autoclass:: GuideBoxOptions @@ -112,7 +112,7 @@ class: :class:`GuideBoxOptions ` +class: :class:`DragHandle ` ******************************************************************************************************************** .. autoclass:: DragHandle @@ -130,7 +130,7 @@ class: :class:`DragHandle ` +:mod:`.dumbbell ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.dumbbell +.. module:: highcharts_core.options.plot_options.dumbbell ******************************************************************************************************************** -class: :class:`DumbbellOptions ` +class: :class:`DumbbellOptions ` ******************************************************************************************************************** .. autoclass:: DumbbellOptions @@ -22,7 +22,7 @@ class: :class:`DumbbellOptions ` +class: :class:`LollipopOptions ` ******************************************************************************************************************** .. autoclass:: LollipopOptions @@ -40,7 +40,7 @@ class: :class:`LollipopOptions ` +:mod:`.funnel ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.funnel +.. module:: highcharts_core.options.plot_options.funnel ******************************************************************************************************************** -class: :class:`FunnelOptions ` +class: :class:`FunnelOptions ` ******************************************************************************************************************** .. autoclass:: FunnelOptions @@ -22,7 +22,7 @@ class: :class:`FunnelOptions ` +class: :class:`Funnel3DOptions ` ******************************************************************************************************************** .. autoclass:: Funnel3DOptions @@ -40,7 +40,7 @@ class: :class:`Funnel3DOptions ` +:mod:`.gauge ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.gauge +.. module:: highcharts_core.options.plot_options.gauge ******************************************************************************************************************** -class: :class:`GaugeOptions ` +class: :class:`GaugeOptions ` ******************************************************************************************************************** .. autoclass:: GaugeOptions @@ -22,7 +22,7 @@ class: :class:`GaugeOptions ` +class: :class:`SolidGaugeOptions ` ******************************************************************************************************************** .. autoclass:: SolidGaugeOptions @@ -40,7 +40,7 @@ class: :class:`SolidGaugeOptions ` +class: :class:`PivotOptions ` ******************************************************************************************************************** .. autoclass:: PivotOptions @@ -58,7 +58,7 @@ class: :class:`PivotOptions ` +class: :class:`DialOptions ` ******************************************************************************************************************** .. autoclass:: DialOptions @@ -76,7 +76,7 @@ class: :class:`DialOptions ` +:mod:`.generic ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.generic +.. module:: highcharts_core.options.plot_options.generic ******************************************************************************************************************** -class: :class:`GenericTypeOptions ` +class: :class:`GenericTypeOptions ` ******************************************************************************************************************** .. autoclass:: GenericTypeOptions @@ -22,7 +22,7 @@ class: :class:`GenericTypeOptions ` +:mod:`.heatmap ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.heatmap +.. module:: highcharts_core.options.plot_options.heatmap ******************************************************************************************************************** -class: :class:`HeatmapOptions ` +class: :class:`HeatmapOptions ` ******************************************************************************************************************** .. autoclass:: HeatmapOptions @@ -22,7 +22,7 @@ class: :class:`HeatmapOptions ` +class: :class:`TilemapOptions ` ******************************************************************************************************************** .. autoclass:: TilemapOptions @@ -40,7 +40,7 @@ class: :class:`TilemapOptions ` +:mod:`.histogram ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.histogram +.. module:: highcharts_core.options.plot_options.histogram ******************************************************************************************************************** -class: :class:`HistogramOptions ` +class: :class:`HistogramOptions ` ******************************************************************************************************************** .. autoclass:: HistogramOptions @@ -22,7 +22,7 @@ class: :class:`HistogramOptions ` +:mod:`.plot_options ` ################################################################ .. contents:: Module Contents @@ -51,10 +51,10 @@ ------------------------- -.. module:: highcharts_python.options.plot_options +.. module:: highcharts_core.options.plot_options ******************************************************************************************************************** -class: :class:`PlotOptions ` +class: :class:`PlotOptions ` ******************************************************************************************************************** .. autoclass:: PlotOptions @@ -64,7 +64,7 @@ class: :class:`PlotOptions ` .. collapse:: Class Inheritance .. inheritance-diagram:: PlotOptions - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -81,121 +81,121 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.plot_options ` - - :class:`PlotOptions ` - * - :mod:`.options.plot_options.accessibility ` - - :class:`TypeOptionsAccessibility ` - :class:`SeriesKeyboardNavigation ` - * - :mod:`.options.plot_options.arcdiagram ` - - :class:`ArcDiagramOptions ` - * - :mod:`.options.plot_options.area ` - - :class:`AreaOptions ` - :class:`AreaRangeOptions ` - :class:`AreaSplineOptions ` - :class:`AreaSplineRangeOptions ` - :class:`LineOptions ` - :class:`StreamGraphOptions ` - * - :mod:`.options.plot_options.bar ` - - :class:`BarOptions ` - :class:`ColumnOptions ` - :class:`ColumnPyramidOptions ` - :class:`ColumnRangeOptions ` - :class:`CylinderOptions ` - :class:`VariwideOptions ` - :class:`WaterfallOptions ` - :class:`WindBarbOptions ` - :class:`XRangeOptions ` - :class:`BaseBarOptions ` - * - :mod:`.options.plot_options.bellcurve ` - - :class:`BellCurveOptions ` - * - :mod:`.options.plot_options.boxplot ` - - :class:`BoxPlotOptions ` - :class:`ErrorBarOptions ` - * - :mod:`.options.plot_options.bubble ` - - :class:`BubbleOptions ` - * - :mod:`.options.plot_options.bullet ` - - :class:`BulletOptions ` - :class:`TargetOptions ` - * - :mod:`.options.plot_options.data_sorting ` - - :class:`DataSorting ` - * - :mod:`.options.plot_options.dependencywheel ` - - :class:`DependencyWheelOptions ` - * - :mod:`.options.plot_options.drag_drop ` - - :class:`DragDropOptions ` - :class:`HighLowDragDropOptions ` - :class:`BoxPlotDragDropOptions ` - :class:`BulletDragDropOptions ` - :class:`GuideBox ` - :class:`GuideBoxOptions ` - :class:`DragHandle ` - * - :mod:`.options.plot_options.dumbbell ` - - :class:`DumbbellOptions ` - :class:`LollipopOptions ` - * - :mod:`.options.plot_options.funnel ` - - :class:`FunnelOptions ` - :class:`Funnel3DOptions ` - * - :mod:`.options.plot_options.gauge ` - - :class:`GaugeOptions ` - :class:`SolidGaugeOptions ` - * - :mod:`.options.plot_options.generic ` - - :class:`GenericTypeOptions ` - * - :mod:`.options.plot_options.Heatmap ` - - :class:`HeatmapOptions ` - :class:`TilemapOptions ` - * - :mod:`.options.plot_options.histogram ` - - :class:`HistogramOptions ` - * - :mod:`.options.plot_options.item ` - - :class:`ItemOptions ` - * - :mod:`.options.plot_options.levels ` - - :class:`LevelOptions ` - :class:`SunburstLevelOptions ` - :class:`TreemapLevelOptions ` - :class:`LevelSize ` - :class:`ColorVariation ` - :class:`BaseLevelOptions ` - * - :mod:`.options.plot_options.link ` - - :class:`LinkOptions ` - * - :mod:`.options.plot_options.networkgraph ` - - :class:`NetworkGraphOptions ` - :class:`LayoutAlgorithm ` - * - :mod:`.options.plot_options.organization ` - - :class:`OrganizationOptions ` - * - :mod:`.options.plot_options.packedbubble ` - - :class:`PackedBubbleOptions ` - :class:`ParentNodeOptions ` - * - :mod:`.options.plot_options.pareto ` - - :class:`ParetoOptions ` - * - :mod:`.options.plot_options.pie ` - - :class:`PieOptions ` - :class:`VariablePieOptions ` - * - :mod:`.options.plot_options.points ` - - :class:`Point ` - :class:`OnPointOptions ` - :class:`ConnectorOptions ` - * - :mod:`.options.plot_options.polygon ` - - :class:`PolygonOptions ` - * - :mod:`.options.plot_options.pyramid ` - - :class:`PyramidOptions ` - :class:`Pyramid3DOptions ` - * - :mod:`.options.plot_options.sankey ` - - :class:`SankeyOptions ` - * - :mod:`.options.plot_options.scatter ` - - :class:`ScatterOptions ` - :class:`Scatter3DOptions ` - * - :mod:`.options.plot_options.series ` - - :class:`SeriesOptions ` - * - :mod:`.options.plot_options.spline ` - - :class:`SplineOptions ` - * - :mod:`.options.plot_options.sunburst ` - - :class:`SunburstOptions ` - * - :mod:`.options.plot_options.timeline ` - - :class:`TimelineOptions ` - * - :mod:`.options.plot_options.treemap ` - - :class:`TreemapOptions ` - * - :mod:`.options.plot_options.vector ` - - :class:`VectorOptions ` - * - :mod:`.options.plot_options.venn ` - - :class:`VennOptions ` - * - :mod:`.options.plot_options.wordcloud ` - - :class:`WordcloudOptions ` - :class:`RotationOptions ` + * - :mod:`.options.plot_options ` + - :class:`PlotOptions ` + * - :mod:`.options.plot_options.accessibility ` + - :class:`TypeOptionsAccessibility ` + :class:`SeriesKeyboardNavigation ` + * - :mod:`.options.plot_options.arcdiagram ` + - :class:`ArcDiagramOptions ` + * - :mod:`.options.plot_options.area ` + - :class:`AreaOptions ` + :class:`AreaRangeOptions ` + :class:`AreaSplineOptions ` + :class:`AreaSplineRangeOptions ` + :class:`LineOptions ` + :class:`StreamGraphOptions ` + * - :mod:`.options.plot_options.bar ` + - :class:`BarOptions ` + :class:`ColumnOptions ` + :class:`ColumnPyramidOptions ` + :class:`ColumnRangeOptions ` + :class:`CylinderOptions ` + :class:`VariwideOptions ` + :class:`WaterfallOptions ` + :class:`WindBarbOptions ` + :class:`XRangeOptions ` + :class:`BaseBarOptions ` + * - :mod:`.options.plot_options.bellcurve ` + - :class:`BellCurveOptions ` + * - :mod:`.options.plot_options.boxplot ` + - :class:`BoxPlotOptions ` + :class:`ErrorBarOptions ` + * - :mod:`.options.plot_options.bubble ` + - :class:`BubbleOptions ` + * - :mod:`.options.plot_options.bullet ` + - :class:`BulletOptions ` + :class:`TargetOptions ` + * - :mod:`.options.plot_options.data_sorting ` + - :class:`DataSorting ` + * - :mod:`.options.plot_options.dependencywheel ` + - :class:`DependencyWheelOptions ` + * - :mod:`.options.plot_options.drag_drop ` + - :class:`DragDropOptions ` + :class:`HighLowDragDropOptions ` + :class:`BoxPlotDragDropOptions ` + :class:`BulletDragDropOptions ` + :class:`GuideBox ` + :class:`GuideBoxOptions ` + :class:`DragHandle ` + * - :mod:`.options.plot_options.dumbbell ` + - :class:`DumbbellOptions ` + :class:`LollipopOptions ` + * - :mod:`.options.plot_options.funnel ` + - :class:`FunnelOptions ` + :class:`Funnel3DOptions ` + * - :mod:`.options.plot_options.gauge ` + - :class:`GaugeOptions ` + :class:`SolidGaugeOptions ` + * - :mod:`.options.plot_options.generic ` + - :class:`GenericTypeOptions ` + * - :mod:`.options.plot_options.Heatmap ` + - :class:`HeatmapOptions ` + :class:`TilemapOptions ` + * - :mod:`.options.plot_options.histogram ` + - :class:`HistogramOptions ` + * - :mod:`.options.plot_options.item ` + - :class:`ItemOptions ` + * - :mod:`.options.plot_options.levels ` + - :class:`LevelOptions ` + :class:`SunburstLevelOptions ` + :class:`TreemapLevelOptions ` + :class:`LevelSize ` + :class:`ColorVariation ` + :class:`BaseLevelOptions ` + * - :mod:`.options.plot_options.link ` + - :class:`LinkOptions ` + * - :mod:`.options.plot_options.networkgraph ` + - :class:`NetworkGraphOptions ` + :class:`LayoutAlgorithm ` + * - :mod:`.options.plot_options.organization ` + - :class:`OrganizationOptions ` + * - :mod:`.options.plot_options.packedbubble ` + - :class:`PackedBubbleOptions ` + :class:`ParentNodeOptions ` + * - :mod:`.options.plot_options.pareto ` + - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pie ` + - :class:`PieOptions ` + :class:`VariablePieOptions ` + * - :mod:`.options.plot_options.points ` + - :class:`Point ` + :class:`OnPointOptions ` + :class:`ConnectorOptions ` + * - :mod:`.options.plot_options.polygon ` + - :class:`PolygonOptions ` + * - :mod:`.options.plot_options.pyramid ` + - :class:`PyramidOptions ` + :class:`Pyramid3DOptions ` + * - :mod:`.options.plot_options.sankey ` + - :class:`SankeyOptions ` + * - :mod:`.options.plot_options.scatter ` + - :class:`ScatterOptions ` + :class:`Scatter3DOptions ` + * - :mod:`.options.plot_options.series ` + - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.spline ` + - :class:`SplineOptions ` + * - :mod:`.options.plot_options.sunburst ` + - :class:`SunburstOptions ` + * - :mod:`.options.plot_options.timeline ` + - :class:`TimelineOptions ` + * - :mod:`.options.plot_options.treemap ` + - :class:`TreemapOptions ` + * - :mod:`.options.plot_options.vector ` + - :class:`VectorOptions ` + * - :mod:`.options.plot_options.venn ` + - :class:`VennOptions ` + * - :mod:`.options.plot_options.wordcloud ` + - :class:`WordcloudOptions ` + :class:`RotationOptions ` diff --git a/docs/api/options/plot_options/item.rst b/docs/api/options/plot_options/item.rst index f9d893ae..f7f95daf 100644 --- a/docs/api/options/plot_options/item.rst +++ b/docs/api/options/plot_options/item.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.item ` +:mod:`.item ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.item +.. module:: highcharts_core.options.plot_options.item ******************************************************************************************************************** -class: :class:`ItemOptions ` +class: :class:`ItemOptions ` ******************************************************************************************************************** .. autoclass:: ItemOptions @@ -22,7 +22,7 @@ class: :class:`ItemOptions ` +:mod:`.levels ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.levels +.. module:: highcharts_core.options.plot_options.levels ******************************************************************************************************************** -class: :class:`LevelOptions ` +class: :class:`LevelOptions ` ******************************************************************************************************************** .. autoclass:: LevelOptions @@ -22,7 +22,7 @@ class: :class:`LevelOptions ` +class: :class:`SunburstLevelOptions ` ******************************************************************************************************************** .. autoclass:: SunburstLevelOptions @@ -40,7 +40,7 @@ class: :class:`SunburstLevelOptions ` +class: :class:`TreemapLevelOptions ` ******************************************************************************************************************** .. autoclass:: TreemapLevelOptions @@ -58,7 +58,7 @@ class: :class:`TreemapLevelOptions ` +class: :class:`LevelSize ` ******************************************************************************************************************** .. autoclass:: LevelSize @@ -76,7 +76,7 @@ class: :class:`LevelSize ` +class: :class:`ColorVariation ` ******************************************************************************************************************** .. autoclass:: ColorVariation @@ -94,7 +94,7 @@ class: :class:`ColorVariation ` +class: :class:`BaseLevelOptions ` ******************************************************************************************************************** .. autoclass:: BaseLevelOptions @@ -112,7 +112,7 @@ class: :class:`BaseLevelOptions ` +:mod:`.link ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.link +.. module:: highcharts_core.options.plot_options.link ******************************************************************************************************************** -class: :class:`LinkOptions ` +class: :class:`LinkOptions ` ******************************************************************************************************************** .. autoclass:: LinkOptions @@ -22,7 +22,7 @@ class: :class:`LinkOptions ` +:mod:`.networkgraph ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.networkgraph +.. module:: highcharts_core.options.plot_options.networkgraph ******************************************************************************************************************** -class: :class:`NetworkGraphOptions ` +class: :class:`NetworkGraphOptions ` ******************************************************************************************************************** .. autoclass:: NetworkGraphOptions @@ -22,7 +22,7 @@ class: :class:`NetworkGraphOptions ` +class: :class:`LayoutAlgorithm ` ******************************************************************************************************************** .. autoclass:: LayoutAlgorithm @@ -40,7 +40,7 @@ class: :class:`LayoutAlgorithm ` +:mod:`.organization ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.organization +.. module:: highcharts_core.options.plot_options.organization ******************************************************************************************************************** -class: :class:`OrganizationOptions ` +class: :class:`OrganizationOptions ` ******************************************************************************************************************** .. autoclass:: OrganizationOptions @@ -22,7 +22,7 @@ class: :class:`OrganizationOptions ` +:mod:`.packedbubble ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.packedbubble +.. module:: highcharts_core.options.plot_options.packedbubble ******************************************************************************************************************** -class: :class:`PackedBubbleOptions ` +class: :class:`PackedBubbleOptions ` ******************************************************************************************************************** .. autoclass:: PackedBubbleOptions @@ -22,7 +22,7 @@ class: :class:`PackedBubbleOptions ` +class: :class:`ParentNodeOptions ` ******************************************************************************************************************** .. autoclass:: ParentNodeOptions @@ -40,7 +40,7 @@ class: :class:`ParentNodeOptions ` +:mod:`.pareto ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.pareto +.. module:: highcharts_core.options.plot_options.pareto ******************************************************************************************************************** -class: :class:`ParetoOptions ` +class: :class:`ParetoOptions ` ******************************************************************************************************************** .. autoclass:: ParetoOptions @@ -22,7 +22,7 @@ class: :class:`ParetoOptions ` +:mod:`.pie ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.pie +.. module:: highcharts_core.options.plot_options.pie ******************************************************************************************************************** -class: :class:`PieOptions ` +class: :class:`PieOptions ` ******************************************************************************************************************** .. autoclass:: PieOptions @@ -22,7 +22,7 @@ class: :class:`PieOptions ` +class: :class:`VariablePieOptions ` ******************************************************************************************************************** .. autoclass:: VariablePieOptions @@ -41,7 +41,7 @@ class: :class:`VariablePieOptions ` +:mod:`.points ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.points +.. module:: highcharts_core.options.plot_options.points ******************************************************************************************************************** -class: :class:`Point ` +class: :class:`Point ` ******************************************************************************************************************** .. autoclass:: Point @@ -22,7 +22,7 @@ class: :class:`Point ` .. collapse:: Class Inheritance .. inheritance-diagram:: Point - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Point ` ------------- ******************************************************************************************************************** -class: :class:`OnPointOptions ` +class: :class:`OnPointOptions ` ******************************************************************************************************************** .. autoclass:: OnPointOptions @@ -40,7 +40,7 @@ class: :class:`OnPointOptions ` +class: :class:`ConnectorOptions ` ******************************************************************************************************************** .. autoclass:: ConnectorOptions @@ -58,7 +58,7 @@ class: :class:`ConnectorOptions ` +:mod:`.polygon ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.polygon +.. module:: highcharts_core.options.plot_options.polygon ******************************************************************************************************************** -class: :class:`PolygonOptions ` +class: :class:`PolygonOptions ` ******************************************************************************************************************** .. autoclass:: PolygonOptions @@ -22,7 +22,7 @@ class: :class:`PolygonOptions ` +:mod:`.pyramid ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.pyramid +.. module:: highcharts_core.options.plot_options.pyramid ******************************************************************************************************************** -class: :class:`PyramidOptions ` +class: :class:`PyramidOptions ` ******************************************************************************************************************** .. autoclass:: PyramidOptions @@ -22,7 +22,7 @@ class: :class:`PyramidOptions ` +class: :class:`Pyramid3DOptions ` ******************************************************************************************************************** .. autoclass:: Pyramid3DOptions @@ -40,7 +40,7 @@ class: :class:`Pyramid3DOptions ` +:mod:`.sankey ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.sankey +.. module:: highcharts_core.options.plot_options.sankey ******************************************************************************************************************** -class: :class:`SankeyOptions ` +class: :class:`SankeyOptions ` ******************************************************************************************************************** .. autoclass:: SankeyOptions @@ -22,7 +22,7 @@ class: :class:`SankeyOptions ` +:mod:`.scatter ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.scatter +.. module:: highcharts_core.options.plot_options.scatter ******************************************************************************************************************** -class: :class:`ScatterOptions ` +class: :class:`ScatterOptions ` ******************************************************************************************************************** .. autoclass:: ScatterOptions @@ -22,7 +22,7 @@ class: :class:`ScatterOptions ` +class: :class:`Scatter3DOptions ` ******************************************************************************************************************** .. autoclass:: Scatter3DOptions @@ -40,7 +40,7 @@ class: :class:`Scatter3DOptions ` +:mod:`.series ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.series +.. module:: highcharts_core.options.plot_options.series ******************************************************************************************************************** -class: :class:`SeriesOptions ` +class: :class:`SeriesOptions ` ******************************************************************************************************************** .. autoclass:: SeriesOptions @@ -22,7 +22,7 @@ class: :class:`SeriesOptions ` +:mod:`.spline ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.spline +.. module:: highcharts_core.options.plot_options.spline ******************************************************************************************************************** -class: :class:`SplineOptions ` +class: :class:`SplineOptions ` ******************************************************************************************************************** .. autoclass:: SplineOptions @@ -22,7 +22,7 @@ class: :class:`SplineOptions ` +:mod:`.sunburst ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.sunburst +.. module:: highcharts_core.options.plot_options.sunburst ******************************************************************************************************************** -class: :class:`SunburstOptions ` +class: :class:`SunburstOptions ` ******************************************************************************************************************** .. autoclass:: SunburstOptions @@ -22,7 +22,7 @@ class: :class:`SunburstOptions ` +:mod:`.timeline ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.timeline +.. module:: highcharts_core.options.plot_options.timeline ******************************************************************************************************************** -class: :class:`TimelineOptions ` +class: :class:`TimelineOptions ` ******************************************************************************************************************** .. autoclass:: TimelineOptions @@ -22,7 +22,7 @@ class: :class:`TimelineOptions ` +:mod:`.treemap ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.treemap +.. module:: highcharts_core.options.plot_options.treemap ******************************************************************************************************************** -class: :class:`TreemapOptions ` +class: :class:`TreemapOptions ` ******************************************************************************************************************** .. autoclass:: TreemapOptions @@ -22,7 +22,7 @@ class: :class:`TreemapOptions ` +:mod:`.vector ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.vector +.. module:: highcharts_core.options.plot_options.vector ******************************************************************************************************************** -class: :class:`VectorOptions ` +class: :class:`VectorOptions ` ******************************************************************************************************************** .. autoclass:: VectorOptions @@ -22,7 +22,7 @@ class: :class:`VectorOptions ` +:mod:`.venn ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.venn +.. module:: highcharts_core.options.plot_options.venn ******************************************************************************************************************** -class: :class:`VennOptions ` +class: :class:`VennOptions ` ******************************************************************************************************************** .. autoclass:: VennOptions @@ -22,7 +22,7 @@ class: :class:`VennOptions ` +:mod:`.wordcloud ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.plot_options.wordcloud +.. module:: highcharts_core.options.plot_options.wordcloud ******************************************************************************************************************** -class: :class:`WordcloudOptions ` +class: :class:`WordcloudOptions ` ******************************************************************************************************************** .. autoclass:: WordcloudOptions @@ -22,7 +22,7 @@ class: :class:`WordcloudOptions ` +class: :class:`RotationOptions ` ******************************************************************************************************************** .. autoclass:: RotationOptions @@ -40,7 +40,7 @@ class: :class:`RotationOptions ` +:mod:`.responsive ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.responsive +.. module:: highcharts_core.options.responsive ******************************************************************************************************************** -class: :class:`Responsive ` +class: :class:`Responsive ` ******************************************************************************************************************** .. autoclass:: Responsive @@ -22,7 +22,7 @@ class: :class:`Responsive ` .. collapse:: Class Inheritance .. inheritance-diagram:: Responsive - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Responsive ` ----------------- ******************************************************************************************************************** -class: :class:`ResponsiveRules ` +class: :class:`ResponsiveRules ` ******************************************************************************************************************** .. autoclass:: ResponsiveRules @@ -40,7 +40,7 @@ class: :class:`ResponsiveRules ` +class: :class:`Condition ` ******************************************************************************************************************** .. autoclass:: Condition @@ -58,7 +58,7 @@ class: :class:`Condition ` .. collapse:: Class Inheritance .. inheritance-diagram:: Condition - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/arcdiagram.rst b/docs/api/options/series/arcdiagram.rst index 6b6f2540..ba18647f 100644 --- a/docs/api/options/series/arcdiagram.rst +++ b/docs/api/options/series/arcdiagram.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.arcdiagram ` +:mod:`.arcdiagram ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.arcdiagram +.. module:: highcharts_core.options.series.arcdiagram ******************************************************************************************************************** -class: :class:`ArcDiagramSeries ` +class: :class:`ArcDiagramSeries ` ******************************************************************************************************************** .. autoclass:: ArcDiagramSeries @@ -22,7 +22,7 @@ class: :class:`ArcDiagramSeries ` +:mod:`.area ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.area +.. module:: highcharts_core.options.series.area ******************************************************************************************************************** -class: :class:`AreaSeries ` +class: :class:`AreaSeries ` ******************************************************************************************************************** .. autoclass:: AreaSeries @@ -22,7 +22,7 @@ class: :class:`AreaSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: AreaSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`AreaSeries ` ----------------- ******************************************************************************************************************** -class: :class:`AreaRangeSeries ` +class: :class:`AreaRangeSeries ` ******************************************************************************************************************** .. autoclass:: AreaRangeSeries @@ -40,7 +40,7 @@ class: :class:`AreaRangeSeries ` +class: :class:`AreaSplineSeries ` ******************************************************************************************************************** .. autoclass:: AreaSplineSeries @@ -58,7 +58,7 @@ class: :class:`AreaSplineSeries ` +class: :class:`AreaSplineRangeSeries ` ******************************************************************************************************************** .. autoclass:: AreaSplineRangeSeries @@ -76,7 +76,7 @@ class: :class:`AreaSplineRangeSeries ` +class: :class:`LineSeries ` ******************************************************************************************************************** .. autoclass:: LineSeries @@ -94,7 +94,7 @@ class: :class:`LineSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: LineSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -102,7 +102,7 @@ class: :class:`LineSeries ` ------------- ******************************************************************************************************************** -class: :class:`StreamGraphSeries ` +class: :class:`StreamGraphSeries ` ******************************************************************************************************************** .. autoclass:: StreamGraphSeries @@ -112,7 +112,7 @@ class: :class:`StreamGraphSeries ` +:mod:`.bar ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.bar +.. module:: highcharts_core.options.series.bar ******************************************************************************************************************** -class: :class:`BarSeries ` +class: :class:`BarSeries ` ******************************************************************************************************************** .. autoclass:: BarSeries @@ -22,7 +22,7 @@ class: :class:`BarSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: BarSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`BarSeries ` ----------------- ******************************************************************************************************************** -class: :class:`ColumnSeries ` +class: :class:`ColumnSeries ` ******************************************************************************************************************** .. autoclass:: ColumnSeries @@ -40,7 +40,7 @@ class: :class:`ColumnSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: ColumnSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -48,7 +48,7 @@ class: :class:`ColumnSeries ` ------------------- ******************************************************************************************************************** -class: :class:`ColumnPyramidSeries ` +class: :class:`ColumnPyramidSeries ` ******************************************************************************************************************** .. autoclass:: ColumnPyramidSeries @@ -58,7 +58,7 @@ class: :class:`ColumnPyramidSeries ` +class: :class:`ColumnRangeSeries ` ******************************************************************************************************************** .. autoclass:: ColumnRangeSeries @@ -76,7 +76,7 @@ class: :class:`ColumnRangeSeries ` +class: :class:`CylinderSeries ` ******************************************************************************************************************** .. autoclass:: CylinderSeries @@ -94,7 +94,7 @@ class: :class:`CylinderSeries ` +class: :class:`VariwideSeries ` ******************************************************************************************************************** .. autoclass:: VariwideSeries @@ -112,7 +112,7 @@ class: :class:`VariwideSeries ` +class: :class:`WaterfallSeries ` ******************************************************************************************************************** .. autoclass:: WaterfallSeries @@ -130,7 +130,7 @@ class: :class:`WaterfallSeries ` +class: :class:`WindBarbSeries ` ******************************************************************************************************************** .. autoclass:: WindBarbSeries @@ -148,7 +148,7 @@ class: :class:`WindBarbSeries ` +class: :class:`XRangeSeries ` ******************************************************************************************************************** .. autoclass:: XRangeSeries @@ -166,7 +166,7 @@ class: :class:`XRangeSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: XRangeSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -174,7 +174,7 @@ class: :class:`XRangeSeries ` -------------------- ******************************************************************************************************************** -class: :class:`BaseBarSeries ` +class: :class:`BaseBarSeries ` ******************************************************************************************************************** .. autoclass:: BaseBarSeries @@ -184,7 +184,7 @@ class: :class:`BaseBarSeries ` +:mod:`.base ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.base +.. module:: highcharts_core.options.series.base ******************************************************************************************************************** -class: :class:`SeriesBase ` +class: :class:`SeriesBase ` ******************************************************************************************************************** .. autoclass:: SeriesBase @@ -22,7 +22,7 @@ class: :class:`SeriesBase ` .. collapse:: Class Inheritance .. inheritance-diagram:: SeriesBase - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/bellcurve.rst b/docs/api/options/series/bellcurve.rst index 5e511cc3..60f04262 100644 --- a/docs/api/options/series/bellcurve.rst +++ b/docs/api/options/series/bellcurve.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.bellcurve ` +:mod:`.bellcurve ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.bellcurve +.. module:: highcharts_core.options.series.bellcurve ******************************************************************************************************************** -class: :class:`BellCurveSeries ` +class: :class:`BellCurveSeries ` ******************************************************************************************************************** .. autoclass:: BellCurveSeries @@ -22,7 +22,7 @@ class: :class:`BellCurveSeries ` +:mod:`.boxplot ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.boxplot +.. module:: highcharts_core.options.series.boxplot ******************************************************************************************************************** -class: :class:`BoxPlotSeries ` +class: :class:`BoxPlotSeries ` ******************************************************************************************************************** .. autoclass:: BoxPlotSeries @@ -22,7 +22,7 @@ class: :class:`BoxPlotSeries ` +class: :class:`ErrorBarSeries ` ******************************************************************************************************************** .. autoclass:: ErrorBarSeries @@ -40,7 +40,7 @@ class: :class:`ErrorBarSeries ` +:mod:`.bubble ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.bubble +.. module:: highcharts_core.options.series.bubble ******************************************************************************************************************** -class: :class:`BubbleSeries ` +class: :class:`BubbleSeries ` ******************************************************************************************************************** .. autoclass:: BubbleSeries @@ -22,7 +22,7 @@ class: :class:`BubbleSeries ` +:mod:`.bullet ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.bullet +.. module:: highcharts_core.options.series.bullet ******************************************************************************************************************** -class: :class:`BulletSeries ` +class: :class:`BulletSeries ` ******************************************************************************************************************** .. autoclass:: BulletSeries @@ -22,7 +22,7 @@ class: :class:`BulletSeries ` +:mod:`.accessibility ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.accessibility +.. module:: highcharts_core.options.series.data.accessibility ******************************************************************************************************************** -class: :class:`DataPointAccessibility ` +class: :class:`DataPointAccessibility ` ******************************************************************************************************************** .. autoclass:: DataPointAccessibility @@ -22,7 +22,7 @@ class: :class:`DataPointAccessibility ` +:mod:`.arcdiagram ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.arcdiagram +.. module:: highcharts_core.options.series.data.arcdiagram ******************************************************************************************************************** -class: :class:`ArcDiagramData ` +class: :class:`ArcDiagramData ` ******************************************************************************************************************** .. autoclass:: ArcDiagramData @@ -22,7 +22,7 @@ class: :class:`ArcDiagramData ` +:mod:`.bar ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.bar +.. module:: highcharts_core.options.series.data.bar ******************************************************************************************************************** -class: :class:`BarData ` +class: :class:`BarData ` ******************************************************************************************************************** .. autoclass:: BarData @@ -22,7 +22,7 @@ class: :class:`BarData ` .. collapse:: Class Inheritance .. inheritance-diagram:: BarData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`BarData ` ----------------- ******************************************************************************************************************** -class: :class:`WaterfallData ` +class: :class:`WaterfallData ` ******************************************************************************************************************** .. autoclass:: WaterfallData @@ -40,7 +40,7 @@ class: :class:`WaterfallData ` +class: :class:`WindBarbData ` ******************************************************************************************************************** .. autoclass:: WindBarbData @@ -58,7 +58,7 @@ class: :class:`WindBarbData ` +class: :class:`XRangeData ` ******************************************************************************************************************** .. autoclass:: XRangeData @@ -76,7 +76,7 @@ class: :class:`XRangeData .. collapse:: Class Inheritance .. inheritance-diagram:: XRangeData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/data/base.rst b/docs/api/options/series/data/base.rst index 88820d51..405d811f 100644 --- a/docs/api/options/series/data/base.rst +++ b/docs/api/options/series/data/base.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.base ` +:mod:`.base ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.base +.. module:: highcharts_core.options.series.data.base ******************************************************************************************************************** -class: :class:`DataBase ` +class: :class:`DataBase ` ******************************************************************************************************************** .. autoclass:: DataBase @@ -22,7 +22,7 @@ class: :class:`DataBase ` .. collapse:: Class Inheritance .. inheritance-diagram:: DataBase - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/data/boxplot.rst b/docs/api/options/series/data/boxplot.rst index e5ed7788..cf9c3fdd 100644 --- a/docs/api/options/series/data/boxplot.rst +++ b/docs/api/options/series/data/boxplot.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.boxplot ` +:mod:`.boxplot ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.boxplot +.. module:: highcharts_core.options.series.data.boxplot ******************************************************************************************************************** -class: :class:`BoxPlotData ` +class: :class:`BoxPlotData ` ******************************************************************************************************************** .. autoclass:: BoxPlotData @@ -22,7 +22,7 @@ class: :class:`BoxPlotData ` +:mod:`.bullet ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.bullet +.. module:: highcharts_core.options.series.data.bullet ******************************************************************************************************************** -class: :class:`BulletData ` +class: :class:`BulletData ` ******************************************************************************************************************** .. autoclass:: BulletData @@ -22,7 +22,7 @@ class: :class:`BulletData ` +:mod:`.cartesian ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.cartesian +.. module:: highcharts_core.options.series.data.cartesian ******************************************************************************************************************** -class: :class:`CartesianData ` +class: :class:`CartesianData ` ******************************************************************************************************************** .. autoclass:: CartesianData @@ -22,7 +22,7 @@ class: :class:`CartesianData ` +class: :class:`Cartesian3DData ` ******************************************************************************************************************** .. autoclass:: Cartesian3DData @@ -40,7 +40,7 @@ class: :class:`Cartesian3DData ` +class: :class:`CartesianValueData ` ******************************************************************************************************************** .. autoclass:: CartesianValueData @@ -58,7 +58,7 @@ class: :class:`CartesianValueData ` +:mod:`.connections ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.connections +.. module:: highcharts_core.options.series.data.connections ******************************************************************************************************************** -class: :class:`ConnectionData ` +class: :class:`ConnectionData ` ******************************************************************************************************************** .. autoclass:: ConnectionData @@ -22,7 +22,7 @@ class: :class:`ConnectionData ` +class: :class:`WeightedConnectionData ` ******************************************************************************************************************** .. autoclass:: WeightedConnectionData @@ -40,7 +40,7 @@ class: :class:`WeightedConnectionData ` +class: :class:`OutgoingWeightedConnectionData ` ************************************************************************************************************************************* .. autoclass:: OutgoingWeightedConnectionData @@ -58,7 +58,7 @@ class: :class:`OutgoingWeightedConnectionData ` +class: :class:`ConnectionBase ` ******************************************************************************************************************** .. autoclass:: ConnectionBase @@ -76,7 +76,7 @@ class: :class:`ConnectionBase ` +:mod:`.data ` ################################################################ .. contents:: Module Contents @@ -39,52 +39,52 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.series.data ` + * - :mod:`.options.series.data ` - - * - :mod:`.options.series.data.accessibility ` - - :class:`DataPointAccessibility ` - * - :mod:`.options.series.data.arcdiagram ` - - :class:`ArcDiagramData ` - * - :mod:`.options.series.data.bar ` - - :class:`BarData ` - :class:`WaterfallData ` - :class:`WindBarbData ` - :class:`XRangeData ` - * - :mod:`.options.series.data.base ` - - :class:`DataBase ` - * - :mod:`.options.series.data.boxplot ` - - :class:`BoxPlotData ` - * - :mod:`.options.series.data.bullet ` - - :class:`BulletData ` - * - :mod:`.options.series.data.cartesian ` - - :class:`CartesianData ` - :class:`Cartesian3DData ` - :class:`CartesianValueData ` - * - :mod:`.options.series.data.connections ` - - :class:`ConnectionData ` - :class:`WeightedConnectionData ` - :class:`OutgoingWeightedConnectionData ` - :class:`ConnectionBase ` - * - :mod:`.options.series.data.pie ` - - :class:`PieData ` - :class:`VariablePieData ` - * - :mod:`.options.series.data.range ` - - :class:`RangeData ` - :class:`ConnectedRangeData ` - * - :mod:`.options.series.data.single_point ` - - :class:`SinglePointData ` - :class:`SingleValueData ` - :class:`SingleXData ` - :class:`LabeledSingleXData ` - :class:`ConnectedSingleXData ` - :class:`SinglePointBase ` - * - :mod:`.options.series.data.sunburst ` - - :class:`SunburstData ` - * - :mod:`.options.series.data.treemap ` - - :class:`TreemapData ` - * - :mod:`.options.series.data.vector ` - - :class:`VectorData ` - * - :mod:`.options.series.data.venn ` - - :class:`VennData ` - * - :mod:`.options.series.data.wordcloud ` - - :class:`WordcloudData ` + * - :mod:`.options.series.data.accessibility ` + - :class:`DataPointAccessibility ` + * - :mod:`.options.series.data.arcdiagram ` + - :class:`ArcDiagramData ` + * - :mod:`.options.series.data.bar ` + - :class:`BarData ` + :class:`WaterfallData ` + :class:`WindBarbData ` + :class:`XRangeData ` + * - :mod:`.options.series.data.base ` + - :class:`DataBase ` + * - :mod:`.options.series.data.boxplot ` + - :class:`BoxPlotData ` + * - :mod:`.options.series.data.bullet ` + - :class:`BulletData ` + * - :mod:`.options.series.data.cartesian ` + - :class:`CartesianData ` + :class:`Cartesian3DData ` + :class:`CartesianValueData ` + * - :mod:`.options.series.data.connections ` + - :class:`ConnectionData ` + :class:`WeightedConnectionData ` + :class:`OutgoingWeightedConnectionData ` + :class:`ConnectionBase ` + * - :mod:`.options.series.data.pie ` + - :class:`PieData ` + :class:`VariablePieData ` + * - :mod:`.options.series.data.range ` + - :class:`RangeData ` + :class:`ConnectedRangeData ` + * - :mod:`.options.series.data.single_point ` + - :class:`SinglePointData ` + :class:`SingleValueData ` + :class:`SingleXData ` + :class:`LabeledSingleXData ` + :class:`ConnectedSingleXData ` + :class:`SinglePointBase ` + * - :mod:`.options.series.data.sunburst ` + - :class:`SunburstData ` + * - :mod:`.options.series.data.treemap ` + - :class:`TreemapData ` + * - :mod:`.options.series.data.vector ` + - :class:`VectorData ` + * - :mod:`.options.series.data.venn ` + - :class:`VennData ` + * - :mod:`.options.series.data.wordcloud ` + - :class:`WordcloudData ` diff --git a/docs/api/options/series/data/pie.rst b/docs/api/options/series/data/pie.rst index e19d143b..45397bd8 100644 --- a/docs/api/options/series/data/pie.rst +++ b/docs/api/options/series/data/pie.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.pie ` +:mod:`.pie ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.pie +.. module:: highcharts_core.options.series.data.pie ******************************************************************************************************************** -class: :class:`PieData ` +class: :class:`PieData ` ******************************************************************************************************************** .. autoclass:: PieData @@ -22,7 +22,7 @@ class: :class:`PieData ` .. collapse:: Class Inheritance .. inheritance-diagram:: PieData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`PieData ` ----------------- ******************************************************************************************************************** -class: :class:`VariablePieData ` +class: :class:`VariablePieData ` ******************************************************************************************************************** .. autoclass:: VariablePieData @@ -40,7 +40,7 @@ class: :class:`VariablePieData ` +:mod:`.range ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.range +.. module:: highcharts_core.options.series.data.range ******************************************************************************************************************** -class: :class:`RangeData ` +class: :class:`RangeData ` ******************************************************************************************************************** .. autoclass:: RangeData @@ -22,7 +22,7 @@ class: :class:`RangeData .. collapse:: Class Inheritance .. inheritance-diagram:: RangeData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`RangeData --------------- ******************************************************************************************************************** -class: :class:`ConnectedRangeData ` +class: :class:`ConnectedRangeData ` ******************************************************************************************************************** .. autoclass:: ConnectedRangeData @@ -40,7 +40,7 @@ class: :class:`ConnectedRangeData ` +:mod:`.single_point ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.single_point +.. module:: highcharts_core.options.series.data.single_point ******************************************************************************************************************** -class: :class:`SinglePointData ` +class: :class:`SinglePointData ` ******************************************************************************************************************** .. autoclass:: SinglePointData @@ -22,7 +22,7 @@ class: :class:`SinglePointData ` +class: :class:`SingleValueData ` ******************************************************************************************************************** .. autoclass:: SingleValueData @@ -40,7 +40,7 @@ class: :class:`SingleValueData ` +class: :class:`SingleXData ` ******************************************************************************************************************** .. autoclass:: SingleXData @@ -58,7 +58,7 @@ class: :class:`SingleXData ` +class: :class:`LabeledSingleXData ` ******************************************************************************************************************** .. autoclass:: LabeledSingleXData @@ -76,7 +76,7 @@ class: :class:`LabeledSingleXData ` +class: :class:`ConnectedSingleXData ` ******************************************************************************************************************** .. autoclass:: ConnectedSingleXData @@ -94,7 +94,7 @@ class: :class:`ConnectedSingleXData ` +class: :class:`SinglePointBase ` ******************************************************************************************************************** .. autoclass:: SinglePointBase @@ -112,7 +112,7 @@ class: :class:`SinglePointBase ` +:mod:`.sunburst ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.sunburst +.. module:: highcharts_core.options.series.data.sunburst ******************************************************************************************************************** -class: :class:`SunburstData ` +class: :class:`SunburstData ` ******************************************************************************************************************** .. autoclass:: SunburstData @@ -22,7 +22,7 @@ class: :class:`SunburstData ` +:mod:`.treemap ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.treemap +.. module:: highcharts_core.options.series.data.treemap ******************************************************************************************************************** -class: :class:`TreemapData ` +class: :class:`TreemapData ` ******************************************************************************************************************** .. autoclass:: TreemapData @@ -22,7 +22,7 @@ class: :class:`TreemapData ` +:mod:`.vector ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.vector +.. module:: highcharts_core.options.series.data.vector ******************************************************************************************************************** -class: :class:`VectorData ` +class: :class:`VectorData ` ******************************************************************************************************************** .. autoclass:: VectorData @@ -22,7 +22,7 @@ class: :class:`VectorData ` +:mod:`.venn ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.venn +.. module:: highcharts_core.options.series.data.venn ******************************************************************************************************************** -class: :class:`VennData ` +class: :class:`VennData ` ******************************************************************************************************************** .. autoclass:: VennData @@ -22,7 +22,7 @@ class: :class:`VennData ` .. collapse:: Class Inheritance .. inheritance-diagram:: VennData - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/data/wordcloud.rst b/docs/api/options/series/data/wordcloud.rst index c66028b7..6e64dcbd 100644 --- a/docs/api/options/series/data/wordcloud.rst +++ b/docs/api/options/series/data/wordcloud.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.wordcloud ` +:mod:`.wordcloud ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.data.wordcloud +.. module:: highcharts_core.options.series.data.wordcloud ******************************************************************************************************************** -class: :class:`WordcloudData ` +class: :class:`WordcloudData ` ******************************************************************************************************************** .. autoclass:: WordcloudData @@ -22,7 +22,7 @@ class: :class:`WordcloudData ` +:mod:`.dependencywheel ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.dependencywheel +.. module:: highcharts_core.options.series.dependencywheel ************************************************************************************************************************ -class: :class:`DependencyWheelSeries ` +class: :class:`DependencyWheelSeries ` ************************************************************************************************************************ .. autoclass:: DependencyWheelSeries @@ -22,7 +22,7 @@ class: :class:`DependencyWheelSeries ` +:mod:`.dumbbell ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.dumbbell +.. module:: highcharts_core.options.series.dumbbell ******************************************************************************************************************** -class: :class:`DumbbellSeries ` +class: :class:`DumbbellSeries ` ******************************************************************************************************************** .. autoclass:: DumbbellSeries @@ -22,7 +22,7 @@ class: :class:`DumbbellSeries ` +class: :class:`LollipopSeries ` ******************************************************************************************************************** .. autoclass:: LollipopSeries @@ -40,7 +40,7 @@ class: :class:`LollipopSeries ` +:mod:`.funnel ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.funnel +.. module:: highcharts_core.options.series.funnel ******************************************************************************************************************** -class: :class:`FunnelSeries ` +class: :class:`FunnelSeries ` ******************************************************************************************************************** .. autoclass:: FunnelSeries @@ -22,7 +22,7 @@ class: :class:`FunnelSeries ` +class: :class:`Funnel3DSeries ` ******************************************************************************************************************** .. autoclass:: Funnel3DSeries @@ -40,7 +40,7 @@ class: :class:`Funnel3DSeries ` +:mod:`.gauge ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.gauge +.. module:: highcharts_core.options.series.gauge ******************************************************************************************************************** -class: :class:`GaugeSeries ` +class: :class:`GaugeSeries ` ******************************************************************************************************************** .. autoclass:: GaugeSeries @@ -22,7 +22,7 @@ class: :class:`GaugeSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: GaugeSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`GaugeSeries ` -------------- ******************************************************************************************************************** -class: :class:`SolidGaugeSeries ` +class: :class:`SolidGaugeSeries ` ******************************************************************************************************************** .. autoclass:: SolidGaugeSeries @@ -40,7 +40,7 @@ class: :class:`SolidGaugeSeries ` +:mod:`.Heatmap ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.heatmap +.. module:: highcharts_core.options.series.heatmap ******************************************************************************************************************** -class: :class:`HeatmapSeries ` +class: :class:`HeatmapSeries ` ******************************************************************************************************************** .. autoclass:: HeatmapSeries @@ -22,7 +22,7 @@ class: :class:`HeatmapSeries ` +class: :class:`TilemapSeries ` ******************************************************************************************************************** .. autoclass:: TilemapSeries @@ -40,7 +40,7 @@ class: :class:`TilemapSeries ` +:mod:`.histogram ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.histogram +.. module:: highcharts_core.options.series.histogram ******************************************************************************************************************** -class: :class:`HistogramSeries ` +class: :class:`HistogramSeries ` ******************************************************************************************************************** .. autoclass:: HistogramSeries @@ -22,7 +22,7 @@ class: :class:`HistogramSeries ` +:mod:`.series ` ################################################################ .. contents:: Module Contents @@ -58,143 +58,143 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.options.series ` + * - :mod:`.options.series ` - - * - :mod:`.options.series.arcdiagram ` - - :class:`ArcDiagramSeries ` - * - :mod:`.options.series.area ` - - :class:`AreaSeries ` - :class:`AreaRangeSeries ` - :class:`AreaSplineSeries ` - :class:`AreaSplineRangeSeries ` - :class:`LineSeries ` - :class:`StreamGraphSeries ` - * - :mod:`.options.series.bar ` - - :class:`BarSeries ` - :class:`ColumnSeries ` - :class:`ColumnPyramidSeries ` - :class:`ColumnRangeSeries ` - :class:`CylinderSeries ` - :class:`VariwideSeries ` - :class:`WaterfallSeries ` - :class:`WindBarbSeries ` - :class:`XRangeSeries ` - :class:`BaseBarSeries ` - * - :mod:`.options.series.base ` - - :class:`SeriesBase ` - * - :mod:`.options.series.bellcurve ` - - :class:`BellCurveSeries ` - * - :mod:`.options.series.boxplot ` - - :class:`BoxPlotSeries ` - :class:`ErrorBarSeries ` - * - :mod:`.options.series.bubble ` - - :class:`BubbleSeries ` - * - :mod:`.options.series.bullet ` - - :class:`BulletSeries ` - * - :mod:`.options.series.data ` + * - :mod:`.options.series.arcdiagram ` + - :class:`ArcDiagramSeries ` + * - :mod:`.options.series.area ` + - :class:`AreaSeries ` + :class:`AreaRangeSeries ` + :class:`AreaSplineSeries ` + :class:`AreaSplineRangeSeries ` + :class:`LineSeries ` + :class:`StreamGraphSeries ` + * - :mod:`.options.series.bar ` + - :class:`BarSeries ` + :class:`ColumnSeries ` + :class:`ColumnPyramidSeries ` + :class:`ColumnRangeSeries ` + :class:`CylinderSeries ` + :class:`VariwideSeries ` + :class:`WaterfallSeries ` + :class:`WindBarbSeries ` + :class:`XRangeSeries ` + :class:`BaseBarSeries ` + * - :mod:`.options.series.base ` + - :class:`SeriesBase ` + * - :mod:`.options.series.bellcurve ` + - :class:`BellCurveSeries ` + * - :mod:`.options.series.boxplot ` + - :class:`BoxPlotSeries ` + :class:`ErrorBarSeries ` + * - :mod:`.options.series.bubble ` + - :class:`BubbleSeries ` + * - :mod:`.options.series.bullet ` + - :class:`BulletSeries ` + * - :mod:`.options.series.data ` - - * - :mod:`.options.series.data.accessibility ` - - :class:`DataPointAccessibility ` - * - :mod:`.options.series.data.arcdiagram ` - - :class:`ArcDiagramData ` - * - :mod:`.options.series.data.bar ` - - :class:`BarData ` - :class:`WaterfallData ` - :class:`WindBarbData ` - :class:`XRangeData ` - * - :mod:`.options.series.data.base ` - - :class:`DataBase ` - * - :mod:`.options.series.data.boxplot ` - - :class:`BoxPlotData ` - * - :mod:`.options.series.data.bullet ` - - :class:`BulletData ` - * - :mod:`.options.series.data.cartesian ` - - :class:`CartesianData ` - :class:`Cartesian3DData ` - :class:`CartesianValueData ` - * - :mod:`.options.series.data.connections ` - - :class:`ConnectionData ` - :class:`WeightedConnectionData ` - :class:`OutgoingWeightedConnectionData ` - :class:`ConnectionBase ` - * - :mod:`.options.series.data.pie ` - - :class:`PieData ` - :class:`VariablePieData ` - * - :mod:`.options.series.data.range ` - - :class:`RangeData ` - :class:`ConnectedRangeData ` - * - :mod:`.options.series.data.single_point ` - - :class:`SinglePointData ` - :class:`SingleValueData ` - :class:`SingleXData ` - :class:`LabeledSingleXData ` - :class:`ConnectedSingleXData ` - :class:`SinglePointBase ` - * - :mod:`.options.series.data.sunburst ` - - :class:`SunburstData ` - * - :mod:`.options.series.data.treemap ` - - :class:`TreemapData ` - * - :mod:`.options.series.data.vector ` - - :class:`VectorData ` - * - :mod:`.options.series.data.venn ` - - :class:`VennData ` - * - :mod:`.options.series.data.wordcloud ` - - :class:`WordcloudData ` - * - :mod:`.options.series.dependencywheel ` - - :class:`DependencyWheelSeries ` - * - :mod:`.options.series.dumbbell ` - - :class:`DumbbellSeries ` - :class:`LollipopSeries ` - * - :mod:`.options.series.funnel ` - - :class:`FunnelSeries ` - :class:`Funnel3DSeries ` - * - :mod:`.options.series.gauge ` - - :class:`GaugeSeries ` - :class:`SolidGaugeSeries ` - * - :mod:`.options.series.heatmap ` - - :class:`HeatmapSeries ` - :class:`TilemapSeries ` - * - :mod:`.options.series.histogram ` - - :class:`HistogramSeries ` - * - :mod:`.options.series.item ` - - :class:`ItemSeries ` - * - :mod:`.options.series.labels ` - - :class:`SeriesLabel ` - :class:`Box ` - * - :mod:`.options.series.networkgraph ` - - :class:`NetworkGraphSeries ` - * - :mod:`.options.series.organization ` - - :class:`OrganizationSeries ` - * - :mod:`.options.series.packedbubble ` - - :class:`PackedBubbleSeries ` - * - :mod:`.options.series.pareto ` - - :class:`ParetoSeries ` - * - :mod:`.options.series.pie ` - - :class:`PieSeries ` - :class:`VariablePieSeries ` - * - :mod:`.options.series.polygon ` - - :class:`PolygonSeries ` - * - :mod:`.options.series.pyramid ` - - :class:`PyramidSeries ` - :class:`Pyramid3DSeries ` - * - :mod:`.options.series.sankey ` - - :class:`SankeySeries ` - * - :mod:`.options.series.scatter ` - - :class:`ScatterSeries ` - :class:`Scatter3DSeries ` - * - :mod:`.options.series.series_generator ` - - :func:`create_series_obj() ` - * - :mod:`.options.series.spline ` - - :class:`SplineSeries ` - * - :mod:`.options.series.sunburst ` - - :class:`SunburstSeries ` - * - :mod:`.options.series.timeline ` - - :class:`TimelineSeries ` - * - :mod:`.options.series.treemap ` - - :class:`TreemapSeries ` - * - :mod:`.options.series.vector ` - - :class:`VectorSeries ` - * - :mod:`.options.series.venn ` - - :class:`VennSeries ` - * - :mod:`.options.series.wordcloud ` - - :class:`WordcloudSeries ` + * - :mod:`.options.series.data.accessibility ` + - :class:`DataPointAccessibility ` + * - :mod:`.options.series.data.arcdiagram ` + - :class:`ArcDiagramData ` + * - :mod:`.options.series.data.bar ` + - :class:`BarData ` + :class:`WaterfallData ` + :class:`WindBarbData ` + :class:`XRangeData ` + * - :mod:`.options.series.data.base ` + - :class:`DataBase ` + * - :mod:`.options.series.data.boxplot ` + - :class:`BoxPlotData ` + * - :mod:`.options.series.data.bullet ` + - :class:`BulletData ` + * - :mod:`.options.series.data.cartesian ` + - :class:`CartesianData ` + :class:`Cartesian3DData ` + :class:`CartesianValueData ` + * - :mod:`.options.series.data.connections ` + - :class:`ConnectionData ` + :class:`WeightedConnectionData ` + :class:`OutgoingWeightedConnectionData ` + :class:`ConnectionBase ` + * - :mod:`.options.series.data.pie ` + - :class:`PieData ` + :class:`VariablePieData ` + * - :mod:`.options.series.data.range ` + - :class:`RangeData ` + :class:`ConnectedRangeData ` + * - :mod:`.options.series.data.single_point ` + - :class:`SinglePointData ` + :class:`SingleValueData ` + :class:`SingleXData ` + :class:`LabeledSingleXData ` + :class:`ConnectedSingleXData ` + :class:`SinglePointBase ` + * - :mod:`.options.series.data.sunburst ` + - :class:`SunburstData ` + * - :mod:`.options.series.data.treemap ` + - :class:`TreemapData ` + * - :mod:`.options.series.data.vector ` + - :class:`VectorData ` + * - :mod:`.options.series.data.venn ` + - :class:`VennData ` + * - :mod:`.options.series.data.wordcloud ` + - :class:`WordcloudData ` + * - :mod:`.options.series.dependencywheel ` + - :class:`DependencyWheelSeries ` + * - :mod:`.options.series.dumbbell ` + - :class:`DumbbellSeries ` + :class:`LollipopSeries ` + * - :mod:`.options.series.funnel ` + - :class:`FunnelSeries ` + :class:`Funnel3DSeries ` + * - :mod:`.options.series.gauge ` + - :class:`GaugeSeries ` + :class:`SolidGaugeSeries ` + * - :mod:`.options.series.heatmap ` + - :class:`HeatmapSeries ` + :class:`TilemapSeries ` + * - :mod:`.options.series.histogram ` + - :class:`HistogramSeries ` + * - :mod:`.options.series.item ` + - :class:`ItemSeries ` + * - :mod:`.options.series.labels ` + - :class:`SeriesLabel ` + :class:`Box ` + * - :mod:`.options.series.networkgraph ` + - :class:`NetworkGraphSeries ` + * - :mod:`.options.series.organization ` + - :class:`OrganizationSeries ` + * - :mod:`.options.series.packedbubble ` + - :class:`PackedBubbleSeries ` + * - :mod:`.options.series.pareto ` + - :class:`ParetoSeries ` + * - :mod:`.options.series.pie ` + - :class:`PieSeries ` + :class:`VariablePieSeries ` + * - :mod:`.options.series.polygon ` + - :class:`PolygonSeries ` + * - :mod:`.options.series.pyramid ` + - :class:`PyramidSeries ` + :class:`Pyramid3DSeries ` + * - :mod:`.options.series.sankey ` + - :class:`SankeySeries ` + * - :mod:`.options.series.scatter ` + - :class:`ScatterSeries ` + :class:`Scatter3DSeries ` + * - :mod:`.options.series.series_generator ` + - :func:`create_series_obj() ` + * - :mod:`.options.series.spline ` + - :class:`SplineSeries ` + * - :mod:`.options.series.sunburst ` + - :class:`SunburstSeries ` + * - :mod:`.options.series.timeline ` + - :class:`TimelineSeries ` + * - :mod:`.options.series.treemap ` + - :class:`TreemapSeries ` + * - :mod:`.options.series.vector ` + - :class:`VectorSeries ` + * - :mod:`.options.series.venn ` + - :class:`VennSeries ` + * - :mod:`.options.series.wordcloud ` + - :class:`WordcloudSeries ` diff --git a/docs/api/options/series/item.rst b/docs/api/options/series/item.rst index f2cf0f2d..bb6736de 100644 --- a/docs/api/options/series/item.rst +++ b/docs/api/options/series/item.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.item ` +:mod:`.item ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.item +.. module:: highcharts_core.options.series.item ******************************************************************************************************************** -class: :class:`ItemSeries ` +class: :class:`ItemSeries ` ******************************************************************************************************************** .. autoclass:: ItemSeries @@ -22,7 +22,7 @@ class: :class:`ItemSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: ItemSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/labels.rst b/docs/api/options/series/labels.rst index 8813d162..868da3fb 100644 --- a/docs/api/options/series/labels.rst +++ b/docs/api/options/series/labels.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.labels ` +:mod:`.labels ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.labels +.. module:: highcharts_core.options.series.labels ******************************************************************************************************************** -class: :class:`SeriesLabel ` +class: :class:`SeriesLabel ` ******************************************************************************************************************** .. autoclass:: SeriesLabel @@ -22,7 +22,7 @@ class: :class:`SeriesLabel .. collapse:: Class Inheritance .. inheritance-diagram:: SeriesLabel - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`SeriesLabel ----------------- ******************************************************************************************************************** -class: :class:`Box ` +class: :class:`Box ` ******************************************************************************************************************** .. autoclass:: Box @@ -40,7 +40,7 @@ class: :class:`Box ` .. collapse:: Class Inheritance .. inheritance-diagram:: Box - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/networkgraph.rst b/docs/api/options/series/networkgraph.rst index 74ae94b1..63185bb3 100644 --- a/docs/api/options/series/networkgraph.rst +++ b/docs/api/options/series/networkgraph.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.networkgraph ` +:mod:`.networkgraph ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.networkgraph +.. module:: highcharts_core.options.series.networkgraph ******************************************************************************************************************** -class: :class:`NetworkGraphSeries ` +class: :class:`NetworkGraphSeries ` ******************************************************************************************************************** .. autoclass:: NetworkGraphSeries @@ -22,7 +22,7 @@ class: :class:`NetworkGraphSeries ` +:mod:`.organization ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.organization +.. module:: highcharts_core.options.series.organization ******************************************************************************************************************** -class: :class:`OrganizationSeries ` +class: :class:`OrganizationSeries ` ******************************************************************************************************************** .. autoclass:: OrganizationSeries @@ -22,7 +22,7 @@ class: :class:`OrganizationSeries ` +:mod:`.packedbubble ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.packedbubble +.. module:: highcharts_core.options.series.packedbubble ******************************************************************************************************************** -class: :class:`PackedBubbleSeries ` +class: :class:`PackedBubbleSeries ` ******************************************************************************************************************** .. autoclass:: PackedBubbleSeries @@ -22,7 +22,7 @@ class: :class:`PackedBubbleSeries ` +:mod:`.pareto ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.pareto +.. module:: highcharts_core.options.series.pareto ******************************************************************************************************************** -class: :class:`ParetoSeries ` +class: :class:`ParetoSeries ` ******************************************************************************************************************** .. autoclass:: ParetoSeries @@ -22,7 +22,7 @@ class: :class:`ParetoSeries ` +:mod:`.pie ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.pie +.. module:: highcharts_core.options.series.pie ******************************************************************************************************************** -class: :class:`PieSeries ` +class: :class:`PieSeries ` ******************************************************************************************************************** .. autoclass:: PieSeries @@ -22,7 +22,7 @@ class: :class:`PieSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: PieSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -31,7 +31,7 @@ class: :class:`PieSeries ` ------ ******************************************************************************************************************** -class: :class:`VariablePieSeries ` +class: :class:`VariablePieSeries ` ******************************************************************************************************************** .. autoclass:: VariablePieSeries @@ -41,7 +41,7 @@ class: :class:`VariablePieSeries ` +:mod:`.polygon ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.polygon +.. module:: highcharts_core.options.series.polygon ******************************************************************************************************************** -class: :class:`PolygonSeries ` +class: :class:`PolygonSeries ` ******************************************************************************************************************** .. autoclass:: PolygonSeries @@ -22,7 +22,7 @@ class: :class:`PolygonSeries ` +:mod:`.pyramid ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.pyramid +.. module:: highcharts_core.options.series.pyramid ******************************************************************************************************************** -class: :class:`PyramidSeries ` +class: :class:`PyramidSeries ` ******************************************************************************************************************** .. autoclass:: PyramidSeries @@ -22,7 +22,7 @@ class: :class:`PyramidSeries ` +class: :class:`Pyramid3DSeries ` ******************************************************************************************************************** .. autoclass:: Pyramid3DSeries @@ -40,7 +40,7 @@ class: :class:`Pyramid3DSeries ` +:mod:`.sankey ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.sankey +.. module:: highcharts_core.options.series.sankey ******************************************************************************************************************** -class: :class:`SankeySeries ` +class: :class:`SankeySeries ` ******************************************************************************************************************** .. autoclass:: SankeySeries @@ -22,7 +22,7 @@ class: :class:`SankeySeries ` +:mod:`.scatter ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.scatter +.. module:: highcharts_core.options.series.scatter ******************************************************************************************************************** -class: :class:`ScatterSeries ` +class: :class:`ScatterSeries ` ******************************************************************************************************************** .. autoclass:: ScatterSeries @@ -22,7 +22,7 @@ class: :class:`ScatterSeries ` +class: :class:`Scatter3DSeries ` ******************************************************************************************************************** .. autoclass:: Scatter3DSeries @@ -40,7 +40,7 @@ class: :class:`Scatter3DSeries ` +:mod:`.series_generator ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.series_generator +.. module:: highcharts_core.options.series.series_generator ******************************************************************************************************************** -function: :func:`create_series_obj() ` +function: :func:`create_series_obj() ` ******************************************************************************************************************** .. autofunction:: create_series_obj diff --git a/docs/api/options/series/spline.rst b/docs/api/options/series/spline.rst index 226268e7..bf9f388d 100644 --- a/docs/api/options/series/spline.rst +++ b/docs/api/options/series/spline.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.spline ` +:mod:`.spline ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.spline +.. module:: highcharts_core.options.series.spline ******************************************************************************************************************** -class: :class:`SplineSeries ` +class: :class:`SplineSeries ` ******************************************************************************************************************** .. autoclass:: SplineSeries @@ -22,7 +22,7 @@ class: :class:`SplineSeries ` +:mod:`.sunburst ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.sunburst +.. module:: highcharts_core.options.series.sunburst ******************************************************************************************************************** -class: :class:`SunburstSeries ` +class: :class:`SunburstSeries ` ******************************************************************************************************************** .. autoclass:: SunburstSeries @@ -22,7 +22,7 @@ class: :class:`SunburstSeries ` +:mod:`.timeline ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.timeline +.. module:: highcharts_core.options.series.timeline ******************************************************************************************************************** -class: :class:`TimelineSeries ` +class: :class:`TimelineSeries ` ******************************************************************************************************************** .. autoclass:: TimelineSeries @@ -22,7 +22,7 @@ class: :class:`TimelineSeries ` +:mod:`.treemap ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.treemap +.. module:: highcharts_core.options.series.treemap ******************************************************************************************************************** -class: :class:`TreemapSeries ` +class: :class:`TreemapSeries ` ******************************************************************************************************************** .. autoclass:: TreemapSeries @@ -22,7 +22,7 @@ class: :class:`TreemapSeries ` +:mod:`.vector ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.vector +.. module:: highcharts_core.options.series.vector ******************************************************************************************************************** -class: :class:`VectorSeries ` +class: :class:`VectorSeries ` ******************************************************************************************************************** .. autoclass:: VectorSeries @@ -22,7 +22,7 @@ class: :class:`VectorSeries ` +:mod:`.venn ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.venn +.. module:: highcharts_core.options.series.venn ******************************************************************************************************************** -class: :class:`VennSeries ` +class: :class:`VennSeries ` ******************************************************************************************************************** .. autoclass:: VennSeries @@ -22,7 +22,7 @@ class: :class:`VennSeries ` .. collapse:: Class Inheritance .. inheritance-diagram:: VennSeries - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/series/wordcloud.rst b/docs/api/options/series/wordcloud.rst index 6224bfdf..f380f40c 100644 --- a/docs/api/options/series/wordcloud.rst +++ b/docs/api/options/series/wordcloud.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.wordcloud ` +:mod:`.wordcloud ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.series.wordcloud +.. module:: highcharts_core.options.series.wordcloud ******************************************************************************************************************** -class: :class:`WordcloudSeries ` +class: :class:`WordcloudSeries ` ******************************************************************************************************************** .. autoclass:: WordcloudSeries @@ -22,7 +22,7 @@ class: :class:`WordcloudSeries ` +:mod:`.subtitle ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.subtitle +.. module:: highcharts_core.options.subtitle ******************************************************************************************************************** -class: :class:`Subtitle ` +class: :class:`Subtitle ` ******************************************************************************************************************** .. autoclass:: Subtitle @@ -22,7 +22,7 @@ class: :class:`Subtitle ` .. collapse:: Class Inheritance .. inheritance-diagram:: Subtitle - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/time.rst b/docs/api/options/time.rst index ea216c01..d4e3f5ca 100644 --- a/docs/api/options/time.rst +++ b/docs/api/options/time.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.time ` +:mod:`.time ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.time +.. module:: highcharts_core.options.time ******************************************************************************************************************** -class: :class:`Time ` +class: :class:`Time ` ******************************************************************************************************************** .. autoclass:: Time @@ -22,7 +22,7 @@ class: :class:`Time ` .. collapse:: Class Inheritance .. inheritance-diagram:: Time - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/title.rst b/docs/api/options/title.rst index 39934291..8b1927f6 100644 --- a/docs/api/options/title.rst +++ b/docs/api/options/title.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.title ` +:mod:`.title ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.title +.. module:: highcharts_core.options.title ******************************************************************************************************************** -class: :class:`Title ` +class: :class:`Title ` ******************************************************************************************************************** .. autoclass:: Title @@ -22,7 +22,7 @@ class: :class:`Title ` .. collapse:: Class Inheritance .. inheritance-diagram:: Title - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/options/tooltips.rst b/docs/api/options/tooltips.rst index 18f277e9..c6019702 100644 --- a/docs/api/options/tooltips.rst +++ b/docs/api/options/tooltips.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.tooltips ` +:mod:`.tooltips ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.options.tooltips +.. module:: highcharts_core.options.tooltips ******************************************************************************************************************** -class: :class:`Tooltip ` +class: :class:`Tooltip ` ******************************************************************************************************************** .. autoclass:: Tooltip @@ -22,7 +22,7 @@ class: :class:`Tooltip ` .. collapse:: Class Inheritance .. inheritance-diagram:: Tooltip - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/animation.rst b/docs/api/utility_classes/animation.rst index 49705aa0..d74bef5e 100644 --- a/docs/api/utility_classes/animation.rst +++ b/docs/api/utility_classes/animation.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.animation ` +:mod:`.animation ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.animation +.. module:: highcharts_core.utility_classes.animation ******************************************************************************************************************** -class: :class:`AnimationOptions ` +class: :class:`AnimationOptions ` ******************************************************************************************************************** .. autoclass:: AnimationOptions @@ -22,7 +22,7 @@ class: :class:`AnimationOptions ` +:mod:`.ast ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.ast +.. module:: highcharts_core.utility_classes.ast ******************************************************************************************************************** -class: :class:`ASTMap ` +class: :class:`ASTMap ` ******************************************************************************************************************** .. autoclass:: ASTMap @@ -22,7 +22,7 @@ class: :class:`ASTMap ` .. collapse:: Class Inheritance .. inheritance-diagram:: ASTMap - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`ASTMap ` -------------- ******************************************************************************************************************** -class: :class:`ASTNode ` +class: :class:`ASTNode ` ******************************************************************************************************************** .. autoclass:: ASTNode @@ -40,7 +40,7 @@ class: :class:`ASTNode ` .. collapse:: Class Inheritance .. inheritance-diagram:: ASTNode - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -48,7 +48,7 @@ class: :class:`ASTNode ` ----------------- ******************************************************************************************************************** -class: :class:`TextPath ` +class: :class:`TextPath ` ******************************************************************************************************************** .. autoclass:: TextPath @@ -58,7 +58,7 @@ class: :class:`TextPath ` .. collapse:: Class Inheritance .. inheritance-diagram:: TextPath - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -66,7 +66,7 @@ class: :class:`TextPath ` ------------------- ******************************************************************************************************************** -class: :class:`AttributeObject ` +class: :class:`AttributeObject ` ******************************************************************************************************************** .. autoclass:: AttributeObject @@ -76,7 +76,7 @@ class: :class:`AttributeObject ` +:mod:`.breadcrumbs ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.breadcrumbs +.. module:: highcharts_core.utility_classes.breadcrumbs ******************************************************************************************************************** -class: :class:`BreadcrumbOptions ` +class: :class:`BreadcrumbOptions ` ******************************************************************************************************************** .. autoclass:: BreadcrumbOptions @@ -22,7 +22,7 @@ class: :class:`BreadcrumbOptions ` +class: :class:`Separator ` ******************************************************************************************************************** .. autoclass:: Separator @@ -40,7 +40,7 @@ class: :class:`Separator ` +:mod:`.buttons ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.buttons +.. module:: highcharts_core.utility_classes.buttons ******************************************************************************************************************** -class: :class:`ExportingButtons ` +class: :class:`ExportingButtons ` ******************************************************************************************************************** .. autoclass:: ExportingButtons @@ -22,7 +22,7 @@ class: :class:`ExportingButtons ` +class: :class:`ContextButtonConfiguration ` ******************************************************************************************************************** .. autoclass:: ContextButtonConfiguration @@ -40,7 +40,7 @@ class: :class:`ContextButtonConfiguration ` +class: :class:`ButtonConfiguration ` ******************************************************************************************************************** .. autoclass:: ButtonConfiguration @@ -58,7 +58,7 @@ class: :class:`ButtonConfiguration ` +class: :class:`ButtonTheme ` ******************************************************************************************************************** .. autoclass:: ButtonTheme @@ -76,7 +76,7 @@ class: :class:`ButtonTheme ` +:mod:`.clusters ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.clusters +.. module:: highcharts_core.utility_classes.clusters ******************************************************************************************************************** -class: :class:`ClusterOptions ` +class: :class:`ClusterOptions ` ******************************************************************************************************************** .. autoclass:: ClusterOptions @@ -22,7 +22,7 @@ class: :class:`ClusterOptions ` +class: :class:`VectorLayoutAlgorithm ` ******************************************************************************************************************** .. autoclass:: VectorLayoutAlgorithm @@ -40,7 +40,7 @@ class: :class:`VectorLayoutAlgorithm ` +:mod:`.data_grouping ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.data_grouping +.. module:: highcharts_core.utility_classes.data_grouping ******************************************************************************************************************** -class: :class:`DataGroupingOptions ` +class: :class:`DataGroupingOptions ` ******************************************************************************************************************** .. autoclass:: DataGroupingOptions @@ -22,7 +22,7 @@ class: :class:`DataGroupingOptions ` +:mod:`.data_labels ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.data_labels +.. module:: highcharts_core.utility_classes.data_labels ******************************************************************************************************************** -class: :class:`DataLabel ` +class: :class:`DataLabel ` ******************************************************************************************************************** .. autoclass:: DataLabel @@ -22,7 +22,7 @@ class: :class:`DataLabel ` +class: :class:`NodeDataLabel ` ******************************************************************************************************************** .. autoclass:: NodeDataLabel @@ -40,7 +40,7 @@ class: :class:`NodeDataLabel ` +class: :class:`Filter ` ******************************************************************************************************************** .. autoclass:: Filter @@ -58,7 +58,7 @@ class: :class:`Filter ` .. collapse:: Class Inheritance .. inheritance-diagram:: Filter - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/date_time_label_formats.rst b/docs/api/utility_classes/date_time_label_formats.rst index d962a318..f1ed7c8c 100644 --- a/docs/api/utility_classes/date_time_label_formats.rst +++ b/docs/api/utility_classes/date_time_label_formats.rst @@ -1,5 +1,5 @@ ############################################################################################### -:mod:`.date_time_label_formats ` +:mod:`.date_time_label_formats ` ############################################################################################### .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.date_time_label_formats +.. module:: highcharts_core.utility_classes.date_time_label_formats ************************************************************************************************************************ -class: :class:`DateTimeLabelFormats ` +class: :class:`DateTimeLabelFormats ` ************************************************************************************************************************ .. autoclass:: DateTimeLabelFormats @@ -22,7 +22,7 @@ class: :class:`DateTimeLabelFormats ` +:mod:`.events ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.events +.. module:: highcharts_core.utility_classes.events ******************************************************************************************************************** -class: :class:`ChartEvents ` +class: :class:`ChartEvents ` ******************************************************************************************************************** .. autoclass:: ChartEvents @@ -22,7 +22,7 @@ class: :class:`ChartEvents ` +class: :class:`BreadcrumbEvents ` ******************************************************************************************************************** .. autoclass:: BreadcrumbEvents @@ -40,7 +40,7 @@ class: :class:`BreadcrumbEvents ` +class: :class:`NavigationEvents ` ******************************************************************************************************************** .. autoclass:: NavigationEvents @@ -58,7 +58,7 @@ class: :class:`NavigationEvents ` +class: :class:`PointEvents ` ******************************************************************************************************************** .. autoclass:: PointEvents @@ -76,7 +76,7 @@ class: :class:`PointEvents ` +class: :class:`SeriesEvents ` ******************************************************************************************************************** .. autoclass:: SeriesEvents @@ -94,7 +94,7 @@ class: :class:`SeriesEvents ` +class: :class:`ClusterEvents ` ******************************************************************************************************************** .. autoclass:: ClusterEvents @@ -112,7 +112,7 @@ class: :class:`ClusterEvents ` +class: :class:`AxisEvents ` ******************************************************************************************************************** .. autoclass:: AxisEvents @@ -130,7 +130,7 @@ class: :class:`AxisEvents ` .. collapse:: Class Inheritance .. inheritance-diagram:: AxisEvents - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -138,7 +138,7 @@ class: :class:`AxisEvents ` ---------------- ******************************************************************************************************************** -class: :class:`MouseEvents ` +class: :class:`MouseEvents ` ******************************************************************************************************************** .. autoclass:: MouseEvents @@ -148,7 +148,7 @@ class: :class:`MouseEvents ` +:mod:`.gradients ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.gradients +.. module:: highcharts_core.utility_classes.gradients ******************************************************************************************************************** -class: :class:`Gradient ` +class: :class:`Gradient ` ******************************************************************************************************************** .. autoclass:: Gradient @@ -22,7 +22,7 @@ class: :class:`Gradient ` .. collapse:: Class Inheritance .. inheritance-diagram:: Gradient - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Gradient ` -------------------- ******************************************************************************************************************** -class: :class:`LinearGradient ` +class: :class:`LinearGradient ` ******************************************************************************************************************** .. autoclass:: LinearGradient @@ -40,7 +40,7 @@ class: :class:`LinearGradient ` +class: :class:`RadialGradient ` ******************************************************************************************************************** .. autoclass:: RadialGradient @@ -58,7 +58,7 @@ class: :class:`RadialGradient ` +:mod:`.utility_classes ` ############################################################## .. contents:: Module Contents @@ -44,76 +44,77 @@ Sub-components * - Module - Classes / Functions - * - :mod:`.utility_classes ` + * - :mod:`.utility_classes ` - - * - :mod:`.utility_classes.animation ` - - :class:`AnimationOptions ` - * - :mod:`.utility_classes.ast ` - - :class:`ASTMap ` - :class:`ASTNode ` - :class:`TextPath ` - :class:`AttributeObject ` - * - :mod:`.utility_classes.breadcrumbs ` - - :class:`BreadcrumbOptions ` - :class:`Separator ` - * - :mod:`.utility_classes.buttons ` - - :class:`ExportingButtons ` - :class:`ContextButtonConfiguration ` - :class:`ButtonConfiguration ` - :class:`ButtonTheme ` - * - :mod:`.utility_classes.clusters ` - - :class:`ClusterOptions ` - :class:`VectorLayoutAlgorithm ` - * - :mod:`.utility_classes.data_grouping ` - - :class:`DataGroupingOptions ` - * - :mod:`.utility_classes.data_labels ` - - :class:`DataLabel ` - :class:`NodeDataLabel ` - :class:`Filter ` - * - :mod:`.utility_classes.date_time_label_formats ` - - :class:`DateTimeLabelFormats ` - * - :mod:`.utility_classes.events ` - - :class:`ChartEvents ` - :class:`BreadcrumbEvents ` - :class:`NavigationEvents ` - :class:`PointEvents ` - :class:`SeriesEvents ` - :class:`ClusterEvents ` - :class:`AxisEvents ` - :class:`MouseEvents ` - * - :mod:`.utility_classes.gradients ` - - :class:`Gradient ` - :class:`LinearGradient ` - :class:`RadialGradient ` - * - :mod:`.utility_classes.javascript_functions ` - - :class:`CallbackFunction ` - :class:`JavaScriptClass ` - * - :mod:`.utility_classes.jitter ` - - :class:`Jitter ` - * - :mod:`.utility_classes.markers ` - - :class:`Marker ` - * - :mod:`.utility_classes.menus ` - - :class:`MenuObject ` - :class:`MenuItem ` - * - :mod:`.utility_classes.nodes ` - - :class:`NodeOptions ` - :class:`DependencyWheelNodeOptions ` - :class:`OrganizationNodeOptions ` - * - :mod:`.utility_classes.partial_fill ` - - :class:`PartialFillOptions ` - * - :mod:`.utility_classes.patterns ` - - :class:`Pattern ` - :class:`PatternOptions ` - * - :mod:`.utility_classes.position ` - - :class:`Position ` - * - :mod:`.utility_classes.shadows ` - - :class:`ShadowOptions ` - * - :mod:`.utility_classes.states ` - - :class:`States ` - :class:`HoverState ` - :class:`InactiveState ` - :class:`NormalState ` - :class:`SelectState ` - * - :mod:`.utility_classes.zones ` - - :class:`Zone ` - :class:`ClusterZone ` + * - :mod:`.utility_classes.animation ` + - :class:`AnimationOptions ` + * - :mod:`.utility_classes.ast ` + - :class:`ASTMap ` + :class:`ASTNode ` + :class:`TextPath ` + :class:`AttributeObject ` + * - :mod:`.utility_classes.breadcrumbs ` + - :class:`BreadcrumbOptions ` + :class:`Separator ` + * - :mod:`.utility_classes.buttons ` + - :class:`ExportingButtons ` + :class:`ContextButtonConfiguration ` + :class:`ButtonConfiguration ` + :class:`ButtonTheme ` + * - :mod:`.utility_classes.clusters ` + - :class:`ClusterOptions ` + :class:`VectorLayoutAlgorithm ` + * - :mod:`.utility_classes.data_grouping ` + - :class:`DataGroupingOptions ` + * - :mod:`.utility_classes.data_labels ` + - :class:`DataLabel ` + :class:`NodeDataLabel ` + :class:`Filter ` + * - :mod:`.utility_classes.date_time_label_formats ` + - :class:`DateTimeLabelFormats ` + * - :mod:`.utility_classes.events ` + - :class:`ChartEvents ` + :class:`BreadcrumbEvents ` + :class:`NavigationEvents ` + :class:`PointEvents ` + :class:`SeriesEvents ` + :class:`ClusterEvents ` + :class:`AxisEvents ` + :class:`MouseEvents ` + * - :mod:`.utility_classes.gradients ` + - :class:`Gradient ` + :class:`LinearGradient ` + :class:`RadialGradient ` + * - :mod:`.utility_classes.javascript_functions ` + - :class:`CallbackFunction ` + :class:`JavaScriptClass ` + :class:`VariableName ` + * - :mod:`.utility_classes.jitter ` + - :class:`Jitter ` + * - :mod:`.utility_classes.markers ` + - :class:`Marker ` + * - :mod:`.utility_classes.menus ` + - :class:`MenuObject ` + :class:`MenuItem ` + * - :mod:`.utility_classes.nodes ` + - :class:`NodeOptions ` + :class:`DependencyWheelNodeOptions ` + :class:`OrganizationNodeOptions ` + * - :mod:`.utility_classes.partial_fill ` + - :class:`PartialFillOptions ` + * - :mod:`.utility_classes.patterns ` + - :class:`Pattern ` + :class:`PatternOptions ` + * - :mod:`.utility_classes.position ` + - :class:`Position ` + * - :mod:`.utility_classes.shadows ` + - :class:`ShadowOptions ` + * - :mod:`.utility_classes.states ` + - :class:`States ` + :class:`HoverState ` + :class:`InactiveState ` + :class:`NormalState ` + :class:`SelectState ` + * - :mod:`.utility_classes.zones ` + - :class:`Zone ` + :class:`ClusterZone ` diff --git a/docs/api/utility_classes/javascript_functions.rst b/docs/api/utility_classes/javascript_functions.rst index f03be10e..d116d550 100644 --- a/docs/api/utility_classes/javascript_functions.rst +++ b/docs/api/utility_classes/javascript_functions.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.javascript_functions ` +:mod:`.javascript_functions ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.javascript_functions +.. module:: highcharts_core.utility_classes.javascript_functions ******************************************************************************************************************** -class: :class:`CallbackFunction ` +class: :class:`CallbackFunction ` ******************************************************************************************************************** .. autoclass:: CallbackFunction @@ -22,7 +22,7 @@ class: :class:`CallbackFunction ` +class: :class:`JavaScriptClass ` ******************************************************************************************************************** .. autoclass:: JavaScriptClass @@ -40,7 +40,25 @@ class: :class:`JavaScriptClass ` +******************************************************************************************************************** + +.. autoclass:: VariableName + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: VariableName + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/jitter.rst b/docs/api/utility_classes/jitter.rst index d2a805e8..d783adeb 100644 --- a/docs/api/utility_classes/jitter.rst +++ b/docs/api/utility_classes/jitter.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.jitter ` +:mod:`.jitter ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.jitter +.. module:: highcharts_core.utility_classes.jitter ******************************************************************************************************************** -class: :class:`Jitter ` +class: :class:`Jitter ` ******************************************************************************************************************** .. autoclass:: Jitter @@ -22,7 +22,7 @@ class: :class:`Jitter ` .. collapse:: Class Inheritance .. inheritance-diagram:: Jitter - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/markers.rst b/docs/api/utility_classes/markers.rst index aa79739f..85f0de39 100644 --- a/docs/api/utility_classes/markers.rst +++ b/docs/api/utility_classes/markers.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.markers ` +:mod:`.markers ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.markers +.. module:: highcharts_core.utility_classes.markers ******************************************************************************************************************** -class: :class:`Marker ` +class: :class:`Marker ` ******************************************************************************************************************** .. autoclass:: Marker @@ -22,7 +22,7 @@ class: :class:`Marker ` .. collapse:: Class Inheritance .. inheritance-diagram:: Marker - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/menus.rst b/docs/api/utility_classes/menus.rst index 2be661c6..1c74e456 100644 --- a/docs/api/utility_classes/menus.rst +++ b/docs/api/utility_classes/menus.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.menus ` +:mod:`.menus ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.menus +.. module:: highcharts_core.utility_classes.menus ******************************************************************************************************************** -class: :class:`MenuObject ` +class: :class:`MenuObject ` ******************************************************************************************************************** .. autoclass:: MenuObject @@ -22,7 +22,7 @@ class: :class:`MenuObject ` .. collapse:: Class Inheritance .. inheritance-diagram:: MenuObject - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`MenuObject ` ------------------- ******************************************************************************************************************** -class: :class:`MenuItem ` +class: :class:`MenuItem ` ******************************************************************************************************************** .. autoclass:: MenuItem @@ -40,7 +40,7 @@ class: :class:`MenuItem ` .. collapse:: Class Inheritance .. inheritance-diagram:: MenuItem - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/nodes.rst b/docs/api/utility_classes/nodes.rst index ad16aa5c..249022a9 100644 --- a/docs/api/utility_classes/nodes.rst +++ b/docs/api/utility_classes/nodes.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.nodes ` +:mod:`.nodes ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.nodes +.. module:: highcharts_core.utility_classes.nodes ******************************************************************************************************************** -class: :class:`NodeOptions ` +class: :class:`NodeOptions ` ******************************************************************************************************************** .. autoclass:: NodeOptions @@ -22,7 +22,7 @@ class: :class:`NodeOptions .. collapse:: Class Inheritance .. inheritance-diagram:: NodeOptions - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`NodeOptions ---------------- ******************************************************************************************************************** -class: :class:`DependencyWheelNodeOptions ` +class: :class:`DependencyWheelNodeOptions ` ******************************************************************************************************************** .. autoclass:: DependencyWheelNodeOptions @@ -40,7 +40,7 @@ class: :class:`DependencyWheelNodeOptions ` +class: :class:`OrganizationNodeOptions ` ******************************************************************************************************************** .. autoclass:: OrganizationNodeOptions @@ -58,7 +58,7 @@ class: :class:`OrganizationNodeOptions ` +:mod:`.partial_fill ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.partial_fill +.. module:: highcharts_core.utility_classes.partial_fill ******************************************************************************************************************** -class: :class:`PartialFillOptions ` +class: :class:`PartialFillOptions ` ******************************************************************************************************************** .. autoclass:: PartialFillOptions @@ -22,7 +22,7 @@ class: :class:`PartialFillOptions ` +:mod:`.patterns ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.patterns +.. module:: highcharts_core.utility_classes.patterns ******************************************************************************************************************** -class: :class:`Pattern ` +class: :class:`Pattern ` ******************************************************************************************************************** .. autoclass:: Pattern @@ -22,7 +22,7 @@ class: :class:`Pattern ` .. collapse:: Class Inheritance .. inheritance-diagram:: Pattern - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Pattern ` ---------------- ******************************************************************************************************************** -class: :class:`PatternOptions ` +class: :class:`PatternOptions ` ******************************************************************************************************************** .. autoclass:: PatternOptions @@ -40,7 +40,7 @@ class: :class:`PatternOptions ` +:mod:`.position ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.position +.. module:: highcharts_core.utility_classes.position ******************************************************************************************************************** -class: :class:`Position ` +class: :class:`Position ` ******************************************************************************************************************** .. autoclass:: Position @@ -22,7 +22,7 @@ class: :class:`Position ` .. collapse:: Class Inheritance .. inheritance-diagram:: Position - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/api/utility_classes/shadows.rst b/docs/api/utility_classes/shadows.rst index d39b0aeb..0f0d87d4 100644 --- a/docs/api/utility_classes/shadows.rst +++ b/docs/api/utility_classes/shadows.rst @@ -1,5 +1,5 @@ ########################################################################################## -:mod:`.shadows ` +:mod:`.shadows ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.shadows +.. module:: highcharts_core.utility_classes.shadows ******************************************************************************************************************** -class: :class:`ShadowOptions ` +class: :class:`ShadowOptions ` ******************************************************************************************************************** .. autoclass:: ShadowOptions @@ -22,7 +22,7 @@ class: :class:`ShadowOptions ` +:mod:`.states ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.states +.. module:: highcharts_core.utility_classes.states ******************************************************************************************************************** -class: :class:`States ` +class: :class:`States ` ******************************************************************************************************************** .. autoclass:: States @@ -22,7 +22,7 @@ class: :class:`States ` .. collapse:: Class Inheritance .. inheritance-diagram:: States - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`States ` -------------------- ******************************************************************************************************************** -class: :class:`HoverState ` +class: :class:`HoverState ` ******************************************************************************************************************** .. autoclass:: HoverState @@ -40,7 +40,7 @@ class: :class:`HoverState ` .. collapse:: Class Inheritance .. inheritance-diagram:: HoverState - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -48,7 +48,7 @@ class: :class:`HoverState ` ---------------- ******************************************************************************************************************** -class: :class:`InactiveState ` +class: :class:`InactiveState ` ******************************************************************************************************************** .. autoclass:: InactiveState @@ -58,7 +58,7 @@ class: :class:`InactiveState ` +class: :class:`NormalState ` ******************************************************************************************************************** .. autoclass:: NormalState @@ -76,7 +76,7 @@ class: :class:`NormalState ` +class: :class:`SelectState ` ******************************************************************************************************************** .. autoclass:: SelectState @@ -94,7 +94,7 @@ class: :class:`SelectState ` +:mod:`.zones ` ########################################################################################## .. contents:: Module Contents @@ -9,10 +9,10 @@ -------------- -.. module:: highcharts_python.utility_classes.zones +.. module:: highcharts_core.utility_classes.zones ******************************************************************************************************************** -class: :class:`Zone ` +class: :class:`Zone ` ******************************************************************************************************************** .. autoclass:: Zone @@ -22,7 +22,7 @@ class: :class:`Zone ` .. collapse:: Class Inheritance .. inheritance-diagram:: Zone - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | @@ -30,7 +30,7 @@ class: :class:`Zone ` ------------ ******************************************************************************************************************** -class: :class:`ClusterZone ` +class: :class:`ClusterZone ` ******************************************************************************************************************** .. autoclass:: ClusterZone @@ -40,7 +40,7 @@ class: :class:`ClusterZone .. collapse:: Class Inheritance .. inheritance-diagram:: ClusterZone - :top-classes: highcharts_python.metaclasses.HighchartsMeta + :top-classes: highcharts_core.metaclasses.HighchartsMeta :parts: -1 | diff --git a/docs/conf.py b/docs/conf.py index 4aa3a948..8f91fba4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,14 +14,14 @@ version_dict = {} with open(os.path.join(os.path.dirname(__file__), '../', - 'highcharts_python', + 'highcharts_core', '__version__.py')) as version_file: exec(version_file.read(), version_dict) # pylint: disable=W0122 __version__ = version_dict.get('__version__') -project = 'Highcharts for Python' +project = 'Highcharts Core for Python' copyright = '2022, HCP LLC' author = 'Chris Modzelewski' @@ -72,19 +72,19 @@ 'prev_next_buttons_location': 'both' } -html_logo = '_static/highcharts-python-logo-100x50.png' -html_favicon = '_static/highcharts-python-logo-32x32.png' +html_logo = '_static/highcharts-for-python-light-150x149.png' +html_favicon = '_static/highcharts-for-python-dark-32x32.png' html_context = { "display_github": True, # Integrate GitHub - "github_user": "insightindustry", # Username - "github_repo": "highcharts-python", # Repo name + "github_user": "highcharts-for-python", # Username + "github_repo": "highcharts-core", # Repo name "github_version": "master", # Version "conf_py_path": "/docs/", # Path in the checkout to the docs root } -github_username = 'insightindustry' -github_repository = 'highcharts-python' +github_username = 'highcharts-for-python' +github_repository = 'highcharts-core' sphinx_tabs_disable_tab_closing = True diff --git a/docs/contributing.rst b/docs/contributing.rst index 5567cddb..e07f1d9f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -229,7 +229,7 @@ Code Style: Python vs JavaScript Naming Conventions .. include:: using/_code_style_naming_conventions.rst -Standard Methods: :class:`HighchartsMeta ` +Standard Methods: :class:`HighchartsMeta ` ============================================================================================ Every single object supported by the Highcharts JS API corresponds to a Python class in @@ -294,10 +294,10 @@ inheritance, we can reduce the number of properties from about 15,000 to about 1 bad! However, this significant reduction *does* require us to use multiple inheritance in some -cases, paritcularly in the :mod:`.options.series ` +cases, paritcularly in the :mod:`.options.series ` classes (which inherit from both the corresponding type-specific options in -:mod:`.options.plot_options `) *and* from the -generic :class:`SeriesBase ` class). +:mod:`.options.plot_options `) *and* from the +generic :class:`SeriesBase ` class). To solve the :term:`diamond of death` problem, we implemented a number of private helper methods to assist in navigating the MRO: @@ -308,20 +308,20 @@ helper methods to assist in navigating the MRO: * - Method / Function - Purpose - * - :func:`.utility_functions.get_remaining_mro() ` + * - :func:`.utility_functions.get_remaining_mro() ` - Retrieve the class objects that are still to be traversed for a given class' MRO. - * - :func:`.utility_functions.mro__to_untrimmed_dict() ` + * - :func:`.utility_functions.mro__to_untrimmed_dict() ` - Retrieve a consolidated :term:`untrimmed` :class:`dict ` representation from all ancestors of a given class. - * - :meth:`HighchartsMeta._untrimmed_mro_ancestors() ` + * - :meth:`HighchartsMeta._untrimmed_mro_ancestors() ` - Method which consolidates the results of - :meth:`_to_untrimmed_dict() ` + :meth:`_to_untrimmed_dict() ` from a given instance's parent class into a single :class:`dict `. - * - :meth:`HighchartsMeta._to_untrimmed_dict() ` + * - :meth:`HighchartsMeta._to_untrimmed_dict() ` - Generates an :term:`untrimmed` :class:`dict ` representation of the instance at its lowest level in the class hierarchy. Think of this as the "botom of the ladder", with other methods (notably - :meth:`_untrimmed_mro_ancestors() `) + :meth:`_untrimmed_mro_ancestors() `) being used to generate corresponding :class:`dict ` from other rungs on the ladder. @@ -358,21 +358,21 @@ Preparing Your Development Environment In order to prepare your local development environment, you should: -#. Fork the `Git repository `_. +#. Fork the `Git repository `_. #. Clone your forked repository. #. Set up a virtual environment (optional). #. Install development dependencies: .. code-block:: bash - highcharts-python/ $ pip install -r requirements.dev.txt + highcharts-core/ $ pip install -r requirements.dev.txt And you should be good to go! Ideas and Feature Requests ============================ -Check for open `issues `_ +Check for open `issues `_ or create a new issue to start a discussion around a bug or feature idea. Testing @@ -405,8 +405,8 @@ In order to build documentation locally, you can do so from the command line usi .. code-block:: bash - highcharts-python/ $ cd docs - highcharts-python/docs $ make html + highcharts-core/ $ cd docs + highcharts-core/docs $ make html .. caution:: @@ -428,7 +428,7 @@ available at: .. code-block:: bash - highcharts-python/docs/_build/html/index.html + highcharts-core/docs/_build/html/index.html .. note:: diff --git a/docs/errors.rst b/docs/errors.rst index 24406e7b..cece07ea 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -2,7 +2,7 @@ Error Reference ################################## -.. module:: highcharts_python.errors +.. module:: highcharts_core.errors .. contents:: :local: diff --git a/docs/faq.rst b/docs/faq.rst index 23cad377..098db213 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -9,31 +9,65 @@ Frequently Asked Questions ------------------- *********************** -Licensing: +Getting Help +*********************** + +**Where can I get help using Highcharts for Python?** + +This documentation is a great place to start, but we're here to help! + +.. include:: _support.rst + +----------------- + +*********************** +Licensing *********************** **Is the Highcharts for Python toolkit free?** -If you are a student using it for educational purposes, or wish to familiarize yourself -with the library, then yes - you are free to use it without paying. However, if you are -using it for a professional purpose - either to use Highcharts for your work, or to build +If you are evaluating the **Highcharts for Python** toolkit, you are welcome to install and use it free of charge. +However, if you are using it for professional purposes - either to use Highcharts for your work, or to build an application that integrates the library - then you have to pay for both Highcharts JS -itself *and* for **Highcharts for Python**. +itself *and* for **Highcharts for Python**. -**How much does Highcharts for Python cost?** +You can purchase licenses for both from Highsoft A/S at: `https://shop.highcharts.com/ `__. -.. todo:: +**How much does Highcharts for Python cost?** - Add pricing details. +As a paid add-on to the Highcharts JavaScript libraries, the **Highcharts for Python** toolkit is priced at 30% of the price you pay for your **Highcharts** JavaScript license/support contract. **How do I license the Highcharts for Python toolkit?** -.. todo:: - - Add licensing instructions. +Licensing is super easy! You can go to `https://shop.highcharts.com `__ and fill out the +form, and that's it! ---------------------- -.. todo:: +****************************** +Open Source +****************************** + +**Is Highcharts for Python open source?** + +Yes. The **Highcharts for Python** toolkit is open source (but not free - see :ref:`licensing ` above). +You are welcome to review the source code on `Github `__. + +**Can I fork the toolkit?** + +.. warning:: + + Remember that if you fork the library and make modifications to the source code, that means that we will *not* be able to provide support or technical assistance for you should you run into trouble. So you will ultimately depend on + forks at your own risk! + +Yes. You are welcome to fork any of our repositories from `Github `__, +provided that you adhere to the terms of our :doc:`license`. + +.. tip:: + + Bear in mind that if you fork the repository, that does not mean you are allowed to use it for professional purposes. Even if forked, you still need a license to do so. You can purchase a license `here `__. + +**Can I contribute to the Highcharts for Python toolkit?** + +Absolutely! We encourage contributions to the toolkit from the community! For more information, please read our :doc:`Contributor Guide `. - Predict other key questions that might get asked. diff --git a/docs/glossary.rst b/docs/glossary.rst index bc1c8e33..36661c9c 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -13,7 +13,7 @@ Glossary Callback Function A JavaScript function which is passed to `Highcharts JS `__ in the - :class:`HighchartsOptions ` configuration + :class:`HighchartsOptions ` configuration which performs an action which affects the :term:`chart `. Typically, callback functions are used to define @@ -24,7 +24,7 @@ Glossary * :term:`Event Handler` * :term:`Formatter` - * :class:`CallbackFunction ` + * :class:`CallbackFunction ` Cartesian Charts Cartesian charts are :term:`charts` that typically feature two or more axes, by common @@ -52,12 +52,12 @@ Glossary A color axis is an axis on the visualization that represents a value using its color. Typically, :term:`data point` :term:`metric` values are communicated using their position. However, they can also be communicated using the color in which they are - rendered. A :class:`Color Axis ` + rendered. A :class:`Color Axis ` is used to define the relationship between colors and metric values. .. seealso:: - * :class:`Color Axis ` + * :class:`Color Axis ` Data Point A single value that is represented on a :term:`chart `. @@ -69,7 +69,7 @@ Glossary :term:`data point` when user hovers their mouse over the data point. Represented in **Highcharts for Python** by - :class:`highcharts_python.utility_classes.data_labels.DataLabel` and also affected + :class:`highcharts_core.utility_classes.data_labels.DataLabel` and also affected heavily by :meth:`highcharts_stock.options.HighchartsOptions.tooltip`. .. seealso:: @@ -88,8 +88,8 @@ Glossary .. seealso:: - * :class:`DependencyWheelOptions ` - * :class:`DependencyWheelSeries ` + * :class:`DependencyWheelOptions ` + * :class:`DependencyWheelSeries ` Diamond of Death A multiple inheritance pattern that is considered an anti-pattern by the Python @@ -135,13 +135,13 @@ Glossary of the same :term:`metric` grouped by city (within that state/province). In **Highcharts for Python**, the drilldown capabilities are configured using the - :meth:`HighchartsOptions.drilldown ` + :meth:`HighchartsOptions.drilldown ` setting. .. seealso:: - * :meth:`HighchartsOptions.drilldown ` - * :class:`Drilldown ` + * :meth:`HighchartsOptions.drilldown ` + * :class:`Drilldown ` Event Handler A JavaScript function that receives information when an event of some sort has @@ -205,10 +205,10 @@ Glossary .. seealso:: - * :class:`GaugeOptions ` - * :class:`SolidGaugeOptions ` - * :class:`GaugeSeries ` - * :class:`SolidGaugeSeries ` + * :class:`GaugeOptions ` + * :class:`SolidGaugeOptions ` + * :class:`GaugeSeries ` + * :class:`SolidGaugeSeries ` JavaScript Object Literal Notation A way of representing data in JavaScript as native JavaScript objects which is @@ -277,14 +277,14 @@ Glossary classes in your code. In the **Highcharts for Python** toolkit, metaclasses are defined in the - :mod:`.metaclasses ` module, and most inherit from the - :class:`.metaclasses.HighchartsMeta ` + :mod:`.metaclasses ` module, and most inherit from the + :class:`.metaclasses.HighchartsMeta ` class. .. seealso:: - * :mod:`.metaclasses ` - * :class:`HighchartsMeta ` + * :mod:`.metaclasses ` + * :class:`HighchartsMeta ` Metric The value of a measurement. Think of it as a "type" of number. A metric might be @@ -302,7 +302,7 @@ Glossary .. seealso:: - * :meth:`Language.numeric_symbols ` + * :meth:`Language.numeric_symbols ` Network Graph A network graph is a type of relationship chart, where connnections (links) @@ -314,8 +314,8 @@ Glossary .. seealso:: - * :class:`NetworkGraphOptions ` - * :class:`NetworkGraphSeries ` + * :class:`NetworkGraphOptions ` + * :class:`NetworkGraphSeries ` Oscillator @@ -347,8 +347,8 @@ Glossary .. seealso:: - * :class:`PlotBand ` - * :meth:`NumericAxis.plot_bands ` + * :class:`PlotBand ` + * :meth:`NumericAxis.plot_bands ` * :term:`Plot Line` Plot Line @@ -358,8 +358,8 @@ Glossary .. seealso:: - * :class:`PlotLine ` - * :meth:`NumericAxis.plot_lines ` + * :class:`PlotLine ` + * :meth:`NumericAxis.plot_lines ` * :term:`Plot Band` Polar Chart @@ -394,8 +394,8 @@ Glossary .. seealso:: - * :class:`SankeyOptions ` - * :class:`SankeySeries ` + * :class:`SankeyOptions ` + * :class:`SankeySeries ` Series A collection of :term:`data points ` that are expressed using a shared @@ -413,14 +413,14 @@ Glossary and to minimize the amount of code rendered in the page itself. In the **Highcharts for Python** toolkit, shared options are managed through the - :class:`SharedOptions ` + :class:`SharedOptions ` class. .. seealso:: * :doc:`Using Highcharts for Python ` > :ref:`Using Shared Options ` - * :mod:`.global_options.shared_options` - * :class:`SharedOptions ` + * :mod:`.global_options.shared_options` + * :class:`SharedOptions ` SolidGauge A solid gauge is a circular gauge where the value is indicated by a filled arc, @@ -432,26 +432,26 @@ Glossary .. seealso:: - * :class:`SolidGaugeOptions ` - * :class:`SolidGaugeSeries ` + * :class:`SolidGaugeOptions ` + * :class:`SolidGaugeSeries ` Stem - In a :class:`BoxPlotSeries ` + In a :class:`BoxPlotSeries ` or similar, the vertical line extending from the box to the :term:`whiskers `. .. seealso:: - * :class:`BoxPlotSeries ` + * :class:`BoxPlotSeries ` Styled Mode Styled mode is a method of adjusting the look and feel of your Highcharts :term:`charts` using CSS styles as opposed to the explicit configuration in - :class:`HighchartsOptions `. + :class:`HighchartsOptions `. When it is enabled, styling configuration in your options will be ignored in favor of CSS styling. To enable it, set - :meth:`HighchartsOptions.chart.styled_mode ` + :meth:`HighchartsOptions.chart.styled_mode ` to ``True``. .. caution:: @@ -462,7 +462,7 @@ Glossary .. seealso:: - * :meth:`ChartOptions.styled_mode ` + * :meth:`ChartOptions.styled_mode ` Sunburst A Sunburst displays hierarchical data, where a level in the hierarchy is @@ -475,8 +475,8 @@ Glossary .. seealso:: - * :class:`SunburstOptions ` - * :class:`SunburstSeries ` + * :class:`SunburstOptions ` + * :class:`SunburstSeries ` Technical Indicator @@ -542,16 +542,16 @@ Glossary .. seealso:: - * :class:`VennOptions ` - * :class:`VennSeries ` + * :class:`VennOptions ` + * :class:`VennSeries ` Whisker - In a :class:`BoxPlotSeries ` + In a :class:`BoxPlotSeries ` or similar, the horizontal lines marking low and high values .. seealso:: - * :class:`BoxPlotSeries ` + * :class:`BoxPlotSeries ` Wordcloud A word cloud is a visualization of a set of words, where the size and placement of @@ -563,8 +563,8 @@ Glossary .. seealso:: - * :class:`WordcloudOptions ` - * :class:`WordcloudSeries ` + * :class:`WordcloudOptions ` + * :class:`WordcloudSeries ` ---------- diff --git a/docs/index.rst b/docs/index.rst index 0c6f556b..b823bb39 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,11 @@ -.. image:: _static/highcharts-python-logo.png +.. image:: _static/highcharts-for-python-light-150x149.png :alt: Highcharts for Python - High-end Data Visualization for the Python Ecosystem :align: right - :width: 200 - :height: 100 + :width: 150 + :height: 149 | +| ################################################### Highcharts for Python Toolkit @@ -12,21 +13,11 @@ Highcharts for Python Toolkit **High-end data visualization for the Python ecosystem** -.. sidebar:: Version Compatibility - - **Highcharts for Python** is designed to be compatible with: - - * Python 3.9 or higher, - * Highcharts JS 10.2 or higher, - * Jupyter Notebook 6.4 or higher, - * Pandas 1.3 or higher - * PySpark 3.3 or higher - .. include:: _unit_tests_code_coverage.rst .. toctree:: :hidden: - :maxdepth: 6 + :maxdepth: 3 :caption: Contents Home @@ -37,11 +28,23 @@ Highcharts for Python Toolkit Using Highcharts for Python API Reference Error Reference + Getting Help Contributor Guide Testing Reference Release History Glossary - Licensing + License + +.. sidebar:: Version Compatibility + + **Highcharts Core for Python** is designed to be compatible with: + + * Python 3.10 or higher, + * Highcharts JS 10.2 or higher, + * Jupyter Notebook 6.4 or higher, + * IPython 8.10 or higher, + * Pandas 1.3 or higher + * PySpark 3.3 or higher The **Highcharts for Python Toolkit** is a Python library that provides a Python wrapper for the fantastic `Highcharts JS `__ suite of JavaScript data @@ -230,7 +233,7 @@ Hello World, and Basic Usage .. code-block:: python # Import SharedOptions - from highcharts_python.global_options.shared_options import SharedOptions + from highcharts_core.global_options.shared_options import SharedOptions # from a JavaScript file my_global_settings = SharedOptions.from_js_literal('my_js_literal.js') @@ -250,8 +253,8 @@ Hello World, and Basic Usage .. code-block:: python - from highcharts_python.options.title import Title - from highcharts_python.options.credits import Credits + from highcharts_core.options.title import Title + from highcharts_core.options.credits import Credits # Using dicts my_chart.title = { @@ -279,8 +282,8 @@ Hello World, and Basic Usage } # Using direct objects - from highcharts_python.options.title import Title - from highcharts_python.options.credits import Credits + from highcharts_core.options.title import Title + from highcharts_core.options.credits import Credits my_title = Title(text = 'The Title for My Chart', floating = True, align = 'center') my_chart.options.title = my_title @@ -330,12 +333,11 @@ that will render the chart wherever it is you want it to go: -------------- -********************* -Questions and Issues -********************* +*********************** +Getting Help/Support +*********************** -You can ask questions and report issues on the project's -`Github Issues Page `_ +.. include:: _support.rst ----------------- diff --git a/docs/license.rst b/docs/license.rst index e7ca79b6..7f94e56b 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,7 +1,236 @@ -######################################### -License for Highcharts for Python -######################################### +####################################################################### +Terms and Conditions for the Highcharts for Python Toolkit License +####################################################################### -.. todo:: +.. warning:: - Add details on the licensing terms for **Highcharts for Python**. + The **Highcharts for Python** toolkit as a whole, and the **Highcharts Core for Python** library specifically, + are made available subject to a *paid* commercial license. This means that while the code is open-source, in order + to use it you **must** purchase a license from `Highsoft A/S `__, the + creators of the Highcharts JavaScript library. + + **TO PURCHASE A LICENSE:** `https://shop.highcharts.com/ `__ + +*********************************************** +1. Acceptance of the Terms and Conditions +*********************************************** + +These terms and conditions (the “Wrapper T&Cs”) shall apply to Licensee’s license to and use of the Wrapper (as defined below), a complementary product to the Software owned and delivered by Highsoft AS (“Highsoft”). The Wrapper is owned by HCP LLC (“HCP”) and distributed by Highsoft AS or its partners, resellers or distributors, and these Wrapper T&Cs shall apply to the Licensee’s usage of the Wrapper irrespective of which license type(s) to the Software the Licensee has subscribed to or purchased from Highsoft. + +By installing or using the Wrapper or any part thereof, Licensee agrees to be bound by these Wrapper T&Cs, unless Licensee is using the Software and the Wrapper for evaluation purposes authorized by Highsoft, i.e. during a trial period. + +Without prejudice to the limited right to download and test the Wrapper for evaluation prior to the purchase of a Wrapper License, Licensee is not authorized to install or use the Wrapper unless Licensee pays the applicable Wrapper Fee and fully agrees to all terms and conditions set forth herein and to any terms set forth in related licensing agreements or terms from Highsoft to which these Wrapper T&Cs constitute an addendum. + +*********************************************** +2. Relationship to the Main Agreement +*********************************************** + +A Wrapper License (as defined below) or renewal thereof can only be purchased by a Licensee either already holding a License to the Software, or at the same time as purchasing such a License, as an add-on product to such License, and only by a Licensee holding an active and valid enrolment in the Highcharts Advantage plan. The purchase of, and right to use the Licensed Software shall remain governed by the terms and conditions of the License issued by Highsoft to Licensee, whether this is Highsoft Standard License Agreement, Highsoft Terms and Conditions for Subscription to Annual License to Highsoft Software, or another licensing agreement as agreed between Highsoft and Licensee, as applicable (such terms and conditions between Highsoft and Licensee hereinafter collectively referred to as the “Main Agreement”). + +These Wrapper T&Cs constitute an addendum to the Main Agreement and an integral part thereof and apply to the use of the Wrapper only. + +In the case of any discrepancy between the Main Agreement and these Wrapper T&Cs related to the licensing of the Wrapper, these Wrapper T&Cs shall prevail. + +*********************************************** +3. Definitions +*********************************************** + +Unless otherwise defined below or elsewhere in these Wrapper T&Cs, all capitalized terms used but not otherwise defined herein shall have the same definitions as set out in the Main Agreement. + + * **Agreement** shall mean the Main Agreement, these Wrapper T&Cs and the License Statement; + * **Delivery Date** shall mean the date Licensee is invoiced by Highsoft for the Wrapper License, which will + correspond to the Delivery Date for the Software if purchased together, or at a separate time, if purchased as an + add-on to an existing License; + * **HCP** shall mean HCP LLC, the company behind the Wrapper, a US limited liability corporation registered in the + state of Delaware, with its registered office at 867 Boylston Street, 5th Floor #1674, Boston, MA 02116, United + States.Licensee shall mean the legal entity to which the License (to the Licensed Software) and the Wrapper License + has been granted, as expressly stated in the License Statement; + * **Licensors** shall mean Highsoft and/or HCP collectively; + * **Wrapper** shall mean the proprietary software products distributed by Highsoft and owned by HCP, including + Highcharts for Python – the main product included in all licenses – in addition to Highcharts Stock for Python, + Highcharts Maps for Python, Highcharts Gantt for Python, and other optional additional products or libraries which + may be developed by HCP and offered within the Wrapper by Highsoft. + * **Wrapper** Fee shall mean the fee payable by Licensee to Highsoft for the Wrapper License and for the right to + receive the support services provided by HCP under these Wrapper T&Cs ; + * **Wrapper License** shall mean the right to use the Wrapper in accordance with the Agreement and as set out herein, + whether granted as a perpetual license or in the form of a time-limited subscription (subject to renewal), and as + one or more of the license types as defined in the Main Agreement; + * **Wrapper Term** shall have the meaning set out in section 7. + +*********************************************** +4. Ownership and Copyright +*********************************************** + +The Wrapper is the property of HCP and is protected by copyright law as well as other statutory and non-statutory intellectual property law. All title and copyrights in and to the Wrapper are and shall remain owned fully and solely by HCP. + +Under the Agreement, the Wrapper is licensed to Licensee by Highsoft on behalf of HCP, not sold. + +The Licensors reserve all rights not expressly granted to Licensee under the Agreement. Without limiting the generality of the foregoing, Licensee acknowledges and agrees that: (a) except as specifically set forth herein, the Licensors retains all right, title and interest in and to the Wrapper and the Software, and Licensee does not acquire any right, title or interest to the Wrapper or the Software except as set forth herein; (b) any configuration or deployment of the Wrapper or the Software shall not affect or diminish the Licensor’s rights, title or interest in and to the Wrapper or the Software. The Agreement shall not limit in any way the Licensor’s right to develop, use, license, create derivative works of, or otherwise exploit the Wrapper or the Software, or to permit Third Parties to do so. + +The Licensors acknowledge and agree that (i) Licensee retains all rights, title and interest in and to any Licensee-owned software, and the Licensors do not acquire any right, title, or interest in or to such application; and (ii) any integration of the Wrapper with a Licensee-owned application shall not affect or diminish Licensee’s rights, title, and interest in and to such application. + +*********************************************** +5. Grant of License +*********************************************** + +Subject to Licensee’s full payment of the Wrapper Fee, Highsoft grants to Licensee a right to use the Wrapper during the Wrapper Term (as defined in Section 7 below), on the same terms and conditions as set forth in the Main Agreement and the License Statement as modified by these Wrapper T&Cs. The Main Agreement shall apply accordingly to the Wrapper License insofar as the terms and conditions therein are applicable, whereas all references to the “Licensed Software” in the Main Agreement shall for the purposes of these Wrapper T&Cs to the extent applicable be deemed to include the Wrapper. + +The License type(s) chosen by Licensee for the Licensed Software shall apply to the Wrapper License, and depending on the purchased License type(s), as stated in the Licensed Statement, the relevant section in the Main Agreement detailing the usage rights and limitations for the License shall apply similarly to the Wrapper License. + +The rights granted to Licensee under the Agreement, is strictly limited to the usage rights granted under the chosen License type and with the scope as stated in the License Statement. The number of authorized Developers included in the Wrapper License is the same as the number of authorized Developers included in the License, as set out in the License Statement. The Wrapper may only be used in such Web Application(s), SaaS Application(s) and/or Licensee Product(s) as expressly identified in the License Statement. + +A Wrapper License shall include the components of the Wrapper which correspond to the Licensed Software to which Licensee holds a valid License, i.e. a Wrapper License purchased for Highcharts Stock shall include the Highcharts for Python software and all component libraries needed to implement the Highcharts Stock for Python library, and a Wrapper License purchased for Highcharts Maps shall include the Highcharts for Python software and all component libraries needed to implement the Highcharts Maps for Python, etc. + +5.1 General Grants and Limitations +======================================== + +The Wrapper License includes the support services provided by HCP set forth in Section 6 below. +Irrespective of the chosen License type, the Wrapper License and any support services for the Wrapper shall be subject to renewal, and contingent upon Licensee’s continued enrollment in the Highcharts Advantage plan, as set out in section 7. + +Licensee may obtain the Wrapper source code by downloading the source code from the Highsoft Website or from Github or equivalent source code repository made available by HCP, by downloading and installing the source code from a public repository such as PyPi, and make its own edits, and keep its own repositories with the modified source code; provided, however, any such modifications shall be at Licensee’s own risk and shall void any support obligation of HCP hereunder. + +Licensee shall not modify, delete or obscure any notices of proprietary rights or any Wrapper identification or restrictions on or in the Wrapper found in the source code. + +*********************************************** +6. Wrapper Support +*********************************************** + +A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee’s valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP. + +All support inquiries related to the Wrapper shall be sent to support@highchartspython.com or filed at https://www.highchartspython.com. + +Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP: + + i. All new releases or updates of the Wrapper released during the applicable Advantage Period; + ii. Up to ten (10) hours of the personalized technical support for the Wrapper and/or the Licensed Software + (combined) per Developer per Support Year based on the number of Developers stated in the License Statement for + the License. Licensee may freely distribute its included total of ten (10) hours of personalized technical + support between support of the Wrapper and support of the Licensed Software; + iii. Technical support by e-mail; + iv. Priority response; + v. Access to 2nd line support for the Wrapper by core developers; + vi. Online text chat with 1st line support Wrapper engineers; + vii. Investigation of any claimed bug/error/malfunction/nonfunctioning of the Wrapper, and when possible, + suggestions as to corrective or work-around solutions to the problems; + viii. Supply of emergency hot fixes to the Wrapper; + ix. Guidance and advice on implementing the Wrapper with the Software, as well as with any third-party systems and + platforms to the extent such implementation is authorized by Highsoft. The guidance and advice shall include + advice on best practices, limited code review, and guidance on parts of the code that are directly related to + using the Wrapper with the Software; + x. Any bug and error fixing, malfunctioning of the Wrapper is to be delivered outside the personalized technical + support hours. + +Licensee is responsible for downloading and installing major version releases and updates of the Wrapper during the applicable Advantage Period. During each Advantage Period in which Licensee is validly enrolled in Highcharts Advantage, HCP will provide support for the current version and last major version releases of the Wrapper. For the avoidance of doubt, HCP shall have no obligation to provide support for any version of the Wrapper released prior to the major version release which immediately preceded the then current major version release of the Wrapper. + +The support services as set forth in this section (i) do not cover issues arising in connection with implementation of the Wrapper or Licensed Software in/to Licensee Products or Licensee’s own applications or to the Wrapper as modified by Licensee, and (ii) shall not extend to any Third Parties to which Licensee distributes Licensee Products, SaaS Application(s) or Web Application(s) containing the Wrapper, Licensed Software or any part thereof. Support to any Licensee customers shall hence be Licensee’s full and sole responsibility. The Licensors may, at its sole discretion, at any time choose to discontinue the supply of new Releases of the Wrapper. + +*********************************************** +7. Term and Renewal +*********************************************** + +The term of the Wrapper License (the ”Wrapper Term”) shall correspond to the Initial Term of the License as indicated in the License Statement issued by Highsoft, and the provisions of the Main Agreement pertaining to the terms and conditions on the Term and Renewal of the License shall apply similarly to the Wrapper License; provided, however, in all cases, the support services set forth in Section 6 above are co-terminus with and contingent upon the Licensee’s enrollment in the Highsoft Advantage Plan as set forth in the applicable Main Agreement, including any renewal thereof, and payment of the corresponding Wrapper Fee. + +During the term of the Wrapper License, the Wrapper shall be made available by the Licensors and Licensee shall be authorized to download the Wrapper from the Highsoft Website, from Github or comparable source code repository maintained by HCP, or from a public Python library repository such as PyPi. + +*********************************************** +8. Termination +*********************************************** + +The termination and expiration provisions in the Main Agreement shall apply similarly to the Agreement, and a termination or expiration of the Main Agreement, however occasioned, shall be construed as, and entail a termination of this Agreement. + +*********************************************************** +9. Annual License Fee, Renewal Fee, and Payment Terms +*********************************************************** + +Licensee shall upon purchase of the Wrapper License pay the applicable Wrapper License Fee as determined by Highsoft, subject to the provisions on payment of the License Fee and Highcharts Advantage Fee as set out in the Main Agreement. +For avoidance of doubt, the Wrapper License and accompanying rights including any subsequent renewals is granted to Licensee on the condition that all the due fees are paid to Highsoft in full and on time. + +*********************************************************** +10. Warranties and Representations +*********************************************************** + +10.1 Scope +================= + +All warranties and representations given herein are provided by HCP, and HCP’s warranties and representations in this section 10 are limited to the Wrapper provided to Licensee under the Agreement. + +10.2 HCP’s Warranties and Representations +=============================================== + +HCP warrants and represents that: + + i. For a period of ninety (90) days following its Delivery Date, the Wrapper will perform substantially in + accordance with HCP’s written specifications, provided that it has been used in accordance with all documentation + and specifications made available on Highsoft's Website and not modified by Licensee, + ii. HCP will perform its obligations under the Wrapper License and these Wrapper T&Cs in accordance with all + applicable laws and regulations, + iii. HCP has the full and unconditional ownership of the Wrapper, + iv. The Wrapper does not infringe intellectual property rights of any Third Party, + v. When installed in accordance with HCP’s written specifications, Third Party Dependencies, defined as software on + which the Wrapper relies that has been developed and made available by Third Parties, shall be installed. HCP + warrants that at the time of the Wrapper’s Release, such software was available for public distribution in + accordance with its applicable licenses and its bundling with the Wrapper is fully compliant with the licenses of + any and all such Third Party Dependencies. The Licensee can review the details of all such Third Party + Dependencies, including their relevant licensing provisions, by reviewing the Wrapper documentation made + available on Highsoft’s Website. + vi. HCP has the requisite knowledge, personnel, resources and know-how to fully perform and deliver the Wrapper and + associated services as stipulated by these Wrapper T&Cs in a professional manner, + vii. HCP has not intentionally placed and will use its best efforts to avoid the placement of any Harmful Codes into + the Wrapper provided under the Wrapper License. For the purpose of this section 10.2, "Harmful Codes" is + defined as any program that infects, damages and/or impairs another program or data, disables hardware or + software, or permits or assists in the breach of data. + +10.3 Licensee’s Remedies +============================= + +In the event of a breach, or alleged breach of any of the warranties in section 10.2, Licensee shall promptly notify either HCP or Highsoft and delete the Wrapper. Licensee’s sole remedy in such an event shall be that HCP shall re-supply or correct the Wrapper so that it operates according to the warranties set out in section 10.2. The warranties shall not apply if Licensee has modified, or used the Wrapper improperly, or on an operating environment not approved by HCP. Improper use and unapproved operating environments will be as set forth in the documentation provided to Licensee on or prior to Delivery Date. + +*********************************************************** +11. Limitation of Liability +*********************************************************** + +11.1 Highsoft +=================== + +The Licensee understands and accepts that the Wrapper is provided by Highsoft as an Official Wrapper, and are hence not covered by the Warranties and Representations included in the Main Agreement, and is provided “as is” by Highsoft and may have errors and omissions. Highsoft disclaims any and all liability for the Wrapper or Licensee’s usage of or reliance on the Wrapper, and makes no warranties, express or implied, including but not limited to, warranties of merchantability, fitness for purpose, performance, accuracy, or non-infringing nature. + +11.2 HCP +================== + +The Wrapper and all related support services supplied by HCP are provided ‘as is’ and may have errors and omissions. Thus, remedies are only available to Licensee in the event of any breach of the warranties set out in section 10. + +UNDER NO CIRCUMSTANCES, AND EVEN IF INFORMED THEREOF BY LICENSEE OR ANY OTHER PARTY, WILL THE LICENSORS BE LIABLE UNDER OR IN CONNECTION WITH A CLAIM RELATING TO THESE WRAPPER T&CS OR ITS SUBJECT MATTER FOR (i) LOSS OF, OR DAMAGE TO, DATA; (ii) SPECIAL, INCIDENTAL, CONSEQUENTIAL OR INDIRECT DAMAGES; OR (iii) LOST PROFITS, BUSINESS, REVENUE, GOODWILL, OR ANTICIPATED SAVINGS. + +Incorporation of the Wrapper into any application as further described in the Main Agreement shall not in any manner expand HCP’s liabilities under the Annual Wrapper License. Thus, HCP shall not under any circumstance be neither responsible nor liable for any aspects of such Licensee application(s), including but not limited to its reliability, uptime/downtime, functioning or fitness for purpose. Any obligations, liabilities or warranties undertaken by Licensee towards its customers with respect to such application(s) shall apply only between mentioned parties, and Licensee hereby undertakes to indemnify and hold the Licensors harmless from and against any and all losses, clams and damages related to such application(s). + +IN NO EVENT WILL THE LIABILITY OF THE LICENSORS UNDER OR IN CONNECTION WITH THESE WRAPPER T&CS OR ITS SUBJECT MATTER, UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE, EXCEED THE TOTAL WRAPPER FEE PAID BY THE LICENSEE DURING THE LAST TWELVE (12) MONTHS PRIOR TO OCCURRENCE GIVING CAUSE TO SUCH LIABILITY. + +*********************************************************** +12. Confidentiality +*********************************************************** + +As a trusted partner of Highsoft, HCP is bound by the confidentiality provisions of the Main Agreement, which shall apply similarly for the Wrapper T&Cs, and Licensee hereby grants to Highsoft the explicit right to share Confidential Information with HCP as needed. + +*********************************************************** +13. Applicable Law and Venue +*********************************************************** + +The construction, validity and operation of the Wrapper License and these Wrapper T&Cs, and the performance of all obligations hereunder, shall be governed by and construed in accordance with the laws of the Commonwealth of Massachusetts, United States of America, without regard to conflict of law principles that would result in the application of any law other than the law of the Commonwealth of Massachusetts. + +In the event of a dispute, controversy or claim between Licensee and HCP arising out of or relating to the Wrapper License and these Wrapper T&Cs, or the breach, termination, or invalidity thereof the Parties shall meet in an effort to resolve such dispute, controversy or claim amicably through negotiation. If the Parties do not reach an amicable solution within two (2) weeks of such efforts being initiated, either Party may initiate legal proceedings in the United States federal courts and state courts located in the Commonwealth of Massachusetts, which courts shall have sole and exclusive jurisdiction and venue to adjudicate any such dispute, controversy or claim. The Parties consent to the exclusive jurisdiction of the courts specified above, and expressly waive any objection to the jurisdiction or convenience of such courts. + +Any dispute, controversy or claim between Licensee and Highsoft, shall be resolved in accordance with the provisions of the Main Agreement. + +*********************************************************** +14. Processing of Personal Data +*********************************************************** + +To the extent the purchase of the Wrapper License involves processing by either Highsoft and/or HCP of personal data about the Licensee or Licensee’s customers or personnel related to the purchase of the Wrapper License, Highsoft and HCP shall be acting as joint and independent data controllers. The provisions of the Main Agreement pertaining to Highsoft’s processing of personal data shall apply similarly to any processing by Highsoft of personal data in relation to the Agreement. + +To the extent the support services performed by HCP under this Agreement involves processing by HCP of personal data about the Licensee or Licensee’s customers or personnel, HCP shall be acting as a data controller. + +*********************************************************** +15. Miscellaneous +*********************************************************** + +The provisions of the Main Agreement entitled “Miscellaneous” shall apply similarly to these Wrapper T&Cs, as applicable. diff --git a/docs/support.rst b/docs/support.rst new file mode 100644 index 00000000..539b4765 --- /dev/null +++ b/docs/support.rst @@ -0,0 +1,5 @@ +############################################### +Support for Highcharts for Python +############################################### + +.. include:: _support.rst \ No newline at end of file diff --git a/docs/toolkit.rst b/docs/toolkit.rst index 36c7c2fa..5c99055e 100644 --- a/docs/toolkit.rst +++ b/docs/toolkit.rst @@ -7,8 +7,8 @@ The Toolkit's Contents **************************** The **Highcharts for Python** toolkit features a number of separate Python -libraries which extend the core **Highcharts for Python** (``highcharts-python``) library. -This pattern actually maps quite naturally to the Highcharts JS design, where multiple +libraries which extend the core **Highcharts Core for Python** (``highcharts-core``) library. +This pattern maps quite naturally to the Highcharts JS design, where multiple other modules extend the core Highcharts JS library. The **Highcharts for Python** toolkit includes two categories of tools: @@ -18,24 +18,30 @@ The **Highcharts for Python** toolkit includes two categories of tools: .. tab:: Core Visualization Libraries These libraries correspond to each of the major Highcharts - `products `_: + `products `__: - * **Highcharts for Python**: This is the foundational Python library, and is required + * **Highcharts Core for Python**: This is the foundational Python library, and is required by all other components in the toolkit. It provides the fundamental Python classes that are used throughout the toolkit, and importantly provides 100% coverage for the functionality in the - `Highcharts JS `_ JavaScript + `Highcharts Core `__ JavaScript library. * **Highcharts Stock for Python**: This is the Python wrapper for the - `Highcharts Stock `_ + `Highcharts Stock `__ JavaScript library, which provides extensive visualizations for time series and stock price visualizations. For more details, please see the relevant - `Highcharts Stock for Python documentation `_ + `Highcharts Stock for Python documentation `__ * **Highcharts Maps for Python**: This is the Python wrapper for the - `Highcharts Maps `_ + `Highcharts Maps `__ JavaScript library, which provides extensive geographic data visualization options with rich interactive maps. For more details, please see the relevant - `Highcharts Maps for Python documentation `_ + `Highcharts Maps for Python documentation `__ + * **Highcharts Gantt for Python**: This is the Python wrapper for the + `Highcharts Gantt `__ + JavaScript library, which provides rich visualizations for resource allocation over + time. For more details, please see the relevant + `Highcharts Gantt for Python documentation `__ + .. tab:: Extensions @@ -45,25 +51,7 @@ The **Highcharts for Python** toolkit includes two categories of tools: .. note:: - The libraries below are in-progress, but have not yet been released. - - * **Highcharts Gantt for Python**: This is the Python wrapper for the - `Highcharts Gantt `_ - JavaScript library, which provides rich visualizations for resource allocation over - time. For more details, please see the relevant - `Highcharts Gantt for Python documentation `_ - * **Highcharts for Dash**: This is a set of components for the - `Dash `_ data visualization framework which makes it easy - to use Highcharts visualizations in your Dash dashboards. For more details, please - see the relevant `Highcharts for Dash documentation `_. - * **Flask-Highcharts**: This is an extension to the Flask microframework which makes - integrating Highcharts visualizations into Flask views super simple. For more - details, please see the relevant - `Flask-Highcharts documentation `_. - * **Highcharts for Django**: This is an extension to the Django web framework which - makes utilizing Highcharts visualizations in your Django application super simple. - For more details, please see the - `Highcharts for Django documentation `_. + A number of extension libraries are in progress, but have not yet been released. Watch this space for news soon! .. note:: @@ -85,7 +73,11 @@ project project repo, the lists below provides some high-level information. .. tab:: Core Visualization Libraries - * Support for Explicit Defaults ( :issue:`1` ). Currently, Highcharts default values + * Needed Script Tags ( :issue:`12` ). It would be helpful for **Highcharts for Python** + to support the production of the relevant ``' + container = container or self.container or 'highcharts_target_div' + + container_str = f"""
\n""" + + return container_str - html_str = container_str + script_str + def _repr_html_(self): + """Produce the HTML representation of the chart. - return html_str + .. note:: + + Currently includes *all* `Highcharts JS `_ modules + in the HTML. This issue will be addressed when roadmap issue :issue:`2` is + released. + + :returns: The HTML representation of the chart. + :rtype: :class:`str ` + """ + return self.display() @property def callback(self) -> Optional[CallbackFunction]: @@ -201,30 +281,32 @@ def to_js_literal(self, container_as_str = '' if self.container: - container_as_str = f"""renderTo = '{self.container}'""" - signature_elements += 1 + container_as_str = f"""'{self.container}'""" + else: + container_as_str = """null""" + signature_elements += 1 options_as_str = '' if self.options: options_as_str = self.options.to_js_literal(encoding = encoding) - options_as_str = f"""options = {options_as_str}""" - signature_elements += 1 + options_as_str = f"""{options_as_str}""" + else: + options_as_str = """null""" + signature_elements += 1 callback_as_str = '' if self.callback: callback_as_str = self.callback.to_js_literal(encoding = encoding) - callback_as_str = f"""callback = {callback_as_str}""" + callback_as_str = f"""{callback_as_str}""" signature_elements += 1 signature = """new Highcharts.chart(""" - if container_as_str: - signature += container_as_str - if signature_elements > 1: - signature += ',\n' - if options_as_str: - signature += options_as_str - if signature_elements > 1: - signature += ',\n' + signature += container_as_str + if signature_elements > 1: + signature += ',\n' + signature += options_as_str + if signature_elements > 1: + signature += ',\n' if callback_as_str: signature += callback_as_str signature += ');' @@ -348,11 +430,14 @@ def _copy_dict_key(cls, if key == 'data' and preserve_data: return other_value - elif key == 'points' and preserve_data: + + if key == 'points' and preserve_data: return other_value - elif key == 'series' and preserve_data: + + if key == 'series' and preserve_data: if not other_value: return [x for x in original_value] + if len(other_value) != len(original_value): matched_series = [] new_series = [] @@ -403,16 +488,16 @@ def _copy_dict_key(cls, new_value = [x for x in original_value] return new_value - else: - return other_value + + return other_value elif other_value and not overwrite: return other_value - else: - return original_value + + return original_value def copy(self, - other, + other = None, overwrite = True, **kwargs): """Copy the configuration settings from this chart to the ``other`` chart. @@ -440,21 +525,21 @@ def copy(self, :returns: A mutated version of ``other`` with new property values """ - super().copy(other, + super().copy(other = other, overwrite = overwrite, **kwargs) def add_series(self, *series): """Adds ``series`` to the - :meth:`Chart.options.series ` + :meth:`Chart.options.series ` property. :param series: One or more :term:`series` instances (descended from - :class:`SeriesBase `) or an + :class:`SeriesBase `) or an instance (e.g. :class:`dict `, :class:`str `, etc.) coercable to one :type series: one or more - :class:`SeriesBase ` + :class:`SeriesBase ` or coercable """ @@ -475,17 +560,69 @@ def add_series(self, *series): self.options.series = updated_series + def update_series(self, *series, add_if_unmatched = False): + """Replace existing series with the new versions supplied in ``series``, + matching them based on their + :meth:`.id ` property. + + :param series: One or more :term:`series` instances (descended from + :class:`SeriesBase `) or an + instance (e.g. :class:`dict `, :class:`str `, etc.) + coercable to one + :type series: one or more + :class:`SeriesBase ` + or coercable + + :param add_if_unmatched: If ``True``, will add a series that does not have a + match. If ``False``, will raise a + :exc:`HighchartsMissingSeriesError ` + if a series does not have a match on the chart. Defaults to ``False``. + :type add_if_unmatched: :class:`bool ` + """ + new_series = [] + for item in series: + item_series = create_series_obj(item) + new_series.append(item_series) + + if self.options and self.options.series: + existing_series = [x for x in self.options.series] + elif self.options: + existing_series = [] + else: + existing_series = [] + self.options = HighchartsOptions() + + existing_ids = [x.id for x in existing_series] + new_ids = [x.id for x in new_series] + overlap_ids = [x for x in new_ids if x in existing_ids] + + updated_series = [] + for existing in existing_series: + if existing.id not in overlap_ids: + updated_series.append(existing) + + for new in new_series: + if new.id not in overlap_ids and not add_if_unmatched: + raise errors.HighchartsMissingSeriesError(f'attempted to update series ' + f'id "{new.id}", but that ' + f'series is not present in ' + f'the chart') + + updated_series.append(new) + + self.options.series = updated_series + @classmethod def from_series(cls, *series, kwargs = None): - """Creates a new :class:`Chart ` instance populated + """Creates a new :class:`Chart ` instance populated with ``series``. :param series: One or more :term:`series` instances (descended from - :class:`SeriesBase `) or an + :class:`SeriesBase `) or an instance (e.g. :class:`dict `, :class:`str `, etc.) coercable to one :type series: one or more - :class:`SeriesBase ` + :class:`SeriesBase ` or coercable :param kwargs: Other properties to use as keyword arguments for the instance to be @@ -494,20 +631,30 @@ def from_series(cls, *series, kwargs = None): .. warning:: If ``kwargs`` sets the - :meth:`options.series ` + :meth:`options.series ` property, that setting will be *overridden* by the contents of ``series``. :type kwargs: :class:`dict ` - :returns: A new :class:`Chart ` instance - :rtype: :class:`Chart ` + :returns: A new :class:`Chart ` instance + :rtype: :class:`Chart ` """ kwargs = validators.dict(kwargs, allow_empty = True) or {} instance = cls(**kwargs) - instance.add_series(series) + if checkers.is_iterable(series) is True: + for item in series: + instance.add_series(item) + else: + instance.add_series(series) + + return instance - def display(self, global_options = None): + def display(self, + global_options = None, + container = None, + retries = 3, + interval = 1000): """Display the chart in `Jupyter Labs `_ or `Jupyter Notebooks `_. @@ -515,29 +662,49 @@ def display(self, global_options = None): Defaults to :obj:`None ` :type global_options: :class:`SharedOptions ` or :obj:`None ` + + :param container: The ID to apply to the HTML container when rendered in Jupyter Labs. Defaults to + :obj:`None `, which applies the :meth:`.container ` + property if set, and ``'highcharts_target_div'`` if not set. + :type container: :class:`str ` or :obj:`None ` + + :param retries: The number of times to retry rendering the chart. Used to avoid race conditions with the + Highcharts script. Defaults to 3. + :type retries: :class:`int ` + + :param interval: The number of milliseconds to wait between retrying rendering the chart. Defaults to 1000 (1 + seocnd). + :type interval: :class:`int ` :raises HighchartsDependencyError: if `ipython `_ is not available in the runtime environment """ try: - from IPython import display + from IPython import display as display_mod + from IPython.core.display_functions import display except ImportError: - raise errors.HighchartsDependencyError('Unable to import IPython.display. ' + raise errors.HighchartsDependencyError('Unable to import IPython modules. ' 'Make sure that it is available in ' 'your runtime environment. To install,' 'use: pip install ipython') - if global_options is not None: - global_options = validate_types(global_options, - types = SharedOptions) + include_js_str = self._jupyter_include_scripts() + include_display = display_mod.Javascript(data = include_js_str) - html_str = constants.INCLUDE_STR + '\n' - if global_options: - html_str += global_options._repr_html_() + '\n' - html_str += self._repr_html_() + container = container or self.container or 'highcharts_target_div' + html_str = self._jupyter_container_html(container) + html_display = display_mod.HTML(data = html_str) - display.display_html(html_str, raw = True) + chart_js_str = self._jupyter_javascript(global_options = global_options, + container = container, + retries = retries, + interval = interval) + javascript_display = display_mod.Javascript(data = chart_js_str) + + display(include_display) + display(html_display) + display(javascript_display) @classmethod def from_csv(cls, @@ -555,13 +722,13 @@ def from_csv(cls, wrap_all_strings = False, double_wrapper_character_when_nested = False, escape_character = "\\"): - """Create a new :class:`Chart ` instance with + """Create a new :class:`Chart ` instance with data populated from a CSV string or file. .. note:: For an example - :class:`LineSeries `, the + :class:`LineSeries `, the minimum code required would be: .. code-block:: python @@ -699,9 +866,9 @@ def from_csv(cls, which is Python's native escape character). :type escape_character: :class:`str ` - :returns: A :class:`Chart ` instance with its + :returns: A :class:`Chart ` instance with its data populated from the CSV data. - :rtype: :class:`Chart ` + :rtype: :class:`Chart ` :raises HighchartsCSVDeserializationError: if ``property_column_map`` references CSV columns by their label, but the CSV data does not contain a header row @@ -746,7 +913,7 @@ def from_pandas(cls, series_kwargs = None, options_kwargs = None, chart_kwargs = None): - """Create a :class:`Chart ` instance whose + """Create a :class:`Chart ` instance whose data is populated from a `pandas `_ :class:`DataFrame `. @@ -799,9 +966,9 @@ def from_pandas(cls, :type chart_kwargs: :class:`dict ` or :obj:`None ` - :returns: A :class:`Chart ` instance with its + :returns: A :class:`Chart ` instance with its data populated from the data in ``df``. - :rtype: :class:`Chart ` + :rtype: :class:`Chart ` :raises HighchartsPandasDeserializationError: if ``property_map`` references a column that does not exist in the data frame @@ -839,7 +1006,7 @@ def from_pyspark(cls, series_kwargs = None, options_kwargs = None, chart_kwargs = None): - """Create a :class:`Chart ` instance whose + """Create a :class:`Chart ` instance whose data is populated from a `PySpark `_ :class:`DataFrame `. @@ -893,9 +1060,9 @@ def from_pyspark(cls, :type chart_kwargs: :class:`dict ` or :obj:`None ` - :returns: A :class:`Chart ` instance with its + :returns: A :class:`Chart ` instance with its data populated from the data in ``df``. - :rtype: :class:`Chart ` + :rtype: :class:`Chart ` :raises HighchartsPySparkDeserializationError: if ``property_map`` references a column that does not exist in the data frame @@ -930,12 +1097,12 @@ def from_pyspark(cls, def from_options(cls, options, chart_kwargs = None): - """Create a :class:`Chart ` instance from a - :class:`HighchartsOptions ` object. + """Create a :class:`Chart ` instance from a + :class:`HighchartsOptions ` object. :param options: The configuration options to use to instantiate the chart. :type options: - :class:`HighchartsOptions ` or + :class:`HighchartsOptions ` or coercable :param chart_kwargs: An optional :class:`dict ` containing keyword @@ -949,8 +1116,8 @@ def from_options(cls, :type chart_kwargs: :class:`dict ` or :obj:`None ` - :returns: The :class:`Chart ` instance - :rtype: :class:`Chart ` + :returns: The :class:`Chart ` instance + :rtype: :class:`Chart ` """ chart_kwargs = validators.dict(chart_kwargs, allow_empty = True) or {} options = validate_types(options, @@ -960,3 +1127,4 @@ def from_options(cls, instance.options = options return instance + diff --git a/highcharts_python/constants.py b/highcharts_core/constants.py similarity index 96% rename from highcharts_python/constants.py rename to highcharts_core/constants.py index f1a829fe..a2fc28a4 100644 --- a/highcharts_python/constants.py +++ b/highcharts_core/constants.py @@ -1,13 +1,15 @@ """Defines a set of constants that are used throughout the library.""" import os - -from dotenv import load_dotenv - -load_dotenv() +try: + from dotenv import load_dotenv + load_dotenv() +except ImportError: + pass class EnforcedNullType: - pass + def __eq__(self, other): + return isinstance(other, self.__class__) EnforcedNull = EnforcedNullType() @@ -23,6 +25,26 @@ class EnforcedNullType: DEFAULT_COLORS = ["#7cb5ec", "#434348", "#90ed7d", "#f7a35c", "#8085e9", "#f15c80", "#e4d354", "#2b908f", "#f45b5b", "#91e8e1"] +INCLUDE_LIBS = [ + 'https://code.highcharts.com/highcharts.js', + 'https://code.highcharts.com/highcharts-more.js', + 'https://code.highcharts.com/highcharts-3d.js', + 'https://code.highcharts.com/modules/accessibility.js', + 'https://code.highcharts.com/modules/annotations.js', + 'https://code.highcharts.com/modules/boost.js', + 'https://code.highcharts.com/modules/broken-axis.js', + 'https://code.highcharts.com/modules/data.js', + 'https://code.highcharts.com/modules/exporting.js', + 'https://code.highcharts.com/modules/drilldown.js', + 'https://code.highcharts.com/modules/funnel.js', + 'https://code.highcharts.com/modules/heatmap.js', + 'https://code.highcharts.com/modules/no-data-to-display.js', + 'https://code.highcharts.com/modules/offline-exporting.js', + 'https://code.highcharts.com/modules/solid-gauge.js', + 'https://code.highcharts.com/modules/series-label.js', + 'https://code.highcharts.com/modules/treemap.js' +] + INCLUDE_STR = """