Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[V2] [Question] Is the documentation up to date and complete? #1528

Closed
ihadeed opened this issue Jul 5, 2017 · 14 comments
Closed

[V2] [Question] Is the documentation up to date and complete? #1528

ihadeed opened this issue Jul 5, 2017 · 14 comments

Comments

@ihadeed
Copy link

ihadeed commented Jul 5, 2017

I'm in the progress of updating Ionic Native's Google Maps wrapper to work with the second version of this plugin.

I noticed that some methods are there in the source code, but they are not documented in the docs repo. For example, the Circle class has a getVisible and setVisible methods, but they are not documented. There are other similar instances of this confusion, but I guess you get the point.

Should I follow the source code, or the docs?

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 5, 2017

Oh, I see.
Maybe I forgot to add them to the documents.

Except KML layer, you can follow the source code.
I will check the documents tomorrow (I'm outside of town today)

@ihadeed ihadeed closed this as completed Jul 5, 2017
@ihadeed
Copy link
Author

ihadeed commented Jul 5, 2017

Ok perfect, thanks for the clarification.

If I come up with a list of missing items, do you want me to post them here?

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 5, 2017

Yes, please. Thank you for your work.

@ihadeed
Copy link
Author

ihadeed commented Jul 5, 2017

BaseArrayClass

It extends BaseClass but that's not mentioned in the docs. I think the only methods that matter are on() and one().

Circle

  • getMap()
  • getVisible()
  • setVisible()

Environment

  • setDebuggable()
  • isAvailable()

Map

Marker

  • getTitle
  • getSnippet
  • getRotation

Polygon

  • getGeodesic
  • setGeodesic
  • setStrokeWidth
  • getStrokeWidth

Polyline

  • getMap

TileOverlay

  • getTileSize

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 5, 2017

Thank you for the update.

The setDebuggable() method is actually only for me (it's not perfect for users).
The isAvailable() method is run automatic at the initialize. It is not necessary to run by users.
So please don't implement these methods.
Sorry, I forgot to mention about that.

I will update the documents for other methods.

I appreciate for your great work.

@ihadeed
Copy link
Author

ihadeed commented Jul 5, 2017

Thanks for the feedback @wf9a5m75

Also, thanks for the awesome plugin! Looks like lots of hours have been put into it.

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 5, 2017

@ihadeed I have a question. What is the <div class="nav-decor"> is for?
This element blocks this plugin actually.
Is there any affect if I apply a style display: none; for it?

@ihadeed
Copy link
Author

ihadeed commented Jul 6, 2017

As far as I know, that is only used for some iOS transition animations. Not sure if they use it for anything else now, I'm not very up to date with the Framework's internals.

I would say it's fair to set it's display property to none, or make it's background transparent (while google maps are visible). It shouldn't affect the behaviour of the app.

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 6, 2017

I see. Thank you for telling that. I got relieved disabling the nav-decor class does not affect to the app behavior.

I updated the plugin code to disable the nav-decor class actually. It looks fine.

And I also added one method : map.getVisible()
It just returns the value of map.setVisible().


I have been working on the market clustering recently. The due date is at the end of July (Pacific time).

Since of this, I have been still diddling around with the internal code.
But I promise I don't change the methods significantly.
(Might be add some methods)

I will set the multiple_maps branch as the stable. The current plan date is August/1.
I will update at this thread, and the release notes.

https://github.com/mapsplugin/cordova-plugin-googlemaps-doc/blob/master/v2.0.0/ReleaseNotes/v2.0-beta2/README.md

@ihadeed
Copy link
Author

ihadeed commented Jul 6, 2017

Ok thanks. Would it be safe if we release the Ionic Native update earlier? If you only plan to add methods, and not change anything major, then I think it should be fine.

@wf9a5m75
Copy link
Member

wf9a5m75 commented Jul 6, 2017

You can release it early :)
I only plan to update add some methods.

@wf9a5m75
Copy link
Member

@ihadeed
I sent a pull request. But I'm not ionic user, so I could not how to install ionic native from local. Please test the pull request.
danielsogl/awesome-cordova-plugins#1815

@wf9a5m75 wf9a5m75 reopened this Jul 17, 2017
@ihadeed
Copy link
Author

ihadeed commented Jul 17, 2017

Thanks @wf9a5m75 .. I'll take a look when I get a chance.

@wf9a5m75
Copy link
Member

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants