Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseDrawing

The Document definition for a Drawing. Defines the DataSchema and common behaviors for a Drawing which are shared between both client and server.

mixes

DrawingData

memberof

documents

param data

Initial data from which to construct the Drawing

param context

Construction context options

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Methods

_validateModel

  • _validateModel(data: any): void
  • inheritdoc

    Parameters

    • data: any

    Returns void

testUserPermission

  • testUserPermission(user: any, permission: any, __namedParameters?: { exact: boolean }): any

  • Test whether a certain User has a requested permission level (or greater) over the Document

    Parameters

    • user: any

      The User being tested

    • permission: any

      The permission level from DOCUMENT_OWNERSHIP_LEVELS to test

    • __namedParameters: { exact: boolean } = {}

      Additional options involved in the permission test

      • exact: boolean

    Returns any

    Does the user have this permission level over the Document?

Static defineSchema

Static cleanData

  • cleanData(source?: {}, options?: {}): any
  • inheritdoc

    Parameters

    • source: {} = {}
      • options: {} = {}

        Returns any

      Static migrateData

      • migrateData(data: any): any
      • inheritdoc

        Parameters

        • data: any

        Returns any

      Static shimData

      • shimData(data: any, options: any): any
      • inheritdoc

        Parameters

        • data: any
        • options: any

        Returns any

      Static Private #validateVisibleContent

      • #validateVisibleContent(data: any): boolean

      • Validate whether the drawing has some visible content (as required by validation).

        Parameters

        • data: any

        Returns boolean

      Static Private #canModify

      • #canModify(user: any, doc: any, data: any): boolean

      • Is a user able to update or delete an existing Drawing document??

        Parameters

        • user: any
        • doc: any
        • data: any

        Returns boolean

      Properties

      Static metadata

      metadata: any = ...

      Default metadata which applies to each instance of this Document type.