1 Star 0 Fork 21

Pulsar / giojs

forked from syt123450 / giojs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Gio logo

Gio.js

English | 中文

React版本: react-giojs

微信小游戏: 使用方法介绍

npm version license badge dependencies badge build coverage

Gio.js 是一个基于Three.js的web 3D地球数据可视化的开源组件库。使用Gio.js的网页应用开发者,可以快速地以申明的方式创建自定义的Web3D数据可视化模型,添加数据,并且将其作为一个组件整合到自己的应用中。

目录

为什么要使用Gio.js

Gio.js 是一个基于Three.js的web 3D地球数据可视化的开源组件库。使用Gio.js的网页应用开发者,可以快速地以申明的方式创建自定义的Web3D数据可视化模型,添加数据,并且将其作为一个组件整合到自己的应用中。

这个库的开发是受到Google 2012 Info大会上的项目世界武器贩卖可视化的启发,该项目开发者是Google员工Michael Chang。使用Gio.js就可以快速构建这种炫酷的3D模型,并以此为基础进行深入地开发。

  • 易用性 -- 仅使用4行Javascript即可创建3D地球数据可视化模型
  • 定制化 -- 使用Gio.js提供的丰富的API来创建自定义样式的3D地球
  • 现代化 -- 基于Gio.js构建高交互、自适应的现代化3D前端应用

开始使用

安装

  • 途径1: <script> 标签

在HTML页面的部分引入 Three.js 依赖:

<script src="three.min.js"></script>

在HTML页面的部分引入 Gio.js 依赖:

<script src="gio.min.js"></script>

或者通过CDN引入依赖:

<script src="https://threejs.org/build/three.min.js"></script>
<script src="https://raw.githack.com/syt123450/giojs/master/build/gio.min.js"></script>
  • 途径2: JavaScript包管理工具NPM
npm install giojs --save
  • 途径3: JavaScript包管理工具YARN
yarn add giojs

使用

在HTML页面中添加了Threejs和Giojs依赖之后,您就可以基于Giojs开发您的应用了。我们将展示如何创建一个具有基础样式的Gio地球。(在微信小游戏中Gio.js的使用略有不同,查看这个栗子,了解如何在微信小游戏中使用Gio.js)

<!DOCTYPE HTML>
<html>
<head>

  <!-- 引入three.js -->
  <script src="three.min.js"></script>

  <!-- 引入Gio.js -->
  <script src="gio.min.js"></script>

</head>
<body>

  <!-- 创建一个div座位Gio的绘制容器 -->
  <div id="globalArea"></div>

</body>
</html>

在您的页面中添加以下Javascript代码来初始化Gio地球:


<script>

    // 获得用来来承载您的IO地球的容器
    var container = document.getElementById( "globalArea" );

    // 创建Gio控制器
    var controller = new GIO.Controller( container );

    // 添加数据,了解更多有关Gio.js数据格式,查看文档:http://giojs.org/html/docs/dataIntro_zh.html
    controller.addData( data );

    // 初始化并渲染地球
    controller.init();

</script>

如果一切顺利,在浏览器中打开您的HTML页面你将会看到以下3D地球: 用力点我. 如果有兴趣了解更多Gio.js有趣的用法,我们强烈推荐Gio.js的文档

点击后面这个Codepen logo来在Codepen中试一下这个例子吧 ~   

例子

Gio.js有很多代表性的例子,这些例子可以作为小帮手,辅助你成为一个Gio.js的专家!大致可以将这些小帮手分成三类:

  • 小帮手1号: Gio.js Playground

Gio.js有一个Playground插件(Playground链接),在这个Playground中,你可以试试Gio.js的部分功能并且导出配置参数。

  • 小帮手2号: Github仓库"examples"文件夹下的例子

Gio.js的仓库中有很多API例子,这些例子都被归集在"examples"文件夹下。Clone Gio.js仓库,然后在本地环境中看看它们把~

  • 小帮手3号: Codepen在线可编辑的例子

Gio.js有很多codepen的例子,你可以在codepen中编辑修改它们。点击后面这个Codepen logo,可以直接进入Gio.js Codepen的编辑界面。

API列表

configure(json)

配置controller。

setInitCountry(ISOCode, default: 'CN')

设置初始"被选中国家"。

lightenMentioned(boolean, default: 'false')

使Gio地球表面上"提及国家"比"未提及的国家"更亮。

disableUnmentioned(boolean, default: 'false')

禁止点击"未提及的国家"。

showInOnly(boolean, default: 'false')

对于"被选中的国家",只显示"输入线"。

showOutOnly(boolean, default: 'false')

对于"被选中的国家",只显示"输出线"。

addHalo(string)

添加地球光晕,可以指定光晕颜色。

removeHalo()

删除地球光晕。

enableStats()

显示左上角的"性能监控"组件。

disableStats()

隐藏左上角的"性能监控"组件。

setStyle(string)

通过设置风格名称来更改3D地球的颜色风格。

setSurfaceColor(string, default: '#ffffff')

通过RGB值设置3D地球的表面颜色。

setSelectedColor(string, default: '#ffffff')

通过RGB值设置"在选中状态"下的国家颜色。

setExportColor(string, default: '#DD380C')

通过RGB值设置输出线的颜色。

setImportColor(string, default: '#154492')

通过RGB值设置输入线的颜色。

setHaloColor(string, default: '#ffffff')

通过RGB值设置光晕的颜色。

setBackgroundColor(string, default: '#000000')

通过RGB值设置背景的颜色。

adjustOceanBrightness(float, default: 0.5)

设置海洋的亮度。

adjustRelatedBrightness(float, default: 0.5)

设置相关国家的亮度。

adjustMentionedBrightness(float, default: 0.5)

设置提到国家的亮度。

addData(json)

将数据加载到Gio的控制器并同步覆盖以前的数据。

clearData()

清除地球上添加的数据,同时有将数据线和数据点清除的效果。

switchDataSet()

切换地球表面呈现的数据集。

addDataAsync(url, callback)

从一个数据源异步加载数据。

liveLoad(url, callback, duration)

周期性地从一个数据源加载数据。

closeLiveLoader()

关闭周期性加载功能。

getScene()

获得three.js中scene对象的引用。

getStatsObject()

获得Stats面板对象的引用。

onCountryPicked(callback)

当"被选中的国家"改变时被调用。

switchCountry(IsoCode)

切换"被选中的国家"。

文档

  • 如果想要快速了解如何使用Giojs的话, 开始使用 是一个好的开始
  • 如果想要了解Giojs的基本组件, 基础组件 会帮助你缕清Gio.js中的基本概念
  • 如果你有丰富的第三方组件的使用经验, Giojs API 文档
  • 如果想要加入我们Giojs的开发,不妨先了解一下 开发者文档 可以帮助你快速上手开发
  • 在我们的Gio.js中文版官网中,有对Gio.js最为详细的介绍 官网

开发人员

感谢所有Gio.js的开发人员 (emoji key):


syt123450

💻 📖 💡 ⚠️

Botime

💻 📖 ⚠️ 🚇

Mutian Wang

💻 📦 🎨 👀

Chenhua Zhu

💻 🚇 🤔 👀

Qi(Nora)

💻 🎨 📖

bouyuc

📖

Xiaoran Lin

💻 🎨 💡 👀

Leon

💻 🎨 💡

Alexis

💻 🐛

许可证

Apache-2.0

码云链接

Gio.js项目同时部署在码云上,并且与github同步,对国内有更快的访问和下载速度,欢迎通过以下链接访问 ➡ 用力戳我

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于 Three.js 的 web 3D 地球数据可视化的开源组件库 展开 收起
JavaScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/gitee_store/giojs.git
git@gitee.com:gitee_store/giojs.git
gitee_store
giojs
giojs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591