3.3.400 • Published 5 months ago

atriusmaps-node-sdk v3.3.400

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
-
Last release
5 months ago

atriusmaps-node-sdk

To Install:

npm install atriusmaps-node-sdk

Or with yarn:

yarn add atriusmaps-node-sdk

Then within your code, import the map initializer via:

import Init from 'atriusmaps-node-sdk'

or use require

const Init = require("atriusmaps-node-sdk")

To Use

The Init object contains 3 methods:

  • Init.setLogging(boolean logging) : To turn on/off the logging
  • Init.getVersion() : Returns the current version of the library
  • Init.newMap(Object configuration) : This is how your initialize a new map. This returns a Promise that resolves to your map.

The configuration object recognizes the following properties:

  • accountId: This is the customer account against which you wish to display a map. Each account is associated with a list of 1 or more venues that it is authorized to display.
  • venueId: The venue ID you wish the map to render.
  • agent (optional): An instance of the http.agent to handle network fetches. See https://github.com/node-fetch/node-fetch#custom-agent for more information.
  • proxy (optional): An object containing a host and port property to utilize a forwarding proxy for all network requests. (see example below)

At a minimum, a configuration would contain an accountId and a venueId:

const config = {
			venueId: '<venueId>',
			accountId: '<accountId>'
		}

An example of utilizing a proxy:

const config = {
			venueId: '<venueId>',
			accountId: '<accountId>',
			proxy: {
				host: 'example.com',
				port: 9108
			}
		}

You then initialize your map:

const map = await Init.newMap(config)

Your map function is ready to receive commands – of which the following are currently supported:

  • help : Returns a string indicating all available commands and their arguments
  • getDirections: Get time, distance and navigation steps from one point to another
  • getPOIDetails: Get detailed information about a POI by ID
  • getAllPOIs: Get a list of all POIs for the venue
  • getStructures: Returns a list of structures (buildings) within the venue along with their properties
  • getVenueData: Returns a complete venue object containing all venue details
  • search: Performs a search against a term specified

For details on these commands, including their arguments, return value formats, and examples, see https://locusmapsjs.readme.io/docs/commands

Note that all these commands are asynchronous, and return a promise. So use them with await or a then clause.

Examples:

const poi = await map.getPOIDetails(11)
console.log(`Got POI details for ${poi.name}.`)

Or

map.getPOIDetails(11)
  .then(poi => console.log(`Got POI Details for ${poi.name}.`))

For example:

node main.js

© 2024 ACUITY BRANDS, INC. ALL RIGHTS RESERVED

3.3.398

5 months ago

3.3.399

5 months ago

3.3.396

5 months ago

3.3.397

5 months ago

3.3.400

5 months ago

3.3.389

5 months ago

3.3.394

5 months ago

3.3.395

5 months ago

3.3.392

5 months ago

3.3.393

5 months ago

3.3.390

5 months ago

3.3.391

5 months ago

3.3.388

5 months ago

3.3.387

5 months ago

3.3.386

6 months ago

3.3.385

6 months ago

3.3.384

6 months ago

3.3.381

6 months ago

3.3.382

6 months ago

3.3.380

6 months ago

3.3.378

6 months ago

3.3.379

6 months ago

3.3.376

6 months ago

3.3.377

6 months ago

3.3.374

6 months ago

3.3.375

6 months ago

3.3.372

6 months ago

3.3.373

6 months ago

3.3.370

6 months ago

3.3.371

6 months ago

3.3.369

6 months ago

3.3.368

7 months ago

3.3.367

7 months ago

3.3.365

7 months ago

3.3.366

7 months ago

3.3.363

7 months ago

3.3.364

7 months ago

3.3.361

7 months ago

3.3.362

7 months ago

3.3.360

8 months ago

3.3.358

8 months ago

3.3.359

8 months ago

3.3.357

8 months ago

3.3.356

8 months ago

3.3.354

8 months ago

3.3.355

8 months ago

3.3.353

8 months ago

3.3.352

8 months ago

3.3.351

8 months ago

3.3.350

8 months ago

3.3.349

8 months ago

3.3.345

9 months ago

3.3.346

8 months ago

3.3.347

8 months ago

3.3.348

8 months ago

3.3.344

9 months ago

3.3.343

9 months ago

3.3.342

9 months ago

3.3.341

9 months ago

3.3.340

9 months ago

3.3.338

9 months ago

3.3.339

9 months ago

3.3.337

10 months ago

3.3.336

10 months ago

3.3.334

10 months ago

3.3.335

10 months ago

3.3.332

10 months ago

3.3.333

10 months ago

3.3.330

10 months ago

3.3.331

10 months ago

3.3.323

11 months ago

3.3.324

11 months ago

3.3.321

11 months ago

3.3.322

11 months ago

3.3.320

11 months ago

3.3.318

11 months ago

3.3.319

11 months ago

3.3.316

11 months ago

3.3.317

11 months ago

3.3.314

11 months ago

3.3.315

11 months ago

3.3.329

10 months ago

3.3.327

10 months ago

3.3.328

10 months ago

3.3.325

11 months ago

3.3.326

10 months ago

3.3.312

12 months ago

3.3.313

12 months ago

3.3.310

12 months ago

3.3.311

12 months ago

3.3.309

12 months ago

3.3.308

12 months ago

3.3.307

12 months ago

3.3.306

12 months ago

3.3.305

12 months ago

3.3.303

1 year ago

3.3.304

12 months ago

3.3.302

1 year ago

3.3.301

1 year ago

3.3.300

1 year ago

3.3.299

1 year ago

3.3.298

1 year ago

3.3.297

1 year ago

3.3.296

1 year ago

3.3.268

1 year ago

3.3.269

1 year ago

3.3.266

1 year ago

3.3.267

1 year ago

3.3.264

1 year ago

3.3.265

1 year ago

3.3.262

1 year ago

3.3.263

1 year ago

3.3.260

1 year ago

3.3.261

1 year ago

3.3.259

1 year ago

3.3.258

1 year ago

3.3.295

1 year ago

3.3.293

1 year ago

3.3.294

1 year ago

3.3.291

1 year ago

3.3.292

1 year ago

3.3.290

1 year ago

3.3.288

1 year ago

3.3.289

1 year ago

3.3.286

1 year ago

3.3.287

1 year ago

3.3.284

1 year ago

3.3.285

1 year ago

3.3.282

1 year ago

3.3.283

1 year ago

3.3.280

1 year ago

3.3.281

1 year ago

3.3.279

1 year ago

3.3.277

1 year ago

3.3.278

1 year ago

3.3.275

1 year ago

3.3.276

1 year ago

3.3.273

1 year ago

3.3.274

1 year ago

3.3.271

1 year ago

3.3.272

1 year ago

3.3.270

1 year ago

3.3.257

1 year ago

3.3.255

1 year ago

3.3.256

1 year ago

3.3.251

1 year ago

3.3.252

1 year ago

3.3.250

1 year ago

3.3.248

1 year ago

3.3.249

1 year ago

3.3.246

1 year ago

3.3.247

1 year ago

3.3.244

1 year ago

3.3.245

1 year ago

3.3.242

1 year ago

3.3.243

1 year ago

3.3.240

1 year ago

3.3.241

1 year ago

3.3.239

1 year ago

3.3.238

1 year ago

3.3.235

1 year ago

3.3.236

1 year ago

3.3.233

1 year ago

3.3.234

1 year ago

3.3.237

1 year ago

3.3.231

1 year ago

3.3.232

1 year ago

3.3.230

1 year ago

3.3.229

1 year ago

3.3.228

1 year ago

3.3.226

1 year ago

3.3.225

1 year ago

3.3.196

1 year ago

3.3.31

2 years ago

3.3.1

3 years ago

3.2.30

3 years ago

3.2.28

3 years ago

3.2.21

4 years ago

3.2.10

4 years ago

1.0.0

4 years ago