Class ListingConfig

Hierarchy (View Summary)

Element
- ListingConfig

Index

Constructors

Methods

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

Constructors

constructor

new ListingConfig(...args: any): ListingConfig
Parameters
- ...args: any
Returns ListingConfig
Overrides Element.constructor
- Defined in src/lib/models/_default/listingConfig.ts:18

Properties

autoSave

autoSave: boolean = true

`Optional`changeListenerRef

changeListenerRef?: () => void

children

children: Element[] = []

`Optional`childrenCount

childrenCount?: number = undefined

childrenData

childrenData: ElementData[] = []

completeData

completeData: boolean = false

`Optional`data

data?: ElementData = undefined

`Optional`dataHash

dataHash?: string = undefined

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[] = []

loading

loading: boolean = false

loadingPromise

loadingPromise: undefined | Promise<unknown> = undefined

onChangeDataHash

onChangeDataHash: () => void

`Optional`originalData

originalData?: ElementData = undefined

`Optional`parent

parent?: Element

`Optional`predecessors

predecessors?: Element[] = undefined

`Optional`predecessorsCount

predecessorsCount?: number = undefined

references

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

relationElements

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

saveHandler

saveHandler: () => void

source

source: DataSource = 'backend'

store

store: MainStore

workRecords

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

`Optional`workRecordsCount

workRecordsCount?: number = undefined

Accessors

config

get config(): null | IListingConfig
Returns null | IListingConfig
- Defined in src/lib/models/_default/listingConfig.ts:58

displayType

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

elementName

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

elementSchemaId

get elementSchemaId(): undefined | `${string}/${Type}`
Returns undefined | `${string}/${Type}`
Inherited from Element.elementSchemaId
- Defined in src/lib/models/element.ts:1484

exports

get exports(): ListingExportConfig[]
Returns ListingExportConfig[]
- Defined in src/lib/models/_default/listingConfig.ts:79

mapLabel

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

markerConfig

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

organization

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

privileges

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

sortValue

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

template

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

type

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

typeData

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

value

get value(): null | { exports: ListingExportConfig[]; query: unknown }
The config attribute: either the listing query itself (as it always was), or {query, exports} with the export forms of this listing.

Returns null | { exports: ListingExportConfig[]; query: unknown }
- Defined in src/lib/models/_default/listingConfig.ts:37

`Static`ATTRIBUTES

get ATTRIBUTES(): {
    ARCHIVED: string;
    CONFIG: string;
    CONFIG_VERSION: string;
    DEFAULT_ACTIVE: string;
    ELEMENT_NAME: string;
    ELEMENT_PARENT: string;
    TYPE_OF_USAGE: string;
}
Returns {
    ARCHIVED: string;
    CONFIG: string;
    CONFIG_VERSION: string;
    DEFAULT_ACTIVE: string;
    ELEMENT_NAME: string;
    ELEMENT_PARENT: string;
    TYPE_OF_USAGE: string;
}
Overrides Element.ATTRIBUTES
- Defined in src/lib/models/_default/listingConfig.ts:101

`Static`DISABLED_ATTRIBUTES

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

`Static`GEO_RELATION_ATTRIBUTES

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

`Static`LINEVIEW_ATTRIBUTES

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

`Static`PREVIEW_ATTRIBUTES

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

`Static`SHORTNAME

get SHORTNAME(): string
Returns string
Overrides Element.SHORTNAME
- Defined in src/lib/models/_default/listingConfig.ts:111

`Static`TYPE

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

Methods

addInteralListingHash

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

attributeExists

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

autoUpdate

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

computeEffects

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

configWithExports

configWithExports(exports: ListingExportConfig[]): string
config attribute value with new export forms; the query stays.
Parameters
- exports: ListingExportConfig[]
Returns string
- Defined in src/lib/models/_default/listingConfig.ts:89

configWithQuery

configWithQuery(query: IListingConfig): string
config attribute value with a new query; the export forms stay.
Parameters
- query: IListingConfig
Returns string
- Defined in src/lib/models/_default/listingConfig.ts:84

createCountingWorkRecord

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

createWorkRecord

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

destructor

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

dispose

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

extendElementData

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

getAttributeDefinition

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

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[]
Inherited from Element.getAttributeElementValue
- Defined in src/lib/models/element.ts:565

getAttributeFile

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

getAttributeFirstFileUri

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

getAttributeRawValue

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

getAttributeTextValue

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

getAttributeType

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

getAttributeValue

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

getChangeListenerTopic

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

getEditableAttributes

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

getEffects

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

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;
    },
>
Inherited from Element.getEvaluatedEffects
- Defined in src/lib/models/element.ts:1787

getLocalFiles

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

getPrefilledAttributes

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

hydrateRelationElements

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

initialize

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

instantiateReferences

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

isAttributeMultiple

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

loadAttributes

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

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,
    >,
>
Inherited from Element.loadData
- Defined in src/lib/models/element.ts:665

loadElementQuery

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

loadRaw

loadRaw(
    force?: boolean,
): 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:639

loadRelation

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

performFileAction

performFileAction(
    action: "archived" | "relevant" | "public",
    attribute: string,
    fileHash: string,
): Promise<void>
Parameters
- action: "archived" | "relevant" | "public"
- attribute: string
- fileHash: string
Returns Promise<void>
Inherited from Element.performFileAction
- Defined in src/lib/models/element.ts:1342

performUpdate

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

registerChangeListener

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

setAttributes

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

setAttributeValue

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

setResponseScopeData

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

togglePublishAttributes

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

unarchive

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

update

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

updateDataHash

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

uploadFiles

uploadFiles(
    files: PreparedFiles<PlatformFile>[],
): 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:1215

`Static`dehydrateAttributeValue

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

`Static`dehydrateData

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

`Static`dehydrateDataAndUnwrapValues

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

`Static`GET_QUERY_PARAMS

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

`Static`LISTING_PRESETS

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

`Static`LISTING_TITLE

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

`Static`serializeConfig

serializeConfig(query: unknown, exports?: ListingExportConfig[]): string
Stays the bare query while there are no exports, as older readers expect.
Parameters
- query: unknown
- exports: ListingExportConfig[] = []
Returns string
- Defined in src/lib/models/_default/listingConfig.ts:94

Class ListingConfig

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ListingConfig

Properties

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

Accessors

config

Returns null | IListingConfig

displayType

Returns string

elementName

Returns string

elementSchemaId

Returns undefined | `${string}/${Type}`

exports

Returns ListingExportConfig[]

mapLabel

Returns null | string

markerConfig

Returns MarkerConfig

organization

Returns undefined | string

privileges

Returns undefined | ElementPrivileges

sortValue

Returns string

template

Returns undefined | Template | ElementTemplateV1

type

Returns undefined | string

typeData

Returns undefined | ElementSchema | AttributeDefinitions

value

Returns null | { exports: ListingExportConfig[]; query: unknown }

StaticATTRIBUTES

Returns { ARCHIVED: string; CONFIG: string; CONFIG_VERSION: string; DEFAULT_ACTIVE: string; ELEMENT_NAME: string; ELEMENT_PARENT: string; TYPE_OF_USAGE: string;}

StaticDISABLED_ATTRIBUTES

Returns string[]

StaticGEO_RELATION_ATTRIBUTES

Returns string[]

StaticLINEVIEW_ATTRIBUTES

Returns string[]

StaticPREVIEW_ATTRIBUTES

Returns string[]

StaticSHORTNAME

`Optional`changeListenerRef

`Optional`childrenCount

`Optional`data

`Optional`dataHash

`Optional`errored

`Optional`originalData

`Optional`parent

`Optional`predecessors

`Optional`predecessorsCount

`Optional`workRecordsCount

`Static`ATTRIBUTES

Returns {
ARCHIVED: string;
CONFIG: string;
CONFIG_VERSION: string;
DEFAULT_ACTIVE: string;
ELEMENT_NAME: string;
ELEMENT_PARENT: string;
TYPE_OF_USAGE: string;
}

`Static`DISABLED_ATTRIBUTES

`Static`GEO_RELATION_ATTRIBUTES

`Static`LINEVIEW_ATTRIBUTES

`Static`PREVIEW_ATTRIBUTES

`Static`SHORTNAME

`Static`TYPE

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