WIP: DOC/Figure.paragraph: Add a gallery example to show formating long text as paragraphs #4592
+42
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,42 @@ | ||||||
| """ | ||||||
| Paragraph | ||||||
| ========= | ||||||
|
|
||||||
| To plot longer text as one or several paragraphs the :meth:`pygmt.Figure.paragraph` | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| method can be used. The ``parwidth`` and ``linespacing`` parameters allow to set | ||||||
| the line length and spacing of the paragraph, respectively.` The desired text can | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| be provided using two ways to indicate a new paragraph: | ||||||
|
|
||||||
| (1) a single string separated by a blank line | ||||||
| (2) a list of strings | ||||||
|
|
||||||
| During plotting the paragraphs are automatically separated by a blank line. | ||||||
|
|
||||||
| For details on text formatting see the gallery example | ||||||
| :doc:`Text formatting </gallery/embellishments/text_formatting>`. | ||||||
| """ | ||||||
|
|
||||||
| # %% | ||||||
| import pygmt | ||||||
|
|
||||||
| fig = pygmt.Figure() | ||||||
| fig.basemap(region=[-5, 5, -5, 5], projection="X10c/10c", frame=True) | ||||||
|
|
||||||
| fig.paragraph( | ||||||
| x=0, | ||||||
| y=0, | ||||||
| text=[ | ||||||
| "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ", | ||||||
| "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", | ||||||
| ], | ||||||
| parwidth="4.5c", | ||||||
| linespacing="12p", | ||||||
| font="10p,Helvetica-Bold,steelblue", | ||||||
| angle=45, | ||||||
| justify="MC", | ||||||
| alignment="center", | ||||||
| fill="lightgray", # font color ignored | ||||||
| pen="1p,gray10", # font color ignored | ||||||
| ) | ||||||
|
|
||||||
| fig.show() | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.