M2Doc Documentation

Services available for Sirius. You will have to set the "SiriusSession" option in the generation configuration. It must contains the .aird file URI.

asImage(representation: org.eclipse.sirius.viewpoint.DRepresentation) = MImage

Insert the image of the given representation if it's a diagram.

Expression Result
dRepresentation.asImage() insert the image of the given representation if it's a diagram

asImage(representation: org.eclipse.sirius.viewpoint.DRepresentation, refresh: boolean, layerNames: java.util.Set) = MImage

Insert the image of the given representation if it's a diagram.

Expression Result
dRepresentation.asImage(true, OrderedSet{'Layer 1', 'Layer 2'}) insert the image of the given representation if it's a diagram

asImageByRepresentationDescriptionName(eObject: org.eclipse.emf.ecore.EObject, representationDescriptionName: java.lang.String) = List

Gets the Sequence of images for the diagrams associated to the given EObject with the given description name.

Expression Result
ePackage.asImageByRepresentationDescriptionName('class diagram') Sequence{image1, image2}

asImageByRepresentationDescriptionName(eObject: org.eclipse.emf.ecore.EObject, representationDescriptionName: java.lang.String, refresh: boolean, layerNames: java.util.Set) = List

Gets the Sequence of images for the diagrams associated to the given EObject with the given description name.

Expression Result
ePackage.asImageByRepresentationDescriptionName('class diagram', true, OrderedSet{'Layer 1', 'Layer 2'}) Sequence{image1, image2}

asImageByRepresentationName(representationName: java.lang.String) = MImage

Insert the image of the given representation name.

Expression Result
'MyEPackage class diagram'.asImageByRepresentationName() insert the image

asImageByRepresentationName(representationName: java.lang.String, refresh: boolean, layerNames: java.util.Set) = MImage

Insert the image of the given representation name.

Expression Result
'MyEPackage class diagram'.asImageByRepresentationName(true, OrderedSet{'Layer 1', 'Layer 2'}) insert the image

asTable(representation: org.eclipse.sirius.table.metamodel.table.DTable) = MTable

Insert the table of the given representation table.

Expression Result
dTable.asTable() insert the tablee of the given representation table

asTableByRepresentationDescriptionName(eObject: org.eclipse.emf.ecore.EObject, representationDescriptionName: java.lang.String) = List

Gets the Sequence of tables for the tables associated to the given EObject with the given description name.

Expression Result
ePackage.asTableByRepresentationDescriptionName('dependency table') Sequence{table1, table2}

asTableByRepresentationName(representationName: java.lang.String) = MTable

Insert the table of the given representation name.

Expression Result
'MyEPackage class diagram'.asTableByRepresentationName() insert the table

isRepresentationDescriptionName(eObject: org.eclipse.emf.ecore.EObject, representationDescriptionName: java.lang.String) = boolean

Returns true if the arguments are not null, the eObject is in a session and there's a representation description with the specified name in it that is associated to the specified eObject. Returns false otherwise.

Expression Result
ePackage.isRepresentationDescriptionName('class diagram') True

isRepresentationName(representationName: java.lang.String) = boolean

Returns true if the arguments are not null, there's a representation with the specified name in the Sirius session. Returns false otherwise.

Expression Result
'MyEPackage class diagram'.isRepresentationName() True