Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Add documentation for data-driven styling #7924

Closed
16 of 18 tasks
boundsj opened this issue Feb 2, 2017 · 5 comments
Closed
16 of 18 tasks

Add documentation for data-driven styling #7924

boundsj opened this issue Feb 2, 2017 · 5 comments
Assignees
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Milestone

Comments

@boundsj
Copy link
Contributor

boundsj commented Feb 2, 2017

Support for data-driven styling for iOS and macOS is being added in #7596. After we have used the API proposed there and before the final Mapbox iOS SDK 3.5.0 beta, we will fully document the new APIs added for DDS.

This will include (at least):

  • MGLStyleFunctionOption string enum
    • MGLStyleFunctionOptionInterpolationBase
    • MGLStyleFunctionOptionDefaultValue
  • MGLInterpolationMode enum
    • MGLInterpolationModeExponential
    • MGLInterpolationModeInterval
    • MGLInterpolationModeCategorical
    • MGLInterpolationModeIdentity
  • Update class documentation for MGLStyleValue (as a class cluster it represents something different now)
  • +[MGLStyleValue valueWithInterpolationMode:cameraStops:options:]
  • +[MGLStyleValue valueWithInterpolationMode:sourceStops:attributeName:options:]
  • +[MGLStyleValue valueWithInterpolationMode:compositeStops:attributeName:options:]
  • MGLCameraStyleFunction (and all methods and properties)
  • MGLSourceStyleFunction (and all methods and properties)
  • MGLCompositeStyleFunction (and all methods and properties)
  • Update generated code examples in MGLDocumentationExampleTests.swift to use camera functions and maybe add examples for source and composite functions
  • Update guides/For Style Authors.md with DDS specific terminology differences
  • Update guides/Runtime Styling.md with information about DDS (or add a DDS specific guide)

cc @friedbunny @jmkiley @1ec5 @incanus @ericrwolfe @pveugen

@boundsj boundsj added iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS release blocker Blocks the next final release runtime styling labels Feb 2, 2017
@boundsj boundsj added this to the ios-v3.5.0 milestone Feb 2, 2017
@boundsj boundsj self-assigned this Feb 2, 2017
@1ec5
Copy link
Contributor

1ec5 commented Feb 2, 2017

We should fill out the documentation before the first beta, because that's when we tell developers to start coding against new features in nontrivial projects. We can ship an alpha without the documentation if necessary to meet time commitments, however.

@1ec5
Copy link
Contributor

1ec5 commented Feb 8, 2017

  • Update the iOS and macOS changelogs to discuss all that’s changed

@boundsj
Copy link
Contributor Author

boundsj commented Feb 8, 2017

#7931, #7943, and #7960 added API documentation that should be suitable for the beta release. We still need a PR to update the guides but I don't consider that a requirement for the beta.

Before I create the beta, I will wait for:

@boundsj boundsj added release blocker Blocks the next final release and removed beta blocker Blocks the next beta release labels Feb 9, 2017
@1ec5
Copy link
Contributor

1ec5 commented Feb 17, 2017

#8025 will update the MGLFeature documentation to discuss more ways a feature’s attributes can be used, including in source functions.

@boundsj
Copy link
Contributor Author

boundsj commented Mar 13, 2017

I'm removing release blocker and closing this issue. The work to update and add guides continues in #8354 and it is possible that that PR may also be sufficient for #8192.

cc @jmkiley

@boundsj boundsj closed this as completed Mar 13, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Projects
None yet
Development

No branches or pull requests

2 participants