Home Manual Reference Source
public class | source

Organisation

Extends:

ResourceBaseCrudBase → Organisation

Static Member Summary

Static Public Members
public static get

Member Summary

Public Members
public get

Get a proxy for colors linked to the organisation

public get

Get a proxy for contracts linked to the organisation

public get

Get a proxy for dimension sets linked to the organisation

public get

Get a proxy for contracts linked to the organisation

public get

Get a proxy for features linked to the organisation

public get

Get a proxy for font families linked to the organisation

public get

Get a proxy for job shares linked to the organisation

public get

Get a proxy for job types linked to the organisation

public get

Get a proxy for jobs linked to the organisation, also known as company maps

public get

Get a proxy for layers linked to the organisation

public get

Get a proxy for mapstyle sets linked to the organisation

public get

Get a proxy for svg sets linked to the organisation

public get

Get a proxy for tags linked to the organisation

public get

Get a proxy for users linked to the organisation

Method Summary

Public Methods
public

Get a tree representation of the organisation's relationships

Inherited Summary

From class ResourceBase
public static get

Returns if the resource is readonly

public static get abstract

Resource name

public static get

Resource path template

public static get

Returns the url key of the resource

protected static get

Protected read-only fields

public get

Get api instance

public set

api(value: Maps4News)

Set the api instance

public get

Auto generated Resource base url

public get

List fields that contain object data

public get

If the resource can be owned by an organisation

public get

url: string: *

Auto generated resource url

public

Clone the object

public

async refresh(updateSelf: Boolean): Promise<ResourceBase>

Refresh the resource by requesting it from the server again

public

reset(fields: Array<string> | string | null)

Resets model instance to it's original state

public

Clean up instance and commit all changes locally.

public

static(Target: string | function, Constructor: function, seedData: Object<string, *>): SimpleResourceProxy

Static proxy generation

public

toObject(camelCaseKeys: boolean): {}

Transform instance to object

public

String representation of the resource, similar to Python's repr

protected

Macro for resource listing

protected

Moves new fields to this._properties and turns them into a getter/setter

From class CrudBase
public

async delete(updateSelf: Boolean): Promise<CrudBase>

Delete item

public

async restore(updateSelf: Boolean): Promise<CrudBase>

Restore item

public

Save item.

protected

Build data for create operation

Static Public Members

public static get resourceName: string source

Resource name

Override:

ResourceBase#resourceName

Public Members

public get colors: OwnedResourceProxy: * source

Get a proxy for colors linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get contracts: SimpleResourceProxy: * source

Get a proxy for contracts linked to the organisation

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get dimensionSets: OwnedResourceProxy: * source

Get a proxy for dimension sets linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get domains: SimpleResourceProxy: * source

Get a proxy for contracts linked to the organisation

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get features: OwnedResourceProxy: * source

Get a proxy for features linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get fontFamilies: OwnedResourceProxy: * source

Get a proxy for font families linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get jobShares: SimpleResourceProxy: * source

Get a proxy for job shares linked to the organisation

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get jobTypes: OwnedResourceProxy: * source

Get a proxy for job types linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get jobs: SimpleResourceProxy: * source

Get a proxy for jobs linked to the organisation, also known as company maps

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get layers: OwnedResourceProxy: * source

Get a proxy for layers linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get mapstyleSets: OwnedResourceProxy: * source

Get a proxy for mapstyle sets linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get svgSets: OwnedResourceProxy: * source

Get a proxy for svg sets linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get tags: OwnedResourceProxy: * source

Get a proxy for tags linked to the organisation

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get users: SimpleResourceProxy: * source

Get a proxy for users linked to the organisation

Return:

SimpleResourceProxy

A proxy for accessing the resource

Public Methods

public async getTree(): Promise<Array<Organisation>> source

Get a tree representation of the organisation's relationships

Return:

Promise<Array<Organisation>>

List of organisation root nodes. Organisations contain an extra property called "children"

Example:

function printTree(nodes, prefix = '-') {
 for (const node of nodes) {
   console.log(`${prefix} ${node.name}`);

   printTree(node.children, prefix + '-');
 }
}

organisation.getTree().then(printTree)