Class Element

constructor

• new Element(
      store: MainStore,
      hash: string,
      data?: ElementData,
      shouldLoad?: boolean,
  ): Element

• Parameters

  • store: MainStore
  • hash: string
  • Optionaldata: ElementData
  • shouldLoad: boolean = false

  Returns Element

autoSave

OptionalchangeListenerRef

children

OptionalchildrenCount

childrenData

completeData

Optionaldata

OptionaldataHash

dirty

effects

Optionalerrored

hash

interalListingHashes

listeners

loading

loadingPromise

onChangeDataHash

OptionaloriginalData

Optionalparent

Optionalpredecessors

OptionalpredecessorsCount

references

relationElements

saveHandler

source

store

workRecords

OptionalworkRecordsCount

displayType

• get displayType(): string

• Returns string

elementName

• get elementName(): string

• Returns string

elementSchemaId

• get elementSchemaId(): undefined | string

• Returns undefined | string

mapLabel

• get mapLabel(): null | string

• Returns null | string

markerConfig

• get markerConfig(): MarkerConfig

• Returns MarkerConfig

organization

• get organization(): undefined | string

• Returns undefined | string

privileges

• get privileges(): undefined | ElementPrivileges

• Returns undefined | ElementPrivileges

sortValue

• get sortValue(): string

• Returns string

template

• get template(): undefined | Template | ElementTemplateV1

• Returns undefined | Template | ElementTemplateV1

type

• get type(): undefined | string

• Returns undefined | string

typeData

• get typeData(): undefined | ElementSchema | AttributeDefinitions

• Returns undefined | ElementSchema | AttributeDefinitions

StaticATTRIBUTES

• get ATTRIBUTES(): {
      ARCHIVED: string;
      ELEMENT_NAME: string;
      ELEMENT_PARENT: string;
  }

• Returns { ARCHIVED: string; ELEMENT_NAME: string; ELEMENT_PARENT: string }

StaticDISABLED_ATTRIBUTES

• get DISABLED_ATTRIBUTES(): string[]

• Returns string[]

StaticGEO_RELATION_ATTRIBUTES

• get GEO_RELATION_ATTRIBUTES(): string[]

• Returns string[]

StaticLINEVIEW_ATTRIBUTES

• get LINEVIEW_ATTRIBUTES(): string[]

• Returns string[]

StaticPREVIEW_ATTRIBUTES

• get PREVIEW_ATTRIBUTES(): string[]

• Returns string[]

StaticSHORTNAME

• get SHORTNAME(): string

• Returns string

StaticTYPE

• get TYPE(): string

• Returns string

addInteralListingHash

• addInteralListingHash(hash: string): void

• Parameters

  • hash: string

  Returns void

archive

• archive(): Promise<boolean>

• Returns Promise<boolean>

attributeExists

• attributeExists(attribute: string): boolean

• Parameters

  • attribute: string

  Returns boolean

autoUpdate

• autoUpdate(): undefined | false | Promise<boolean>

• Returns undefined | false | Promise<boolean>

computeEffects

• computeEffects(template: Template): void

• Parameters

  • template: Template

  Returns void

createCountingWorkRecord

• createCountingWorkRecord(data: WorkRecordData): Promise<undefined | IWorkRecord>

• Parameters

  • data: WorkRecordData

  Returns Promise<undefined | IWorkRecord>

createWorkRecord

• createWorkRecord(data: WorkRecordData): Promise<undefined | IWorkRecord>

• Parameters

  • data: WorkRecordData

  Returns Promise<undefined | IWorkRecord>

destructor

• destructor(): void

• Returns void

dispose

• dispose(): void

• Returns void

extendElementData

• extendElementData(
      data?: Partial<ElementData>,
      onlyAcceptNewerTimestamp?: boolean,
  ): void

• Parameters

  • Optionaldata: Partial<ElementData>
  • onlyAcceptNewerTimestamp: boolean = false

  Returns void

getAttributeDefinition

• getAttributeDefinition(attribute: string): undefined | AttributeDefinition

• Parameters

  • attribute: string

  Returns undefined | AttributeDefinition

getAttributeElementValue

• getAttributeElementValue<T extends Element>(
      attribute: string,
      onlyModel?: new (...params: unknown[]) => T,
  ): undefined | T[]

• Type Parameters

  • T extends Element

  Parameters

  • attribute: string
  • OptionalonlyModel: new (...params: unknown[]) => T

  Returns undefined | T[]

getAttributeFile

• getAttributeFile(attribute: string): undefined | AttributeFileData

• Parameters

  • attribute: string

  Returns undefined | AttributeFileData

getAttributeFirstFileUri

• getAttributeFirstFileUri(
      attribute: string,
      size?: eDocuImageSize,
  ): undefined | string

• Parameters

  • attribute: string
  • size: eDocuImageSize = 'download'

  Returns undefined | string

getAttributeRawValue

• getAttributeRawValue(attribute: string): undefined | AttributeValue

• Parameters

  • attribute: string

  Returns undefined | AttributeValue

getAttributeTextValue

• getAttributeTextValue(attribute: string): string

• Parameters

  • attribute: string

  Returns string

getAttributeType

• getAttributeType(attributeKey: string): undefined | AttributeType

• Parameters

  • attributeKey: string

  Returns undefined | AttributeType

getAttributeValue

• getAttributeValue(
      attribute: string,
  ): undefined | AttributeValue | AttributeFileData

• Parameters

  • attribute: string

  Returns undefined | AttributeValue | AttributeFileData

getChangeListenerTopic

• getChangeListenerTopic(): undefined | string

• Returns undefined | string

getEditableAttributes

• getEditableAttributes(): string[]

• Returns string[]

getEffects

• getEffects(
      attribute: string,
  ): {
      backgroundColor?: string;
      prefix?: string;
      suffix?: string;
      textColor?: string;
  }

• Parameters

  • attribute: string

  Returns {
      backgroundColor?: string;
      prefix?: string;
      suffix?: string;
      textColor?: string;
  }

getEvaluatedEffects

• getEvaluatedEffects(
      template?: Template,
  ): Record<
      string,
      {
          backgroundColor?: string;
          prefix?: string;
          suffix?: string;
          textColor?: string;
      },
  >

• Parameters

  • Optionaltemplate: Template

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

getLocalFiles

• getLocalFiles(
      modified: DehydratedElementData,
  ): { fileAttributes: string[]; files: PreparedFiles[] }

• Parameters

  • modified: DehydratedElementData

  Returns { fileAttributes: string[]; files: PreparedFiles[] }

getPrefilledAttributes

• getPrefilledAttributes(): Record<string, AttributeValue>

• Returns Record<string, AttributeValue>

hydrateRelationElements

• hydrateRelationElements(): void

• Returns void

initialize

• initialize(): Promise<void>

• Returns Promise<void>

instantiateReferences

• instantiateReferences(
      references: { [attribute: string]: ElementData[] },
  ): Record<string, Element[]>

• Parameters

  • references: { [attribute: string]: ElementData[] }

  Returns Record<string, Element[]>

isAttributeMultiple

• isAttributeMultiple(attributeKey: string): boolean

• Parameters

  • attributeKey: string

  Returns boolean

loadAttributes

• loadAttributes(attributes: string[]): Promise<boolean>

• Parameters

  • attributes: string[]

  Returns Promise<boolean>

loadData

• loadData(
      force?: boolean,
      queryParams?: ElementGetQueryParams,
  ): Promise<
      | undefined
      | ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

• Parameters

  • force: boolean = false
  • OptionalqueryParams: ElementGetQueryParams

  Returns Promise<
      | undefined
      | ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

loadElementQuery

• loadElementQuery(
      queryParams: ElementGetQueryParams,
  ): Promise<undefined | GetElementV1Response | GetElementV2Response>

• Parameters

  • queryParams: ElementGetQueryParams

  Returns Promise<undefined | GetElementV1Response | GetElementV2Response>

loadRaw

• loadRaw(
      force?: boolean,
  ): Promise<
      | undefined
      | ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

• Parameters

  • force: boolean = false

  Returns Promise<
      | undefined
      | ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

loadRelation

• loadRelation(relation: string): Promise<void>

• Parameters

  • relation: string

  Returns Promise<void>

performFileAction

• performFileAction(
      action: "archived" | "relevant",
      attribute: string,
      fileHash: string,
  ): Promise<void>

• Parameters

  • action: "archived" | "relevant"
  • attribute: string
  • fileHash: string

  Returns Promise<void>

performUpdate

• performUpdate(
      modified: ElementAttributeData,
      original: ElementAttributeData,
  ): Promise<boolean>

• Parameters

  • modified: ElementAttributeData
  • original: ElementAttributeData

  Returns Promise<boolean>

registerChangeListener

• registerChangeListener(): () => void

• Returns () => void

setAttributes

• setAttributes(values: ElementFormData): Record<string, boolean>

• Parameters

  • values: ElementFormData

  Returns Record<string, boolean>

setAttributeValue

• setAttributeValue(
      attribute: string,
      value: undefined | AttributeValue | AttributeFileData,
      isPublic?: boolean,
  ): boolean

• Parameters

  • attribute: string
  • value: undefined | AttributeValue | AttributeFileData
  • OptionalisPublic: boolean

  Returns boolean

setResponseScopeData

• setResponseScopeData(
      response?: GetElementV1Response | GetElementV2Response,
  ): void

• Parameters

  • Optionalresponse: GetElementV1Response | GetElementV2Response

  Returns void

togglePublishAttributes

• togglePublishAttributes(publish: boolean): Promise<boolean>

• Parameters

  • publish: boolean

  Returns Promise<boolean>

unarchive

• unarchive(): Promise<boolean>

• Returns Promise<boolean>

update

• update(data?: ElementFormData): Promise<boolean>

• Parameters

  • data: ElementFormData = {}

  Returns Promise<boolean>

updateDataHash

• updateDataHash(): void

• Returns void

uploadFiles

• uploadFiles(
      files: PreparedFiles[],
  ): Promise<void | { error?: Error; files: PreparedFiles[]; ok: boolean }>

• Parameters

  • files: PreparedFiles[]

  Returns Promise<void | { error?: Error; files: PreparedFiles[]; ok: boolean }>

StaticdehydrateAttributeValue

• dehydrateAttributeValue(value: AttributeValue): DehydratedAttributeValue

• Parameters

  • value: AttributeValue

  Returns DehydratedAttributeValue

StaticdehydrateData

• dehydrateData(element: Partial<ElementData>): DehydratedElementData

• Parameters

  • element: Partial<ElementData>

  Returns DehydratedElementData

StaticdehydrateDataAndUnwrapValues

• dehydrateDataAndUnwrapValues(
      element: Partial<ElementData>,
  ): Record<string, AttributeFileData | DehydratedAttributeValue>

• Parameters

  • element: Partial<ElementData>

  Returns Record<string, AttributeFileData | DehydratedAttributeValue>

StaticGET_QUERY_PARAMS

• GET_QUERY_PARAMS(): ElementGetQueryParams

• Returns ElementGetQueryParams

StaticLISTING_PRESETS

• LISTING_PRESETS(_mainStore: MainStore, _payload?: string): IListingConfig[]

• Parameters

  • _mainStore: MainStore
  • Optional_payload: string

  Returns IListingConfig[]

StaticLISTING_TITLE

• LISTING_TITLE(mainStore: MainStore, _preset?: IListingConfig): string

• Parameters

  • mainStore: MainStore
  • Optional_preset: IListingConfig

  Returns string