Giter Club home page Giter Club logo

arcgis-maps-sdk-kotlin-toolkit's Introduction

ArcGIS Maps SDK for Kotlin Toolkit

The ArcGIS Maps SDK for Kotlin Toolkit contains components that will simplify your Kotlin app development. It is built off of the new ArcGIS Maps SDK for Kotlin.

Toolkit Components

  • Authenticator - Displays a user interface when network and ArcGIS authentication challenges occur.
  • Compass - Shows a compass direction when the map is rotated. Auto-hides when the map points north.
  • FloorFilter - Allows filtering of floor plan data in a geo view by a site, a facility in the site, or a floor in the facility.

Requirements

Please see the developer setup for a complete description of requirements

  • ArcGIS Maps SDK for Kotlin
    See this guide for complete instructions and other options for installing the SDK.
  • JDK 17

The ArcGIS Maps SDK for Kotlin Toolkit has a Minimum SDK version of 26, meaning that it can run on devices with Android Oreo (8.0) or newer.

Installation

Using the BOM

The ArcGIS Maps SDK for Kotlin Toolkit is released with a "bill of materials" (BOM). The releasable BOM is versioned and represents a set of versions of the toolkit components which are compatible with one another. You may specify dependencies as follows

implementation(platform('com.esri:arcgis-maps-kotlin-toolkit-bom:200.3.0'))
implementation('com.esri:arcgis-maps-kotlin-toolkit-authentication')
implementation('com.esri:arcgis-maps-kotlin-toolkit-compass')
implementation('com.esri:arcgis-maps-kotlin-toolkit-indoors')

The template and TemplateApp modules are for bootstrapping new modules.

Please see the package structure documentation for more details.

Issues

Find a bug or want to request a new feature enhancement? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Creating a New Toolkit Component

A new toolkit component can be added to this project by running the bash script at the top level ./new-component-starter.sh -n NameOfNewComponent"

This will create a new library module for the new component, and a new app module which depends on the library. Capitalization isn't necessary, but it won't capitalize anything but the first letter if none is specified.

This script requires bash 4.0 or higher.

About this Repo

The project is structured into two folders, microapps and toolkit each containing many modules, and a folder for releasing a bill of materials (BOM).

arcgis-maps-sdk-kotlin-toolkit
├── bom
│   └── build.gradle.kts
├── microapps
│   └── TemplateApp
│   ├── ...App
├── toolkit
│   ├── template
│   ├── ...
├── build.gradle.kts
└── settings.gradle.kts

The toolkit folder contains releasable libraries -- these are the components of the toolkit. For each module in the toolkit folder there is a corresponding app in the microapps folder which depends on it. The apps are not released but are useful for working on a particular component in isolation.

The template and TemplateApp modules are for bootstrapping new modules.

Please see the package structure documentation for more details.

Licensing

Copyright 2019-2022 Esri

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.

A copy of the license is available in the repository's LICENSE file.

arcgis-maps-sdk-kotlin-toolkit's People

Contributors

hud10837 avatar sorenoid avatar kaushikrw avatar puneet-pdx avatar gunt0001 avatar eri9000 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.