Class CheckPoint

Hierarchy

Element
- CheckPoint

Index

Constructors

Methods

addInteralListingHash archive archiveFile attributeExists autoUpdate computeEffects createCountingWorkRecord createWorkRecord destructor dispose extendElementData getAttributeDefinition getAttributeElementValue getAttributeFile getAttributeFirstFileUri getAttributeRawValue getAttributeTextValue getAttributeType getAttributeValue getChangeListenerTopic getConditionalData getEditableAttributes getEffects getEvaluatedEffects getLocalFiles getPrefilledAttributes hydrateRelationElements initialize instantiateReferences isAttributeMultiple loadAttributes loadData loadElementQuery loadRaw loadRelation performUpdate registerChangeListener setAttributeValue setAttributes setResponseScopeData togglePublishAttributes unarchive update updateDataHash uploadFiles GET_QUERY_PARAMS LISTING_PRESETS LISTING_TITLE dehydrateAttributeValue dehydrateData dehydrateDataAndUnwrapValues

Constructors

constructor

new CheckPoint(...args): CheckPoint
Parameters
- Rest ...args: any
Returns CheckPoint
Overrides Element.constructor
- Defined in src/lib/models/_default/checkPoint.ts:15

Properties

autoSave

autoSave: boolean = true

`Optional` changeListenerRef

changeListenerRef?: (() => void)

Type declaration

- (): void
- Returns void

children

children: Element[] = []

`Optional` childrenCount

childrenCount?: number

childrenData

childrenData: ElementData[] = []

completeData

completeData: boolean = false

`Optional` data

data?: ElementData

`Optional` dataHash

dataHash?: string

dirty

dirty: boolean = false

effects

effects: Record<string, Record<string, {
    backgroundColor?: string;
    prefix?: string;
    suffix?: string;
    textColor?: string;
}>> = {}

`Optional` errored

errored?: Error = undefined

hash

hash: string

interalListingHashes

interalListingHashes: string[] = []

listeners

listeners: (() => void)[] = []

Type declaration

- (): void
- Returns void

loading

loading: boolean = false

loadingPromise

loadingPromise: undefined | Promise<unknown>

onChangeDataHash

onChangeDataHash: (() => void)

Type declaration

- (): void
- Returns void

`Optional` originalData

originalData?: ElementData

`Optional` parent

parent?: Element

`Optional` predecessors

predecessors?: Element[]

`Optional` predecessorsCount

predecessorsCount?: number

references

references: {
[attribute: string]: Element[];
} = {}

Type declaration

[attribute: string]: Element[]

relationElements

relationElements: {
[attribute: string]: Element[];
} = {}

Type declaration

[attribute: string]: Element[]

saveHandler

saveHandler: (() => void)

Type declaration

- (): void
- Returns void

source

source: DataSource = 'backend'

store

store: MainStore

workRecords

workRecords: Map<string, IWorkRecord> = ...

`Optional` workRecordsCount

workRecordsCount?: number

Accessors

displayType

get displayType(): string
Returns string
Inherited from Element.displayType
- Defined in src/lib/models/element.ts:343

elementName

get elementName(): string
Returns string
Inherited from Element.elementName
- Defined in src/lib/models/element.ts:282

elementSchemaId

get elementSchemaId(): undefined | string
Returns undefined | string
Inherited from Element.elementSchemaId
- Defined in src/lib/models/element.ts:1390

mapLabel

get mapLabel(): null | string
Returns null | string
Inherited from Element.mapLabel
- Defined in src/lib/models/element.ts:272

markerConfig

get markerConfig(): MarkerConfig
Returns MarkerConfig
Inherited from Element.markerConfig
- Defined in src/lib/models/element.ts:277

options

get options(): undefined | string[]
Returns undefined | string[]
- Defined in src/lib/models/_default/checkPoint.ts:71

organization

get organization(): undefined | string
Returns undefined | string
Inherited from Element.organization
- Defined in src/lib/models/element.ts:327

pointType

get pointType(): CheckPointType
Returns CheckPointType
- Defined in src/lib/models/_default/checkPoint.ts:55

privileges

get privileges(): undefined | ElementPrivileges
Returns undefined | ElementPrivileges
Inherited from Element.privileges
- Defined in src/lib/models/element.ts:368

shouldCreateFinding

get shouldCreateFinding(): boolean
Returns boolean
- Defined in src/lib/models/_default/checkPoint.ts:62

sortValue

get sortValue(): string
Returns string
Inherited from Element.sortValue
- Defined in src/lib/models/element.ts:333

template

get template(): undefined | Template | ElementTemplateV1
Returns undefined | Template | ElementTemplateV1
Inherited from Element.template
- Defined in src/lib/models/element.ts:1399

type

get type(): undefined | string
Returns undefined | string
Inherited from Element.type
- Defined in src/lib/models/element.ts:338

typeData

get typeData(): undefined | ElementSchema | AttributeDefinitions
Returns undefined | ElementSchema | AttributeDefinitions
Inherited from Element.typeData
- Defined in src/lib/models/element.ts:1444

`Static` ATTRIBUTES

get ATTRIBUTES(): {
    ARCHIVED: string;
    CONDITIONAL_ATE: string;
    CONDITIONAL_VALUE: string;
    COORDINATES: string;
    CREATE_FINDING: string;
    ELEMENT_NAME: string;
    ELEMENT_PARENT: string;
    ORDER: string;
    SELECT_OPTIONS: string;
    SELECT_OPTION_COMPARATOR: string;
    TYPE: string;
    WORKFLOW_NOTE: string;
    WORKFLOW_PHOTO: string;
}
Returns {
    ARCHIVED: string;
    CONDITIONAL_ATE: string;
    CONDITIONAL_VALUE: string;
    COORDINATES: string;
    CREATE_FINDING: string;
    ELEMENT_NAME: string;
    ELEMENT_PARENT: string;
    ORDER: string;
    SELECT_OPTIONS: string;
    SELECT_OPTION_COMPARATOR: string;
    TYPE: string;
    WORKFLOW_NOTE: string;
    WORKFLOW_PHOTO: string;
}
- ARCHIVED: string
- CONDITIONAL_ATE: string
- CONDITIONAL_VALUE: string
- COORDINATES: string
- CREATE_FINDING: string
- ELEMENT_NAME: string
- ELEMENT_PARENT: string
- ORDER: string
- SELECT_OPTIONS: string
- SELECT_OPTION_COMPARATOR: string
- TYPE: string
- WORKFLOW_NOTE: string
- WORKFLOW_PHOTO: string
Overrides Element.ATTRIBUTES
- Defined in src/lib/models/_default/checkPoint.ts:25

`Static` DISABLED_ATTRIBUTES

get DISABLED_ATTRIBUTES(): string[]
Returns string[]
Inherited from Element.DISABLED_ATTRIBUTES
- Defined in src/lib/models/element.ts:264

`Static` GEO_RELATION_ATTRIBUTES

get GEO_RELATION_ATTRIBUTES(): string[]
Returns string[]
Inherited from Element.GEO_RELATION_ATTRIBUTES
- Defined in src/lib/models/element.ts:260

`Static` LINEVIEW_ATTRIBUTES

get LINEVIEW_ATTRIBUTES(): string[]
Returns string[]
Inherited from Element.LINEVIEW_ATTRIBUTES
- Defined in src/lib/models/element.ts:256

`Static` PREVIEW_ATTRIBUTES

get PREVIEW_ATTRIBUTES(): string[]
Returns string[]
Inherited from Element.PREVIEW_ATTRIBUTES
- Defined in src/lib/models/element.ts:252

`Static` SHORTNAME

get SHORTNAME(): string
Returns string
Inherited from Element.SHORTNAME
- Defined in src/lib/models/element.ts:248

`Static` TYPE

get TYPE(): string
Returns string
Overrides Element.TYPE
- Defined in src/lib/models/_default/checkPoint.ts:21

Methods

addInteralListingHash

addInteralListingHash(hash): void
Parameters
- hash: string
Returns void
Inherited from Element.addInteralListingHash
- Defined in src/lib/models/element.ts:357

archiveFile

archiveFile(attribute, fileHash): Promise<void>
Parameters
- attribute: string
- fileHash: string
Returns Promise<void>
Inherited from Element.archiveFile
- Defined in src/lib/models/element.ts:1261

attributeExists

attributeExists(attribute): boolean
Parameters
- attribute: string
Returns boolean
Inherited from Element.attributeExists
- Defined in src/lib/models/element.ts:1474

autoUpdate

autoUpdate(): undefined | false | Promise<boolean>
Returns undefined | false | Promise<boolean>
Inherited from Element.autoUpdate
- Defined in src/lib/models/element.ts:1056

computeEffects

computeEffects(template): void
Parameters
- template: Template
Returns void
Inherited from Element.computeEffects
- Defined in src/lib/models/element.ts:1679

createCountingWorkRecord

createCountingWorkRecord(data): Promise<undefined | IWorkRecord>
Parameters
- data: WorkRecordData
Returns Promise<undefined | IWorkRecord>
Inherited from Element.createCountingWorkRecord
- Defined in src/lib/models/element.ts:888

createWorkRecord

createWorkRecord(data): Promise<undefined | IWorkRecord>
Parameters
- data: WorkRecordData
Returns Promise<undefined | IWorkRecord>
Inherited from Element.createWorkRecord
- Defined in src/lib/models/element.ts:810

destructor

destructor(): void
Returns void
Inherited from Element.destructor
- Defined in src/lib/models/element.ts:230

dispose

dispose(): void
Returns void
Inherited from Element.dispose
- Defined in src/lib/models/element.ts:1236

extendElementData

extendElementData(data?, onlyAcceptNewerTimestamp?): void
Parameters
- Optional data: Partial<ElementData>
- onlyAcceptNewerTimestamp: boolean = false
Returns void
Inherited from Element.extendElementData
- Defined in src/lib/models/element.ts:396

getAttributeDefinition

getAttributeDefinition(attribute): undefined | AttributeDefinition
Parameters
- attribute: string
Returns undefined | AttributeDefinition
Inherited from Element.getAttributeDefinition
- Defined in src/lib/models/element.ts:1461

getAttributeElementValue

getAttributeElementValue<T>(attribute, onlyModel?): undefined | T[]
Type Parameters
- T extends Element
Parameters
- attribute: string
- Optional onlyModel: (new (...params) => T)
  - - new (...params): T
    - Parameters
      
      Rest ...params: unknown[]
      
      Returns T
Returns undefined | T[]
Inherited from Element.getAttributeElementValue
- Defined in src/lib/models/element.ts:498

getAttributeFile

getAttributeFile(attribute): undefined | AttributeFileData
Parameters
- attribute: string
Returns undefined | AttributeFileData
Inherited from Element.getAttributeFile
- Defined in src/lib/models/element.ts:469

getAttributeFirstFileUri

getAttributeFirstFileUri(attribute, size?): undefined | string
Parameters
- attribute: string
- size: eDocuImageSize = 'download'
Returns undefined | string
Inherited from Element.getAttributeFirstFileUri
- Defined in src/lib/models/element.ts:477

getAttributeRawValue

getAttributeRawValue(attribute): undefined | AttributeValue
Parameters
- attribute: string
Returns undefined | AttributeValue
Inherited from Element.getAttributeRawValue
- Defined in src/lib/models/element.ts:1560

getAttributeTextValue

getAttributeTextValue(attribute): string
Parameters
- attribute: string
Returns string
Inherited from Element.getAttributeTextValue
- Defined in src/lib/models/element.ts:515

getAttributeType

getAttributeType(attributeKey): undefined | AttributeType
Parameters
- attributeKey: string
Returns undefined | AttributeType
Inherited from Element.getAttributeType
- Defined in src/lib/models/element.ts:1420

getAttributeValue

getAttributeValue(attribute): undefined | AttributeValue | AttributeFileData
Parameters
- attribute: string
Returns undefined | AttributeValue | AttributeFileData
Inherited from Element.getAttributeValue
- Defined in src/lib/models/element.ts:1577

getChangeListenerTopic

getChangeListenerTopic(): undefined | string
Returns undefined | string
Inherited from Element.getChangeListenerTopic
- Defined in src/lib/models/element.ts:201

getConditionalData

getConditionalData(): null | {
hash: string;
value: string;
}
Returns null | {
hash: string;
value: string;
}
- Defined in src/lib/models/_default/checkPoint.ts:41

getEditableAttributes

getEditableAttributes(): string[]
Returns string[]
Inherited from Element.getEditableAttributes
- Defined in src/lib/models/element.ts:383

getEffects

getEffects(attribute): {
    backgroundColor?: string;
    prefix?: string;
    suffix?: string;
    textColor?: string;
}
Parameters
- attribute: string
Returns {
    backgroundColor?: string;
    prefix?: string;
    suffix?: string;
    textColor?: string;
}
- Optional backgroundColor?: string
- Optional prefix?: string
- Optional suffix?: string
- Optional textColor?: string
Inherited from Element.getEffects
- Defined in src/lib/models/element.ts:1664

getEvaluatedEffects

getEvaluatedEffects(template?): Record<string, {
    backgroundColor?: string;
    prefix?: string;
    suffix?: string;
    textColor?: string;
}>
Parameters
- Optional template: Template
Returns Record<string, {
    backgroundColor?: string;
    prefix?: string;
    suffix?: string;
    textColor?: string;
}>
Inherited from Element.getEvaluatedEffects
- Defined in src/lib/models/element.ts:1686

getLocalFiles

getLocalFiles(modified): {
fileAttributes: string[];
files: PreparedFiles<PlatformFile>[];
}
Parameters
- modified: DehydratedElementData
Returns {
fileAttributes: string[];
files: PreparedFiles<PlatformFile>[];
}
- fileAttributes: string[]
- files: PreparedFiles<PlatformFile>[]
Inherited from Element.getLocalFiles
- Defined in src/lib/models/element.ts:1036

getPrefilledAttributes

getPrefilledAttributes(): Record<string, AttributeValue>
Returns Record<string, AttributeValue>
Inherited from Element.getPrefilledAttributes
- Defined in src/lib/models/element.ts:268

hydrateRelationElements

hydrateRelationElements(): void
Returns void
Inherited from Element.hydrateRelationElements
- Defined in src/lib/models/element.ts:1600

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from Element.initialize
- Defined in src/lib/models/element.ts:364

instantiateReferences

instantiateReferences(references): Record<string, Element[]>
Parameters
- references: {
  [attribute: string]: ElementData[];
  }
  - [attribute: string]: ElementData[]
Returns Record<string, Element[]>
Inherited from Element.instantiateReferences
- Defined in src/lib/models/element.ts:963

isAttributeMultiple

isAttributeMultiple(attributeKey): boolean
Parameters
- attributeKey: string
Returns boolean
Inherited from Element.isAttributeMultiple
- Defined in src/lib/models/element.ts:1429

loadAttributes

loadAttributes(attributes): Promise<boolean>
Parameters
- attributes: string[]
Returns Promise<boolean>
Inherited from Element.loadAttributes
- Defined in src/lib/models/element.ts:789

loadData

loadData(force?, queryParams?): Promise<undefined | ApiResponse<GetElementV1Response | GetElementV2Response, MembraneGetError>>
Parameters
- force: boolean = false
- Optional queryParams: ElementGetQueryParams
Returns Promise<undefined | ApiResponse<GetElementV1Response | GetElementV2Response, MembraneGetError>>
Inherited from Element.loadData
- Defined in src/lib/models/element.ts:587

loadElementQuery

loadElementQuery(queryParams): Promise<undefined | GetElementV1Response | GetElementV2Response>
Parameters
- queryParams: ElementGetQueryParams
Returns Promise<undefined | GetElementV1Response | GetElementV2Response>
Inherited from Element.loadElementQuery
- Defined in src/lib/models/element.ts:566

loadRaw

loadRaw(force?): Promise<undefined | ApiResponse<GetElementV1Response | GetElementV2Response, MembraneGetError>>
Parameters
- force: boolean = false
Returns Promise<undefined | ApiResponse<GetElementV1Response | GetElementV2Response, MembraneGetError>>
Inherited from Element.loadRaw
- Defined in src/lib/models/element.ts:561

loadRelation

loadRelation(relation): Promise<void>
Parameters
- relation: string
Returns Promise<void>
Inherited from Element.loadRelation
- Defined in src/lib/models/element.ts:980

performUpdate

performUpdate(modified, original): Promise<boolean>
Parameters
- modified: ElementAttributeData
- original: ElementAttributeData
Returns Promise<boolean>
Inherited from Element.performUpdate
- Defined in src/lib/models/element.ts:1615

registerChangeListener

registerChangeListener(): (() => void)
Returns (() => void)
- - (): void
  - Returns void
Inherited from Element.registerChangeListener
- Defined in src/lib/models/element.ts:208

setAttributeValue

setAttributeValue(attribute, value, isPublic?): boolean
Parameters
- attribute: string
- value: undefined | AttributeValue | AttributeFileData
- Optional isPublic: boolean
Returns boolean
Inherited from Element.setAttributeValue
- Defined in src/lib/models/element.ts:1480

setAttributes

setAttributes(values): Record<string, boolean>
Parameters
- values: ElementFormData
Returns Record<string, boolean>
Inherited from Element.setAttributes
- Defined in src/lib/models/element.ts:458

setResponseScopeData

setResponseScopeData(response?): void
Parameters
- Optional response: GetElementV1Response | GetElementV2Response
Returns void
Inherited from Element.setResponseScopeData
- Defined in src/lib/models/element.ts:746

togglePublishAttributes

togglePublishAttributes(publish): Promise<boolean>
Parameters
- publish: boolean
Returns Promise<boolean>
Inherited from Element.togglePublishAttributes
- Defined in src/lib/models/element.ts:992

unarchive

unarchive(): Promise<boolean>
Returns Promise<boolean>
Inherited from Element.unarchive
- Defined in src/lib/models/element.ts:1329

update

update(data?): Promise<boolean>
Parameters
- data: ElementFormData = {}
Returns Promise<boolean>
Inherited from Element.update
- Defined in src/lib/models/element.ts:1072

updateDataHash

updateDataHash(): void
Returns void
Inherited from Element.updateDataHash
- Defined in src/lib/models/element.ts:1022

uploadFiles

uploadFiles(files): Promise<void | {
    error?: Error;
    files: PreparedFiles<PlatformFile>[];
    ok: boolean;
}>
Parameters
- files: PreparedFiles<PlatformFile>[]
Returns Promise<void | {
    error?: Error;
    files: PreparedFiles<PlatformFile>[];
    ok: boolean;
}>
Inherited from Element.uploadFiles
- Defined in src/lib/models/element.ts:1136

`Static` GET_QUERY_PARAMS

GET_QUERY_PARAMS(): ElementGetQueryParams
Returns ElementGetQueryParams
Inherited from Element.GET_QUERY_PARAMS
- Defined in src/lib/models/element.ts:1243

`Static` LISTING_PRESETS

LISTING_PRESETS(_mainStore, _payload?): IListingConfig[]
Parameters
- _mainStore: MainStore
- Optional _payload: string
Returns IListingConfig[]
Inherited from Element.LISTING_PRESETS
- Defined in src/lib/models/element.ts:1252

`Static` LISTING_TITLE

LISTING_TITLE(mainStore, _preset?): string
Parameters
- mainStore: MainStore
- Optional _preset: IListingConfig
Returns string
Inherited from Element.LISTING_TITLE
- Defined in src/lib/models/element.ts:1248

`Static` dehydrateAttributeValue

dehydrateAttributeValue(value): DehydratedAttributeValue
Parameters
- value: AttributeValue
Returns DehydratedAttributeValue
Inherited from Element.dehydrateAttributeValue
- Defined in src/lib/models/element.ts:1380

`Static` dehydrateData

dehydrateData(element): DehydratedElementData
Parameters
- element: Partial<ElementData>
Returns DehydratedElementData
Inherited from Element.dehydrateData
- Defined in src/lib/models/element.ts:1355

`Static` dehydrateDataAndUnwrapValues

dehydrateDataAndUnwrapValues(element): Record<string, AttributeFileData | DehydratedAttributeValue>
Parameters
- element: Partial<ElementData>
Returns Record<string, AttributeFileData | DehydratedAttributeValue>
Inherited from Element.dehydrateDataAndUnwrapValues
- Defined in src/lib/models/element.ts:1335

Class CheckPoint

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: any

Returns CheckPoint

Properties

autoSave

Optional changeListenerRef

Type declaration

Returns void

children

Optional childrenCount

childrenData

completeData

Optional data

Optional dataHash

dirty

effects

Optional errored

hash

interalListingHashes

listeners

Type declaration

Returns void

loading

loadingPromise

onChangeDataHash

Type declaration

Returns void

Optional originalData

Optional parent

Optional predecessors

Optional predecessorsCount

references

Type declaration

[attribute: string]: Element[]

relationElements

Type declaration

[attribute: string]: Element[]

saveHandler

Type declaration

Returns void

source

store

workRecords

Optional workRecordsCount

Accessors

displayType

Returns string

elementName

Returns string

elementSchemaId

Returns undefined | string

mapLabel

Returns null | string

markerConfig

Returns MarkerConfig

options

Returns undefined | string[]

organization

Returns undefined | string

pointType

Returns CheckPointType

privileges

Returns undefined | ElementPrivileges

shouldCreateFinding

Returns boolean

sortValue

Returns string

template

Returns undefined | Template | ElementTemplateV1

type

Returns undefined | string

`Rest` ...args: any

`Optional` changeListenerRef

`Optional` childrenCount

`Optional` data

`Optional` dataHash

`Optional` errored

`Optional` originalData

`Optional` parent

`Optional` predecessors

`Optional` predecessorsCount

`Optional` workRecordsCount

`Static` ATTRIBUTES

`Static` DISABLED_ATTRIBUTES

`Static` GEO_RELATION_ATTRIBUTES

`Static` LINEVIEW_ATTRIBUTES

`Static` PREVIEW_ATTRIBUTES

`Static` SHORTNAME

`Static` TYPE

`Optional` data: Partial<ElementData>