Shape | webapi-parser

Hierarchy

DomainElement
- Shape

Implements

Index

Properties

Properties

and

and: Shape[]

customDomainProperties

customDomainProperties: DomainExtension[]

defaultValue

defaultValue: DataNode

defaultValueStr

defaultValueStr: StrField

deprecated

deprecated: BoolField

description

description: StrField

displayName

displayName: StrField

extendsNode

extendsNode: DomainElement[]

id

id: string

inherits

inherits: Shape[]

isLink

isLink: boolean

linkLabel

linkLabel: StrField

linkTarget

linkTarget: DomainElement | undefined

location

location: string

name

not

not: Shape

or

or: Shape[]

position

position: Range

readOnly

readOnly: BoolField

values

values: DataNode[]

writeOnly

writeOnly: BoolField

xone

xone: Shape[]

Methods

annotations

annotations(): any

Implementation of Annotable.annotations

Inherited from DomainElement.annotations
- Defined in amf-client-js.d.ts:599
Returns any

graph

graph(): Graph

Inherited from DomainElement.graph
- Defined in amf-client-js.d.ts:607
Returns Graph

link

link(): Shape

- Defined in amf-client-js.d.ts:811
Returns Shape

linkCopy

linkCopy(): Linkable

- Defined in amf-client-js.d.ts:805
Returns Linkable

withAnd

withAnd(subShapes: Shape[]): this

- Defined in amf-client-js.d.ts:790
Parameters
- subShapes: Shape[]
Returns this

withCustomDomainProperties

withCustomDomainProperties(extensions: DomainExtension[]): this

Inherited from DomainElement.withCustomDomainProperties
- Defined in amf-client-js.d.ts:601
Parameters
- extensions: DomainExtension[]
Returns this

withDefaultStr

withDefaultStr(value: string): this

- Defined in amf-client-js.d.ts:796
Parameters
- value: string
Returns this

withDefaultValue

withDefaultValue(default_: DataNode): this

- Defined in amf-client-js.d.ts:782
Parameters
- default_: DataNode
Returns this

withDeprecated

withDeprecated(deprecated: boolean): this

- Defined in amf-client-js.d.ts:776
Parameters
- deprecated: boolean
Returns this

withDescription

withDescription(description: string): this

- Defined in amf-client-js.d.ts:780
Parameters
- description: string
Returns this

withDisplayName

withDisplayName(name: string): this

- Defined in amf-client-js.d.ts:778
Parameters
- name: string
Returns this

withExtendsNode

withExtendsNode(extension: ParametrizedDeclaration[]): this

Inherited from DomainElement.withExtendsNode
- Defined in amf-client-js.d.ts:603
Parameters
- extension: ParametrizedDeclaration[]
Returns this

withId

withId(id: string): this

Inherited from DomainElement.withId
- Defined in amf-client-js.d.ts:605
Parameters
- id: string
Returns this

withInherits

withInherits(inherits: Shape[]): this

- Defined in amf-client-js.d.ts:786
Parameters
- inherits: Shape[]
Returns this

withLinkLabel

withLinkLabel(label: string): this

- Defined in amf-client-js.d.ts:809
Parameters
- label: string
Returns this

withLinkTarget

withLinkTarget(target: Linkable): this

- Defined in amf-client-js.d.ts:807
Parameters
- target: Linkable
Returns this

withName

withName(name: string): this

- Defined in amf-client-js.d.ts:770
Parameters
- name: string
Returns this

withNode

withNode(shape: Shape): this

- Defined in amf-client-js.d.ts:794
Parameters
- shape: Shape
Returns this

withOr

withOr(subShapes: Shape[]): this

- Defined in amf-client-js.d.ts:788
Parameters
- subShapes: Shape[]
Returns this

withReadOnly

withReadOnly(readOnly: boolean): this

- Defined in amf-client-js.d.ts:772
Parameters
- readOnly: boolean
Returns this

withValues

withValues(values: DataNode[]): this

- Defined in amf-client-js.d.ts:784
Parameters
- values: DataNode[]
Returns this

withWriteOnly

withWriteOnly(writeOnly: boolean): this

- Defined in amf-client-js.d.ts:774
Parameters
- writeOnly: boolean
Returns this

withXone

withXone(subShapes: Shape[]): this

- Defined in amf-client-js.d.ts:792
Parameters
- subShapes: Shape[]
Returns this

Generated using TypeDoc