-
-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0621716
Showing
24 changed files
with
2,156 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Miscellaneous | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom/ | ||
.buildlog/ | ||
.history | ||
.svn/ | ||
|
||
# IntelliJ related | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
|
||
# The .vscode folder contains launch configuration and tasks you configure in | ||
# VS Code which you may wish to be included in version control, so this line | ||
# is commented out by default. | ||
#.vscode/ | ||
|
||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.packages | ||
.pub-cache/ | ||
.pub/ | ||
build/ | ||
|
||
# Android related | ||
**/android/**/gradle-wrapper.jar | ||
**/android/.gradle | ||
**/android/captures/ | ||
**/android/gradlew | ||
**/android/gradlew.bat | ||
**/android/local.properties | ||
**/android/**/GeneratedPluginRegistrant.java | ||
|
||
# iOS/XCode related | ||
**/ios/**/*.mode1v3 | ||
**/ios/**/*.mode2v3 | ||
**/ios/**/*.moved-aside | ||
**/ios/**/*.pbxuser | ||
**/ios/**/*.perspectivev3 | ||
**/ios/**/*sync/ | ||
**/ios/**/.sconsign.dblite | ||
**/ios/**/.tags* | ||
**/ios/**/.vagrant/ | ||
**/ios/**/DerivedData/ | ||
**/ios/**/Icon? | ||
**/ios/**/Pods/ | ||
**/ios/**/.symlinks/ | ||
**/ios/**/profile | ||
**/ios/**/xcuserdata | ||
**/ios/.generated/ | ||
**/ios/Flutter/App.framework | ||
**/ios/Flutter/Flutter.framework | ||
**/ios/Flutter/Flutter.podspec | ||
**/ios/Flutter/Generated.xcconfig | ||
**/ios/Flutter/app.flx | ||
**/ios/Flutter/app.zip | ||
**/ios/Flutter/flutter_assets/ | ||
**/ios/Flutter/flutter_export_environment.sh | ||
**/ios/ServiceDefinitions.json | ||
**/ios/Runner/GeneratedPluginRegistrant.* | ||
|
||
# Exceptions to above rules. | ||
!**/ios/**/default.mode1v3 | ||
!**/ios/**/default.mode2v3 | ||
!**/ios/**/default.pbxuser | ||
!**/ios/**/default.perspectivev3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# This file tracks properties of this Flutter project. | ||
# Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
# | ||
# This file should be version controlled and should not be manually edited. | ||
|
||
version: | ||
revision: 7c6f9dd2396dfe7deb6fd11edc12c10786490083 | ||
channel: master | ||
|
||
project_type: package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## 0.1.0 | ||
|
||
- Initial release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Nabil Mosharraf | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
GraphView | ||
=========== | ||
|
||
Flutter GraphView is used to display data in graph structures. | ||
|
||
|
||
Overview | ||
======== | ||
The library is designed to support different graph layouts and currently works with small graphs only. | ||
|
||
|
||
Download | ||
======== | ||
|
||
```groovy | ||
dependencies { | ||
implementation 'de.blox:graphview:0.7.0' | ||
} | ||
``` | ||
Layouts | ||
====== | ||
### Tree | ||
Uses Walker's algorithm with Buchheim's runtime improvements (`BuchheimWalkerAlgorithm` class). Supports different orientations. All you have to do is using the `BuchheimWalkerConfiguration.Builder.setOrientation(int)` with either `ORIENTATION_LEFT_RIGHT`, `ORIENTATION_RIGHT_LEFT`, `ORIENTATION_TOP_BOTTOM` and | ||
`ORIENTATION_BOTTOM_TOP` (default). Furthermore parameters like sibling-, level-, subtree separation can be set. | ||
### Directed graph | ||
Directed graph drawing by simulating attraction/repulsion forces. For this the algorithm by Fruchterman and Reingold (`FruchtermanReingoldAlgorithm` class) was implemented. | ||
### Layered graph | ||
Algorithm from Sugiyama et al. for drawing multilayer graphs, taking advantage of the hierarchical structure of the graph (`SugiyamaAlgorithm` class). You can also set the parameters for node and level separation using the `SugiyamaConfiguration.Builder`. | ||
|
||
Usage | ||
====== | ||
Using GraphView is not much different than using RecyclerView. | ||
Add GraphView to your layout file. | ||
```xml | ||
<com.otaliastudios.zoom.ZoomLayout | ||
android:layout_width="match_parent" | ||
android:layout_height="match_parent" | ||
app:hasClickableChildren="true"> | ||
|
||
<de.blox.graphview.GraphView | ||
android:id="@+id/graph" | ||
android:layout_width="match_parent" | ||
android:layout_height="match_parent" | ||
app:lineColor="@android:color/holo_blue_dark" | ||
app:lineThickness="2dp" | ||
app:useMaxSize="true" /> | ||
</com.otaliastudios.zoom.ZoomLayout> | ||
``` | ||
|
||
Currently GraphView must be used together with a Zoom Engine like [ZoomLayout](https://github.com/natario1/ZoomLayout). To change the zoom values just use the different attributes described in the ZoomLayout project site. | ||
|
||
Then define the node layout, e.g. ```node.xml```. You can make the node Layout as complex as you want. | ||
```xml | ||
<TextView xmlns:android="http://schemas.android.com/apk/res/android" | ||
android:id="@+id/text" | ||
android:layout_width="wrap_content" | ||
android:layout_height="wrap_content" /> | ||
``` | ||
|
||
To create a graph, we need to instantiate the `Graph` class. Next bind your graph to GraphView, for that you must extend from the `GraphView.Adapter` class. | ||
|
||
```java | ||
public class GraphActivity extends AppCompatActivity { | ||
|
||
@Override | ||
protected void onCreate(Bundle savedInstanceState) { | ||
super.onCreate(savedInstanceState); | ||
setContentView(R.layout.activity_main); | ||
GraphView graphView = findViewById(R.id.graph); | ||
|
||
// example tree | ||
final Graph graph = new Graph(); | ||
final Node node1 = new Node("Parent"); | ||
final Node node2 = new Node("Child 1"); | ||
final Node node3 = new Node("Child 2"); | ||
|
||
graph.addEdge(node1, node2); | ||
graph.addEdge(node1, node3); | ||
|
||
// you can set the graph via the constructor or use the adapter.setGraph(Graph) method | ||
GraphAdapter adapter = new GraphAdapter<GraphView.ViewHolder>(graph) { | ||
|
||
@NonNull | ||
@Override | ||
public GraphView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { | ||
final View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.node, parent, false); | ||
return new SimpleViewHolder(view); | ||
} | ||
|
||
@Override | ||
public void onBindViewHolder(GraphView.ViewHolder viewHolder, Object data, int position) { | ||
((SimpleViewHolder) viewHolder).textView.setText(data.toString()); | ||
} | ||
}; | ||
graphView.setAdapter(adapter); | ||
|
||
// set the algorithm here | ||
final BuchheimWalkerConfiguration configuration = new BuchheimWalkerConfiguration.Builder() | ||
.setSiblingSeparation(100) | ||
.setLevelSeparation(300) | ||
.setSubtreeSeparation(300) | ||
.setOrientation(BuchheimWalkerConfiguration.ORIENTATION_TOP_BOTTOM) | ||
.build(); | ||
graphView.setLayout(new BuchheimWalkerAlgorithm(configuration)); | ||
} | ||
} | ||
``` | ||
|
||
Your ViewHolder class should extend from `GraphView.ViewHolder`: | ||
```java | ||
class SimpleViewHolder extends GraphView.ViewHolder { | ||
TextView textView; | ||
|
||
SimpleViewHolder(View itemView) { | ||
super(itemView); | ||
textView = itemView.findViewById(R.id.text); | ||
} | ||
} | ||
``` | ||
|
||
Customization | ||
============= | ||
|
||
To use the custom attributes you have to add the namespace first: ``` | ||
xmlns:app="http://schemas.android.com/apk/res-auto"``` | ||
|
||
| Attribute | Format | Example | Explanation| | ||
|------------------|-----------|--------------------------------|------------| | ||
| lineThickness | Dimension | 10dp | Set how thick the connection lines should be | ||
| lineColor | Color | "@android:color/holo_red_dark" | Set the color of the connection lines | ||
| useMaxSize | Boolean | true | Use the same size for each node | ||
|
||
Each of the attributes has a corresponding setter in the GraphView class, if you want to use it programmatically. | ||
|
||
Examples | ||
======== | ||
#### Rooted Tree | ||
 | ||
|
||
#### Directed Graph | ||
 | ||
|
||
#### Layered Graph | ||
 | ||
|
||
License | ||
======= | ||
|
||
Copyright 2020 Team-Blox | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
linter: | ||
rules: | ||
- always_declare_return_types | ||
- always_require_non_null_named_parameters | ||
- annotate_overrides | ||
- avoid_empty_else | ||
- avoid_init_to_null | ||
- avoid_null_checks_in_equality_operators | ||
- avoid_relative_lib_imports | ||
- avoid_return_types_on_setters | ||
- avoid_shadowing_type_parameters | ||
- avoid_types_as_parameter_names | ||
- camel_case_extensions | ||
- curly_braces_in_flow_control_structures | ||
- empty_catches | ||
- empty_constructor_bodies | ||
- library_names | ||
- library_prefixes | ||
- no_duplicate_case_values | ||
- null_closures | ||
- omit_local_variable_types | ||
- prefer_adjacent_string_concatenation | ||
- prefer_collection_literals | ||
- prefer_conditional_assignment | ||
- prefer_contains | ||
- prefer_equal_for_default_values | ||
- prefer_final_fields | ||
- prefer_for_elements_to_map_fromIterable | ||
- prefer_generic_function_type_aliases | ||
- prefer_if_null_operators | ||
- prefer_is_empty | ||
- prefer_is_not_empty | ||
- prefer_iterable_whereType | ||
- prefer_single_quotes | ||
- prefer_spread_collections | ||
- recursive_getters | ||
- slash_for_doc_comments | ||
- type_init_formals | ||
- unawaited_futures | ||
- unnecessary_const | ||
- unnecessary_new | ||
- unnecessary_null_in_if_null_operators | ||
- unnecessary_this | ||
- unrelated_type_equality_checks | ||
- use_function_type_syntax_for_parameters | ||
- use_rethrow_when_possible | ||
- valid_regexps | ||
|
||
analyzer: | ||
strong-mode: | ||
implicit-casts: false |
Oops, something went wrong.