Areas

Areas

Areas Objects

class Areas()

This is a base object that contains all you can do about Areas.

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
withColor
function withColor(color: string) -> 'Areas'

Set the color attribute

Arguments:

  • color string - required field

Returns:

  • Areas
withDescription
function withDescription(description: string) -> 'Areas'

Set the description attribute

Arguments:

  • description string - required field

Returns:

  • Areas
withEntities
function withEntities(entities: array) -> 'Areas'

Set the entities attribute

Arguments:

  • entities array - required field

Returns:

  • Areas
withGeometry
function withGeometry(type: string,coordinates: array) -> 'Areas'

Set the geometry attribute

Arguments:

  • type string - required field
  • coordinates array - required field

Returns:

  • Areas
withIdentifier
function withIdentifier(identifier: string) -> 'Areas'

Set the identifier attribute

Arguments:

  • identifier string - required field

Returns:

  • Areas
withName
function withName(name: string) -> 'Areas'

Set the name attribute

Arguments:

  • name string - required field

Returns:

  • Areas
withOrder
function withOrder(order: number) -> 'Areas'

Set the order attribute

Arguments:

  • order number - required field

Returns:

  • Areas
withOrganization
function withOrganization(organization: string) -> 'Areas'

Set the organization attribute

Arguments:

  • organization string - required field

Returns:

  • Areas