matplotlib.github.com/1.2.1/api/dates_api.html at gh-pages · matplotlib/matplotlib.github.com

History

727 lines (668 loc) · 54.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>dates — Matplotlib 1.2.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.2.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.2.1 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.2.1). For the latest version see <a href="https://matplotlib.org/stable/api/dates_api.html">https://matplotlib.org/stable/api/dates_api.html</a></div>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="figure_api.html" title="figure"

accesskey="N">next</a> |</li>

<a href="colors_api.html" title="colors"

accesskey="P">previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="../citing.html">citation</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">dates</a><ul>

<li><a class="reference internal" href="#module-matplotlib.dates"><tt class="docutils literal">matplotlib.dates</tt></a><ul>

<li><a class="reference internal" href="#date-tickers">Date tickers</a></li>

<li><a class="reference internal" href="#date-formatters">Date formatters</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<a href="colors_api.html"

title="previous chapter">colors</a>

<h4>Next topic</h4>

<a href="figure_api.html"

title="next chapter">figure</a>

<li><a href="../_sources/api/dates_api.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

<h1>dates<a class="headerlink" href="#dates" title="Permalink to this headline">¶</a></h1>

</map>

<h2><a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><tt class="xref py py-mod docutils literal">matplotlib.dates</tt></a><a class="headerlink" href="#module-matplotlib.dates" title="Permalink to this headline">¶</a></h2>

Matplotlib provides sophisticated date plotting capabilities, standing

on the shoulders of python <tt class="xref py py-mod docutils literal">datetime</tt>, the add-on modules

<tt class="xref py py-mod docutils literal">pytz</tt> and <tt class="xref py py-mod docutils literal">dateutils</tt>. <tt class="xref py py-class docutils literal">datetime</tt> objects are

converted to floating point numbers which represent time in days

since 0001-01-01 UTC, plus 1. For example, 0001-01-01, 06:00 is

1.25, not 0.25. The helper functions <a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><tt class="xref py py-func docutils literal">date2num()</tt></a>,

<a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><tt class="xref py py-func docutils literal">num2date()</tt></a> and <a class="reference internal" href="#matplotlib.dates.drange" title="matplotlib.dates.drange"><tt class="xref py py-func docutils literal">drange()</tt></a> are used to facilitate easy

conversion to and from <tt class="xref py py-mod docutils literal">datetime</tt> and numeric ranges.

Note

Like Python’s datetime, mpl uses the Gregorian calendar for

all conversions between dates and floating point numbers.

This practice is not universal, and calendar differences can

cause confusing differences between what Python and mpl

give as the number of days since 0001-01-01 and what other

software and databases yield. For example, the

<a class="reference external" href="http://www.usno.navy.mil/USNO/astronomical-applications/data-services/jul-date">US Naval Observatory</a>

uses a calendar that switches from Julian to Gregorian in

October, 1582. Hence, using their calculator, the number of

days between 0001-01-01 and 2006-04-01 is 732403, whereas using

the Gregorian calendar via the datetime module we find:

<div class="last highlight-python"><pre>In [31]:date(2006,4,1).toordinal() - date(1,1,1).toordinal()

Out[31]:732401</pre>

</div>

A wide range of specific and general purpose date tick locators and

formatters are provided in this module. See

<a class="reference internal" href="ticker_api.html#module-matplotlib.ticker" title="matplotlib.ticker"><tt class="xref py py-mod docutils literal">matplotlib.ticker</tt></a> for general information on tick locators

and formatters. These are described below.

All the matplotlib date converters, tickers and formatters are

timezone aware, and the default timezone is given by the timezone

parameter in your <tt class="file docutils literal">matplotlibrc</tt> file. If you leave out a

<tt class="xref py py-class docutils literal">tz</tt> timezone instance, the default from your rc file will be

assumed. If you want to use a custom time zone, pass a

<tt class="xref py py-class docutils literal">pytz.timezone</tt> instance with the tz keyword argument to

<a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><tt class="xref py py-func docutils literal">num2date()</tt></a>, <tt class="xref py py-func docutils literal">plot_date()</tt>, and any custom date tickers or

locators you create. See <a class="reference external" href="http://pytz.sourceforge.net">pytz</a> for

information on <tt class="xref py py-mod docutils literal">pytz</tt> and timezone handling.

The <a class="reference external" href="http://labix.org/python-dateutil">dateutil module</a> provides

additional code to handle date ticking, making it easy to place ticks

on any kinds of dates. See examples below.

<h3>Date tickers<a class="headerlink" href="#date-tickers" title="Permalink to this headline">¶</a></h3>

Most of the date tickers can locate single or multiple values. For

example:

<div class="highlight-python"><div class="highlight"><pre># tick on mondays every week

loc = WeekdayLocator(byweekday=MO, tz=tz)

# tick on mondays and saturdays

loc = WeekdayLocator(byweekday=(MO, SA))

</pre></div>

</div>

In addition, most of the constructors take an interval argument:

<div class="highlight-python"><div class="highlight"><pre># tick on mondays every second week

loc = WeekdayLocator(byweekday=MO, interval=2)

</pre></div>

</div>

The rrule locator allows completely general date ticking:

<div class="highlight-python"><div class="highlight"><pre># tick every 5th easter

rule = rrulewrapper(YEARLY, byeaster=1, interval=5)

loc = RRuleLocator(rule)

</pre></div>

</div>

Here are all the date tickers:

<li><a class="reference internal" href="#matplotlib.dates.MinuteLocator" title="matplotlib.dates.MinuteLocator"><tt class="xref py py-class docutils literal">MinuteLocator</tt></a>: locate minutes</li>

<li><a class="reference internal" href="#matplotlib.dates.HourLocator" title="matplotlib.dates.HourLocator"><tt class="xref py py-class docutils literal">HourLocator</tt></a>: locate hours</li>

<li><a class="reference internal" href="#matplotlib.dates.DayLocator" title="matplotlib.dates.DayLocator"><tt class="xref py py-class docutils literal">DayLocator</tt></a>: locate specifed days of the month</li>

<li><a class="reference internal" href="#matplotlib.dates.WeekdayLocator" title="matplotlib.dates.WeekdayLocator"><tt class="xref py py-class docutils literal">WeekdayLocator</tt></a>: Locate days of the week, eg MO, TU</li>

<li><a class="reference internal" href="#matplotlib.dates.MonthLocator" title="matplotlib.dates.MonthLocator"><tt class="xref py py-class docutils literal">MonthLocator</tt></a>: locate months, eg 7 for july</li>

<li><a class="reference internal" href="#matplotlib.dates.YearLocator" title="matplotlib.dates.YearLocator"><tt class="xref py py-class docutils literal">YearLocator</tt></a>: locate years that are multiples of base</li>

<li><a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><tt class="xref py py-class docutils literal">RRuleLocator</tt></a>: locate using a

<tt class="xref py py-class docutils literal">matplotlib.dates.rrulewrapper</tt>. The

<tt class="xref py py-class docutils literal">rrulewrapper</tt> is a simple wrapper around a

<tt class="xref py py-class docutils literal">dateutils.rrule</tt> (<a class="reference external" href="http://labix.org/python-dateutil">dateutil</a>) which allow almost

arbitrary date tick specifications. See <a class="reference external" href="../examples/pylab_examples/date_demo_rrule.html">rrule example</a>.</li>

<li><a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><tt class="xref py py-class docutils literal">AutoDateLocator</tt></a>: On autoscale, this class picks the best

<tt class="xref py py-class docutils literal">MultipleDateLocator</tt> to set the view limits and the tick

locations.</li>

</ul>

</div></blockquote>

</div>

<h3>Date formatters<a class="headerlink" href="#date-formatters" title="Permalink to this headline">¶</a></h3>

Here all all the date formatters:

<li><a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><tt class="xref py py-class docutils literal">AutoDateFormatter</tt></a>: attempts to figure out the best format

to use. This is most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><tt class="xref py py-class docutils literal">AutoDateLocator</tt></a>.</li>

<li><a class="reference internal" href="#matplotlib.dates.DateFormatter" title="matplotlib.dates.DateFormatter"><tt class="xref py py-class docutils literal">DateFormatter</tt></a>: use <tt class="xref py py-func docutils literal">strftime()</tt> format strings</li>

<li><a class="reference internal" href="#matplotlib.dates.IndexDateFormatter" title="matplotlib.dates.IndexDateFormatter"><tt class="xref py py-class docutils literal">IndexDateFormatter</tt></a>: date plots with implicit x

indexing.</li>

</ul>

</div></blockquote>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">date2num</tt><big>(</big>d<big>)</big><a class="headerlink" href="#matplotlib.dates.date2num" title="Permalink to this definition">¶</a></dt>

<dd>d is either a <tt class="xref py py-class docutils literal">datetime</tt> instance or a sequence of datetimes.

Return value is a floating point number (or sequence of floats)

which gives the number of days (fraction part represents hours,

minutes, seconds) since 0001-01-01 00:00:00 UTC, plus one.

The addition of one here is a historical artifact. Also, note

that the Gregorian calendar is assumed; this is not universal

practice. For details, see the module docstring.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">num2date</tt><big>(</big>x, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.num2date" title="Permalink to this definition">¶</a></dt>

<dd>x is a float value which gives the number of days

(fraction part represents hours, minutes, seconds) since

0001-01-01 00:00:00 UTC plus one.

The addition of one here is a historical artifact. Also, note

that the Gregorian calendar is assumed; this is not universal

practice. For details, see the module docstring.

Return value is a <tt class="xref py py-class docutils literal">datetime</tt> instance in timezone tz (default to

rcparams TZ value).

If x is a sequence, a sequence of <tt class="xref py py-class docutils literal">datetime</tt> objects will

be returned.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">drange</tt><big>(</big>dstart, dend, delta<big>)</big><a class="headerlink" href="#matplotlib.dates.drange" title="Permalink to this definition">¶</a></dt>

<dd>Return a date range as float Gregorian ordinals. dstart and

dend are <tt class="xref py py-class docutils literal">datetime</tt> instances. delta is a

<tt class="xref py py-class docutils literal">datetime.timedelta</tt> instance.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">epoch2num</tt><big>(</big>e<big>)</big><a class="headerlink" href="#matplotlib.dates.epoch2num" title="Permalink to this definition">¶</a></dt>

<dd>Convert an epoch or sequence of epochs to the new date format,

that is days since 0001.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">num2epoch</tt><big>(</big>d<big>)</big><a class="headerlink" href="#matplotlib.dates.num2epoch" title="Permalink to this definition">¶</a></dt>

<dd>Convert days since 0001 to epoch. d can be a number or sequence.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">mx2num</tt><big>(</big>mxdates<big>)</big><a class="headerlink" href="#matplotlib.dates.mx2num" title="Permalink to this definition">¶</a></dt>

<dd>Convert mx <tt class="xref py py-class docutils literal">datetime</tt> instance (or sequence of mx

instances) to the new date format.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">DateFormatter</tt><big>(</big>fmt, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.DateFormatter" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><tt class="xref py py-class docutils literal">matplotlib.ticker.Formatter</tt></a>

Tick location is seconds since the epoch. Use a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><tt class="xref py py-func docutils literal">strftime()</tt></a>

format string.

Python only supports <tt class="xref py py-mod docutils literal">datetime</tt> <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><tt class="xref py py-func docutils literal">strftime()</tt></a> formatting

for years greater than 1900. Thanks to Andrew Dalke, Dalke

Scientific Software who contributed the <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><tt class="xref py py-func docutils literal">strftime()</tt></a> code

below to include dates earlier than this year.

<dt>fmt is an <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><tt class="xref py py-func docutils literal">strftime()</tt></a> format string; tz is the</dt>

<dd><tt class="xref py py-class docutils literal">tzinfo</tt> instance.</dd>

</dl>

<tt class="descname">illegal_s</tt> = <_sre.SRE_Pattern object at 0x2904fa0><a class="headerlink" href="#matplotlib.dates.DateFormatter.illegal_s" title="Permalink to this definition">¶</a></dt>

<tt class="descname">set_tzinfo</tt><big>(</big>tz<big>)</big><a class="headerlink" href="#matplotlib.dates.DateFormatter.set_tzinfo" title="Permalink to this definition">¶</a></dt>

<tt class="descname">strftime</tt><big>(</big>dt, fmt<big>)</big><a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">IndexDateFormatter</tt><big>(</big>t, fmt, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.IndexDateFormatter" title="Permalink to this definition">¶</a></dt>

Use with <a class="reference internal" href="ticker_api.html#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><tt class="xref py py-class docutils literal">IndexLocator</tt></a> to cycle format

strings by index.

t is a sequence of dates (floating point days). fmt is a

<tt class="xref py py-func docutils literal">strftime()</tt> format string.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">AutoDateFormatter</tt><big>(</big>locator, tz=None, defaultfmt='%Y-%m-%d'<big>)</big><a class="headerlink" href="#matplotlib.dates.AutoDateFormatter" title="Permalink to this definition">¶</a></dt>

This class attempts to figure out the best format to use. This is

most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><tt class="xref py py-class docutils literal">AutoDateLocator</tt></a>.

The AutoDateFormatter has a scale dictionary that maps the scale

of the tick (the distance in days between one major tick) and a

format string. The default looks like this:

<div class="highlight-python"><div class="highlight"><pre>self.scaled = {

365.0 : '%Y',

30. : '%b %Y',

1.0 : '%b %d %Y',

1./24. : '%H:%M:%D',

}

</pre></div>

</div>

The algorithm picks the key in the dictionary that is >= the

current scale and uses that format string. You can customize this

dictionary by doing:

<div class="highlight-python"><div class="highlight"><pre>formatter = AutoDateFormatter()

formatter.scaled[1/(24.*60.)] = '%M:%S' # only show min and sec

</pre></div>

</div>

Autofmt the date labels. The default format is the one to use

if none of the times in scaled match

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">DateLocator</tt><big>(</big>tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.DateLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><tt class="xref py py-class docutils literal">matplotlib.ticker.Locator</tt></a>

tz is a <tt class="xref py py-class docutils literal">tzinfo</tt> instance.

<tt class="descname">datalim_to_dt</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.DateLocator.datalim_to_dt" title="Permalink to this definition">¶</a></dt>

<tt class="descname">hms0d</tt> = {'byminute': 0, 'byhour': 0, 'bysecond': 0}<a class="headerlink" href="#matplotlib.dates.DateLocator.hms0d" title="Permalink to this definition">¶</a></dt>

<tt class="descname">nonsingular</tt><big>(</big>vmin, vmax<big>)</big><a class="headerlink" href="#matplotlib.dates.DateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>

<tt class="descname">set_tzinfo</tt><big>(</big>tz<big>)</big><a class="headerlink" href="#matplotlib.dates.DateLocator.set_tzinfo" title="Permalink to this definition">¶</a></dt>

<tt class="descname">viewlim_to_dt</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.DateLocator.viewlim_to_dt" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">RRuleLocator</tt><big>(</big>o, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.RRuleLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><tt class="xref py py-class docutils literal">matplotlib.dates.DateLocator</tt></a>

<tt class="descname">autoscale</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.RRuleLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Set the view limits to include the data range.

</dd></dl>

static <tt class="descname">get_unit_generic</tt><big>(</big>freq<big>)</big><a class="headerlink" href="#matplotlib.dates.RRuleLocator.get_unit_generic" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">AutoDateLocator</tt><big>(</big>tz=None, minticks=5, maxticks=None, interval_multiples=False<big>)</big><a class="headerlink" href="#matplotlib.dates.AutoDateLocator" title="Permalink to this definition">¶</a></dt>

On autoscale, this class picks the best

<tt class="xref py py-class docutils literal">MultipleDateLocator</tt> to set the view limits and the tick

locations.

minticks is the minimum number of ticks desired, which is used to

select the type of ticking (yearly, monthly, etc.).

maxticks is the maximum number of ticks desired, which controls

any interval between ticks (ticking every other, every 3, etc.).

For really fine-grained control, this can be a dictionary mapping

individual rrule frequency constants (YEARLY, MONTHLY, etc.)

to their own maximum number of ticks. This can be used to keep

the number of ticks appropriate to the format chosen in

class:<a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><tt class="xref py py-obj docutils literal">AutoDateFormatter</tt></a>. Any frequency not specified in this

dictionary is given a default value.

tz is a <tt class="xref py py-class docutils literal">tzinfo</tt> instance.

interval_multiples is a boolean that indicates whether ticks

should be chosen to be multiple of the interval. This will lock

ticks to ‘nicer’ locations. For example, this will force the

ticks to be at hours 0,6,12,18 when hourly ticking is done at

6 hour intervals.

The AutoDateLocator has an interval dictionary that maps the

frequency of the tick (a constant from dateutil.rrule) and a

multiple allowed for that ticking. The default looks like this:

<div class="highlight-python"><div class="highlight"><pre>self.intervald = {

YEARLY : [1, 2, 4, 5, 10],

MONTHLY : [1, 2, 3, 4, 6],

DAILY : [1, 2, 3, 7, 14],

HOURLY : [1, 2, 3, 4, 6, 12],

MINUTELY: [1, 5, 10, 15, 30],

SECONDLY: [1, 5, 10, 15, 30]

}

</pre></div>

</div>

The interval is used to specify multiples that are appropriate for

the frequency of ticking. For instance, every 7 days is sensible

for daily ticks, but for minutes/seconds, 15 or 30 make sense.

You can customize this dictionary by doing:

<div class="highlight-python"><div class="highlight"><pre>locator = AutoDateLocator()

locator.intervald[HOURLY] = [3] # only show every 3 hours

</pre></div>

</div>

<tt class="descname">autoscale</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Try to choose the view limits intelligently.

</dd></dl>

<tt class="descname">get_locator</tt><big>(</big>dmin, dmax<big>)</big><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.get_locator" title="Permalink to this definition">¶</a></dt>

<dd>Pick the best locator based on a distance.

</dd></dl>

<tt class="descname">refresh</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.refresh" title="Permalink to this definition">¶</a></dt>

<dd>Refresh internal information based on current limits.

</dd></dl>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">YearLocator</tt><big>(</big>base=1, month=1, day=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.YearLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on a given day of each year that is a multiple of base.

Examples:

<div class="highlight-python"><div class="highlight"><pre># Tick every year on Jan 1st

locator = YearLocator()

# Tick every 5 years on July 4th

locator = YearLocator(5, month=7, day=4)

</pre></div>

</div>

Mark years that are multiple of base on a given month and day

(default jan 1).

<tt class="descname">autoscale</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.dates.YearLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Set the view limits to include the data range.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">MonthLocator</tt><big>(</big>bymonth=None, bymonthday=1, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.MonthLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><tt class="xref py py-class docutils literal">matplotlib.dates.RRuleLocator</tt></a>

Make ticks on occurances of each month month, eg 1, 3, 12.

Mark every month in bymonth; bymonth can be an int or

sequence. Default is <tt class="docutils literal">range(1,13)</tt>, i.e. every month.

interval is the interval between each iteration. For

example, if <tt class="docutils literal">interval=2</tt>, mark every second occurance.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">WeekdayLocator</tt><big>(</big>byweekday=1, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.WeekdayLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each weekday.

Mark every weekday in byweekday; byweekday can be a number or

sequence.

Elements of byweekday must be one of MO, TU, WE, TH, FR, SA,

SU, the constants from <tt class="xref py py-mod docutils literal">dateutils.rrule</tt>.

interval specifies the number of weeks to skip. For example,

<tt class="docutils literal">interval=2</tt> plots every second week.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">DayLocator</tt><big>(</big>bymonthday=None, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.DayLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each day of the month. For example,

1, 15, 30.

Mark every day in bymonthday; bymonthday can be an int or

sequence.

Default is to tick every day of the month: <tt class="docutils literal">bymonthday=range(1,32)</tt>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">HourLocator</tt><big>(</big>byhour=None, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.HourLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each hour.

Mark every hour in byhour; byhour can be an int or sequence.

Default is to tick every hour: <tt class="docutils literal">byhour=range(24)</tt>

interval is the interval between each iteration. For

example, if <tt class="docutils literal">interval=2</tt>, mark every second occurrence.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">MinuteLocator</tt><big>(</big>byminute=None, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.MinuteLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each minute.

Mark every minute in byminute; byminute can be an int or

sequence. Default is to tick every minute: <tt class="docutils literal">byminute=range(60)</tt>

interval is the interval between each iteration. For

example, if <tt class="docutils literal">interval=2</tt>, mark every second occurrence.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">SecondLocator</tt><big>(</big>bysecond=None, interval=1, tz=None<big>)</big><a class="headerlink" href="#matplotlib.dates.SecondLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each second.

Mark every second in bysecond; bysecond can be an int or

sequence. Default is to tick every second: <tt class="docutils literal">bysecond = range(60)</tt>

interval is the interval between each iteration. For

example, if <tt class="docutils literal">interval=2</tt>, mark every second occurrence.

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">rrule</tt><big>(</big>freq, dtstart=None, interval=1, wkst=None, count=None, until=None, bysetpos=None, bymonth=None, bymonthday=None, byyearday=None, byeaster=None, byweekno=None, byweekday=None, byhour=None, byminute=None, bysecond=None, cache=False<big>)</big><a class="headerlink" href="#matplotlib.dates.rrule" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">dateutil.rrule.rrulebase</tt>

</dd></dl>

class <tt class="descclassname">matplotlib.dates.</tt><tt class="descname">relativedelta</tt><big>(</big>dt1=None, dt2=None, years=0, months=0, days=0, leapdays=0, weeks=0, hours=0, minutes=0, seconds=0, microseconds=0, year=None, month=None, day=None, weekday=None, yearday=None, nlyearday=None, hour=None, minute=None, second=None, microsecond=None<big>)</big><a class="headerlink" href="#matplotlib.dates.relativedelta" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

The relativedelta type is based on the specification of the excelent

work done by M.-A. Lemburg in his mx.DateTime extension. However,

notice that this type does NOT implement the same algorithm as

his work. Do NOT expect it to behave like mx.DateTime’s counterpart.

There’s two different ways to build a relativedelta instance. The

first one is passing it two date/datetime classes:

<div>relativedelta(datetime1, datetime2)</div></blockquote>

And the other way is to use the following keyword arguments:

<dt>year, month, day, hour, minute, second, microsecond:</dt>

<dd>Absolute information.</dd>

<dt>years, months, weeks, days, hours, minutes, seconds, microseconds:</dt>

<dd>Relative information, may be negative.</dd>

<dt>weekday:</dt>

<dd>One of the weekday instances (MO, TU, etc). These instances may

receive a parameter N, specifying the Nth weekday, which could

be positive or negative (like MO(+1) or MO(-2). Not specifying

it is the same as specifying +1. You can also use an integer,

where 0=MO.</dd>

<dt>leapdays:</dt>

<dd>Will add given days to the date found, if year is a leap

year, and the date found is post 28 of february.</dd>

<dt>yearday, nlyearday:</dt>

<dd>Set the yearday or the non-leap year day (jump leap days).

These are converted to day/month/leapdays information.</dd>

</dl>

</div></blockquote>

Here is the behavior of operations with relativedelta:

<li>Calculate the absolute year, using the ‘year’ argument, or the

original datetime year, if the argument is not present.</li>

<li>Add the relative ‘years’ argument to the absolute year.</li>

<li>Do steps 1 and 2 for month/months.</li>

<li>Calculate the absolute day, using the ‘day’ argument, or the

original datetime day, if the argument is not present. Then,

subtract from the day until it fits in the year and month

found after their operations.</li>

<li>Add the relative ‘days’ argument to the absolute day. Notice

that the ‘weeks’ argument is multiplied by 7 and added to

‘days’.</li>

<li>Do steps 1 and 2 for hour/hours, minute/minutes, second/seconds,

microsecond/microseconds.</li>

<li>If the ‘weekday’ argument is present, calculate the weekday,

with the given (wday, nth) tuple. wday is the index of the

weekday (0-6, 0=Mon), and nth is the number of weeks to add

forward or backward, depending on its signal. Notice that if

the calculated date is already Monday, for example, using

(0, 1) or (0, -1) won’t change the day.</li>

</ol>

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">seconds</tt><big>(</big>s<big>)</big><a class="headerlink" href="#matplotlib.dates.seconds" title="Permalink to this definition">¶</a></dt>

<dd>Return seconds as days.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">minutes</tt><big>(</big>m<big>)</big><a class="headerlink" href="#matplotlib.dates.minutes" title="Permalink to this definition">¶</a></dt>

<dd>Return minutes as days.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">hours</tt><big>(</big>h<big>)</big><a class="headerlink" href="#matplotlib.dates.hours" title="Permalink to this definition">¶</a></dt>

<dd>Return hours as days.

</dd></dl>

<tt class="descclassname">matplotlib.dates.</tt><tt class="descname">weeks</tt><big>(</big>w<big>)</big><a class="headerlink" href="#matplotlib.dates.weeks" title="Permalink to this definition">¶</a></dt>

<dd>Return weeks as days.

</dd></dl>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

>index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="figure_api.html" title="figure"

>next</a> |</li>

<a href="colors_api.html" title="colors"

>previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="../citing.html">citation</a>| </li>

<li><a href="index.html" >The Matplotlib API</a> »</li>

</ul>

</div>

Last updated on May 29, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

dates_api.html

Latest commit

History

dates_api.html

File metadata and controls