Code Documentation for ccf-rui
  1. Miscellaneous
  2. Functions

Index

src/app/shared/utils/doi.ts

addDoiBaseUrl
addDoiBaseUrl(value: string)

Adds the doi base if not already present

Parameters :
Name Type Optional
value string No
Returns : string
normalizeDoi
normalizeDoi(value: string)

Normalizes a doi id

Parameters :
Name Type Optional
value string No
Returns : string | undefined
removeDoiBase
removeDoiBase(value: string)

Removes the doi base and prefix

Parameters :
Name Type Optional
value string No
Returns : string

src/app/shared/utils/orcid.ts

addOrcidBaseUrl
addOrcidBaseUrl(value: string)

Adds the ORCID base URL to a given value if it does not already start with it.

Parameters :
Name Type Optional Description
value string No
  • The value to which the ORCID base URL should be added.
Returns : string

The value with the ORCID base URL prepended if it was not already present.
normalizeOrcid
normalizeOrcid(value: string)

Normalizes an ORCID identifier by removing the base URL and hyphens, then reformatting it with hyphens and adding the base URL back.

Parameters :
Name Type Optional Description
value string No
  • The ORCID identifier to be normalized.
Returns : string | undefined

The normalized ORCID identifier with the base URL, or undefined if the input is invalid.
removeOrcidBaseUrl
removeOrcidBaseUrl(value: string)

Removes the ORCID base URL from a given value if it starts with it.

Parameters :
Name Type Optional Description
value string No
  • The value from which the ORCID base URL should be removed.
Returns : string

The value without the ORCID base URL.

src/app/core/store/reference-data/reference-data.state.ts

applySpatialPlacement
applySpatialPlacement(tx: Matrix4, placement: Immutable)

Applies spatial placement transformations to a matrix.

Parameters :
Name Type Optional Description
tx Matrix4 No

The matrix to apply transformations to.
placement Immutable No

The spatial placement data.
Returns : Matrix4

The transformed matrix.

src/app/modules/metadata/donor-form/metadata-donor-form.component.ts

filterAutocompleteOptions
filterAutocompleteOptions(options: Signal, source, getValue)

Filters a set of options based on the user input. The filtering is case insensitive and ptions are returned in alphabetical order using the default locale. Empty inputs (null, undefined, or '') return all options.

Parameters :
Name Type Optional Description
options Signal No

Autocomplete options
source No

User input
getValue No

Accessor to get the search text for an item
Returns : Signal<T[]>

The options that matches the current user input

src/app/core/store/scene/scene.state.ts

getNodeBbox
getNodeBbox(model: SpatialSceneNode)

Compute the bounding box for a node

Parameters :
Name Type Optional Description
model SpatialSceneNode No

Node
Returns : AABB

Bounding box

src/app/core/services/config/config.ts

globalConfigFactory
globalConfigFactory(globals: GlobalsService)

Factory function to create the global configuration object.

Parameters :
Name Type Optional Description
globals GlobalsService No

The GlobalsService instance.
Returns : GlobalConfig

The global configuration object.

src/app/app-web-component.component.ts

parseOrgan
parseOrgan(value)

Tries to parse the input value as an Organ using BUILTIN_PARSERS.json. If parsing fails, returns the value as a string.

Parameters :
Name Optional Description
value No

input value
Returns : string | Organ

organ

src/app/core/store/registration/registration.state.ts

undefIfNaN
undefIfNaN(value: number)

Returns undefined if number is not a number, otherwise returns the number

Parameters :
Name Type Optional
value number No
Returns : number | undefined

results matching ""

    No results matching ""