atroposs-app-analysis-module v0.0.4
AtropossAppAnalysisModule
This library was generated with Angular CLI version 13.2.0.
Info
This component displays an iFrame. The component is build for angular.
Installation
Use npm install atroposs-app-analysis-module
to install the module.
Note: At the moment this module has to be installed with --force if you want to use it in older versions e.g. 13.0.3.
Usage
Parameters
The module asks for one url
and one title
passed as a parameters. The url
IS NEEDED, otherwise the module will do nothing! The title
is optional and has a standard declaration "iFrame Title".
The url can be set in two ways:
1. If it starts with http://
or https://
, then this url will be displayed in the iFrame.
2. If it starts with file=
, then the parameter url will be added to the CodeCharta url and CodeCharta will be displayed.
If you choose the second method you can set .json-file(s) as parameters, which will be displyed in the CodeCharta iFrame. Simply set the url-parameter to file=
and add your .json-files file=YourFile.json
. You can choose multiple files structured as follows: file=YourFirstFile.json&&YourSecondFile.json&&...
.
Usage in code
When the installation is done, the module needs to be imported in the app.module.ts as follows import { AtropossAppAnalysisModuleModule } from 'atroposs-app-analysis-module'
. After that you can use the module in your code:
<div style="position: relative; width: 500px; height: 500px"><atroposs-app-analysis-module url="YourURL" title="YourTitle"></atroposs-app-analysis-module></div>.
Note: The module is styled as
position: absolute; width: 100%; height: 100%;
. Thats why you need to wrapp it in a div withposition: relative
, so you can position the module on your website where you want it to be.
Code scaffolding
Run ng generate component component-name --project atroposs-app-analysis-module
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project atroposs-app-analysis-module
.
Note: Don't forget to add
--project atroposs-app-analysis-module
or else it will be added to the default project in yourangular.json
file.
Build
Run ng build atroposs-app-analysis-module
to build the project. The build artifacts will be stored in the dist/
directory.
Publishing
After building your library with ng build atroposs-app-analysis-module, go to the dist folder cd dist/atroposs-app-analysis-module
and run npm publish
.
Running unit tests
Run ng test atroposs-app-analysis-module to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
Built With
- Visual Studio
- Angular CLI
Versioning
We use SemVer for versioning.
Authors
- LersCode - Initial work
Keywords
Atroposs, Atroposs Module, Atroposs Library, atroposs. Angular, atroposs-aav-module, atroposs-aam-module