gameticharles / skyplot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SkyPlot Flutter Package

SkyPlot is a versatile Flutter library crafted to visualize positional data in a dynamic sky plot interface. It's not just limited to GNSS satellite positions but can also be adapted for various other applications like radar maps, device availability scanning, and more. Its flexibility makes it suitable for a wide range of use cases.

Features

  • Multi-Purpose Visualization: Ideal for displaying positional data in 2D plots, from satellites to local devices.
  • Customizable Interface: Tailor the appearance to fit the needs of your application, with options for colors, icons, and more.
  • Adaptive and Responsive: Seamlessly adapts to different screen sizes and orientations.
  • Interactive and Informative: Provides interactive elements to engage users and display detailed information.

Getting Started

Add SkyPlot to your Flutter project by including it in your dependencies:

dependencies:
  skyplot: any

Import SkyPlot in your Dart code:

import 'package:skyplot/skyplot.dart';

Usage

Create a SkyPlot widget by providing it with data and configuration:

SkyPlot(
  skyData: yourDataList,
  categories: yourCategoryMap,
  options: SkyPlotOptions(),
)

SkyData

SkyData is a versatile data structure that represents each item in the plot:

SkyData(
  azimuthDegrees: 100,
  elevationDegrees: 50,
  category: 'CategoryName',
  id: 'UniqueID',
  usedInFix: true, // or false depending on the context
)

Customization

Configure the appearance and behavior of your sky plot:

SkyPlotOptions(
  baseRadiusInFix: 8.0,
  baseRadiusNotInFix: 6.0,
  azimuthDivisions: 30,
  // ... other customizable options ...
)

Example Applications

  • Satellite Tracking: Visualize satellites in orbit.
  • Radar Mapping: Display radar sweeps and detected objects.
  • Device Scanning: Show available devices in a certain range.

Contributing

🍺 Pull requests are welcome!

Don't forget that open-source makes no sense without contributors. No matter how big your changes are, it helps us a lot even it is a line of change.

There might be a lot of grammar issues in the docs. It's a big help to us to fix them if you are fluent in English.

Reporting bugs and issues are contribution too, yes it is.

Author

Charles Gameti: gameticharles@GitHub.

License

This library is provided under the MIT.

About

License:MIT License


Languages

Language:Dart 41.4%Language:C++ 27.9%Language:CMake 23.5%Language:Swift 2.9%Language:HTML 2.2%Language:C 1.7%Language:Kotlin 0.3%Language:Objective-C 0.1%