Class PolygonLayer

Optionalid

Static Optionalconnection

Static Optionalitem

coordinates

• get coordinates(): G["coordinates"]

  Returns G["coordinates"]

• set coordinates(coordinates: G["coordinates"]): void

  Parameters

  • coordinates: G["coordinates"]

  Returns void

geom

• get geom(): G

  Returns G

• set geom(geom: G): void

  Parameters

  • geom: G

  Returns void

getConstructor

• getConstructor(): typeof VectorLayer

  Returns typeof VectorLayer

hasId

• hasId(): boolean

  Checks if entity has an id.

  Returns boolean

save

• save(): Promise<PolygonLayer>

  Saves current entity in the NGW target layer. If entity does not exist in the NGW layer then inserts, otherwise updates.

  Returns Promise<PolygonLayer>

toGeoJson

• toGeoJson(): Feature<Polygon, PolygonLayer>

  Returns Feature<Polygon, PolygonLayer>

toJSON

• toJSON(): string

  Returns string

Staticclone

• clone<T extends typeof BaseResource = typeof BaseResource>(
      options?: Partial<NgwResourceOptions>,
  ): T

  Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • options: Partial<NgwResourceOptions> = {}

  Returns T

Staticconnect

• connect<T extends typeof BaseResource = typeof BaseResource>(
      resourceOptions: ResourceIdKeynameDef,
      connectionOrOptions: Connection | ConnectionOptions,
  ): Promise<T>

  Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • resourceOptions: ResourceIdKeynameDef
  • connectionOrOptions: Connection | ConnectionOptions

  Returns Promise<T>

Staticcount

• count<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: FindManyOptions<T> | PropertiesFilter<T>,
  ): Promise<number>

  Counts entities that match given find options or conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: FindManyOptions<T> | PropertiesFilter<T>

  Returns Promise<number>

Staticfind

• find<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: FindManyOptions<T> | PropertiesFilter<T>,
  ): Promise<T[]>

  Finds entities that match given find options or conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: FindManyOptions<T> | PropertiesFilter<T>

  Returns Promise<T[]>

StaticfindOne

• findOne<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: number | FindOneOptions<T> | FindConditions<T>,
      maybeOptions?: FindOneOptions<T>,
  ): Promise<undefined | T>

  Finds first entity that matches given conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: number | FindOneOptions<T> | FindConditions<T>
  • OptionalmaybeOptions: FindOneOptions<T>

  Returns Promise<undefined | T>

StaticfindOneOrFail

• findOneOrFail<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: number | FindOneOptions<T> | FindConditions<T>,
      maybeOptions?: FindOneOptions<T>,
  ): Promise<T>

  Finds first entity that matches given conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: number | FindOneOptions<T> | FindConditions<T>
  • OptionalmaybeOptions: FindOneOptions<T>

  Returns Promise<T>

StaticgetNgwPayload

• getNgwPayload(
      resource: typeof VectorLayer,
      parent: number,
      options: SyncOptions,
  ):
      | undefined
      | DeepPartial<VectorResourceSyncItem | VectorResourceUpdateItem>

  Parameters

  • resource: typeof VectorLayer
  • parent: number
  • options: SyncOptions

  Returns undefined | DeepPartial<VectorResourceSyncItem | VectorResourceUpdateItem>

Staticreceive

• receive(item: CompositeRead): typeof VectorLayer

  Parameters

  • item: CompositeRead

  Returns typeof VectorLayer

Staticsave

• save<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      entityOrEntities: T | T[],
      options?: UpdateOptions,
  ): Promise<T[]>

  Saves one or many given entities.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • entityOrEntities: T | T[]
  • Optionaloptions: UpdateOptions

  Returns Promise<T[]>

Staticsync

• sync(
      options: SyncOptions,
      connectionOrOptions: Connection | ConnectionOptions,
  ): void

  Parameters

  • options: SyncOptions
  • connectionOrOptions: Connection | ConnectionOptions

  Returns void

StatictoTypescript

• toTypescript(opt?: ToTypescriptOptions): ToTypescript

  Parameters

  • Optionalopt: ToTypescriptOptions

  Returns ToTypescript

Staticvalidate

• validate(): ValidateErrorType[]

  Returns ValidateErrorType[]