Class InlineSvg

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractPattern<InlineSvgConfig>
- InlineSvg

Implements

IInlineSvg

Constructors

constructor

new InlineSvg(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.InlineSvg.InlineSvg
Creates an instance of InlineSvg.
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.InlineSvg.InlineSvg

Memberof
InlineSvg
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:23

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

`Protected`_enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

Methods

`Protected`finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected`triggerPlatformEventCallback

triggerPlatformEventCallback(
platFormCallback: OSGeneric,
...args: unknown[],
): void
Protected
Triggers a generic platform event.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Returns void

Memberof
AbstractPattern
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected`unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Abstract`registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register a given callback event handler.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IInlineSvg.registerCallback

Inherited from AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:44

`Protected`setCallbacks

setCallbacks(): void
Protected
Set the callbacks that will be assigned to the pattern.

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:54

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Set the html references that will be used to manage the cssClasses and atribute properties.

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:64

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Unset the callbacks that will be assigned to the pattern.

Returns void

Memberof
InlineSvg
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:74

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Reassign the HTML elements to undefined, preventing memory leaks.

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:84

applyA11YProperties

applyA11YProperties(options: string): void
Method to apply the A11Y properties to the InlineSvg
Parameters
- options: string
Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:94

build

build(): void
Method to build the InlineSVG

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Implementation of IInlineSvg.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:140

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update value when a parameters changed occurs.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Implementation of IInlineSvg.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:155

dispose

dispose(): void
Destroy the InlineSvg

Returns void

Memberof
OSFramework.Patterns.InlineSvg.InlineSvg
Implementation of IInlineSvg.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/InlineSvg/InlineSvg.ts:171