Skip to content

Commit

Permalink
Fix https & doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
sma-hms committed May 14, 2024
1 parent 7dfc210 commit 8422eda
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Currently supported indicators are :

Example & Demo
-------------------
Demo can be found here : [http:https://sebmatton.github.io/flightindicators/](http:https://sebmatton.github.io/flightindicators/)
Demo can be found here : [https:https://sebmatton.github.io/flightindicators/](https:https://sebmatton.github.io/flightindicators/)

Here are a few examples of currently implemented indicators :

Expand Down Expand Up @@ -65,16 +65,16 @@ Initial settings can be modified using the `options` parameter. Here are the val

```js
var options = {
size : 200, // Sets the size in pixels of the indicator (square)
roll : 0, // Roll angle in degrees for an attitude indicator
pitch : 0, // Pitch angle in degrees for an attitude indicator
heading: 0, // Heading angle in degrees for an heading indicator
vario: 0, // Variometer in 1000 feets/min for the variometer indicator
airspeed: 0, // Air speed in knots for an air speed indicator
altitude: 0, // Altitude in feets for an altimeter indicator
pressure: 1000, // Pressure in hPa for an altimeter indicator
showBox : true, // Sets if the outer squared box is visible or not (true or false)
img_directory : 'img/' // The directory where the images are saved to
size : 200, // Sets the size in pixels of the indicator (square)
roll : 0, // Roll angle in degrees for an attitude indicator
pitch : 0, // Pitch angle in degrees for an attitude indicator
heading: 0, // Heading angle in degrees for an heading indicator
vario: 0, // Variometer in 1000 feets/min for the variometer indicator
airspeed: 0, // Air speed in knots for an air speed indicator
altitude: 0, // Altitude in feets for an altimeter indicator
pressure: 1000, // Pressure in hPa for an altimeter indicator
showBox : true, // Sets if the outer squared box is visible or not (true or false)
img_directory : 'img/' // The directory where the images are saved to
}
```

Expand All @@ -93,16 +93,16 @@ attitude.setRoll(30); // Sets the roll to 30 degrees
Here are the valid methods :

```js
indicator.setRoll(roll); // Sets the roll of an attitude indicator
indicator.setPitch(pitch); // Sets the pitch of an attitude indicator
indicator.setHeading(heading); // Sets the heading of an heading indicator
indicator.setVario(vario); // Sets the climb speed of an variometer indicator
indicator.setAirSpeed(speed); // Sets the speed of an airspeed indicator
indicator.setAltitude(altitude); // Sets the altitude of an altimeter indicator
indicator.setPressure(pressure); // Sets the pressure of an altimeter indicator
indicator.resize(size); // Sets the size of any indicators
indicator.showBox(); // Make the outer squared box of any instrument visible
indicator.hideBox(); // Make the outer squared box of any instrument invisible
indicator.setRoll(roll); // Sets the roll of an attitude indicator
indicator.setPitch(pitch); // Sets the pitch of an attitude indicator
indicator.setHeading(heading); // Sets the heading of an heading indicator
indicator.setVario(vario); // Sets the climb speed of an variometer indicator
indicator.setAirSpeed(speed); // Sets the speed of an airspeed indicator
indicator.setAltitude(altitude); // Sets the altitude of an altimeter indicator
indicator.setPressure(pressure); // Sets the pressure of an altimeter indicator
indicator.resize(size); // Sets the size of any indicators
indicator.showBox(); // Make the outer squared box of any instrument visible
indicator.hideBox(); // Make the outer squared box of any instrument invisible
```

Author and License
Expand Down
Binary file modified _examples_data/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions example.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h2>Realtime indicators</h2>

<footer>
jQuery Flight Indicator plugin by Sébastien Matton - License GPLv3<br/>
<a title="By Mysid [CC-BY-SA-3.0 (http:https://creativecommons.org/licenses/by-sa/3.0) or GFDL (http:https://www.gnu.org/copyleft/fdl.html)], via Wikimedia Commons" href="http:https://commons.wikimedia.org/wiki/File%3ATurn_coordinator.svg">Turn Coordinator SVG from Wikimedia Commons</a>
Turn Coordinator SVG from <a title="By Mysid [CC-BY-SA-3.0 (https:https://creativecommons.org/licenses/by-sa/3.0) or GFDL (https:https://www.gnu.org/licenses/fdl-1.3.html)], via Wikimedia Commons" href="https:https://commons.wikimedia.org/wiki/File%3ATurn_coordinator.svg">Wikimedia Commons</a>
</footer>

<!-- Syntax color -->
Expand All @@ -119,7 +119,7 @@ <h2>Realtime indicators</h2>
var attitude = $.flightIndicator('#attitude', 'attitude', {roll:50, pitch:-20, size:200, showBox : true});
var heading = $.flightIndicator('#heading', 'heading', {heading:150, showBox:true});
var variometer = $.flightIndicator('#variometer', 'variometer', {vario:-5, showBox:true});
var airspeed = $.flightIndicator('#airspeed', 'airspeed', {showBox: false});
var airspeed = $.flightIndicator('#airspeed', 'airspeed', {showBox: true});
var altimeter = $.flightIndicator('#altimeter', 'altimeter');
var turn_coordinator = $.flightIndicator('#turn_coordinator', 'turn_coordinator', {turn:0});

Expand Down

0 comments on commit 8422eda

Please sign in to comment.